DocumentationAPI Reference
API v1 · Stable

API Reference

Pilotez vos relais RTMP, le chat, les objectifs cadeaux et la modération avec une API conçue pour le direct.

BASE URLhttps://api.orya.live/v1
PREMIERS PAS

Authentification

L’API Orya utilise des clés secrètes pour authentifier les requêtes. Ajoutez votre clé dans l’en-tête Authorization de chaque appel.

Gardez votre clé secrète

Ne l’exposez jamais dans du code client ou dans un dépôt public.

Authorization
Authorization: Bearer orya_live_xxxxxxxxxxxx
GET/streams

Lister les streams

Retourne vos relais RTMP avec leur destination, leur état et les métriques de transport actuelles.

ParamètreTypeDescription
statusstring

Filtre par état : ready, live ou offline.

limitinteger

Nombre de résultats, de 1 à 100. Par défaut : 20.

POST/streams

Créer un relais RTMP

Crée un stream et retourne le serveur ainsi que la clé RTMP à renseigner dans OBS.

Corps de la requête

destinationenumrequis

La plateforme de destination. Pour le MVP : tiktok.

titlestringoptionnel

Le nom interne du live affiché dans la régie Orya.

regionenumoptionnel

La région d’ingestion la plus proche du créateur.

metadataobjectoptionnel

Données personnalisées associées au stream.

cURL
curl --request POST \
  --url https://api.orya.live/v1/streams \
  --header 'Authorization: Bearer orya_live_xxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "destination": "tiktok",
    "title": "Mon live du soir",
    "region": "eu-west"
  }'
201 · application/json
{
  "id": "str_8K4mP2qL",
  "status": "ready",
  "ingest": {
    "protocol": "rtmp",
    "server": "rtmp://ingest.orya.live/live",
    "stream_key": "orya_live_xxxxxxxxxxxx"
  },
  "destination": "tiktok",
  "created_at": "2026-09-19T16:24:00Z"
}
WSS/streams/{stream_id}/events

Écouter le live et le chat

Ouvrez une connexion WebSocket pour recevoir l’état du flux et les interactions TikTok avec une latence minimale.

stream.health_changed

Le débit, la latence ou les images perdues évoluent.

chat.message

Un nouveau message est publié dans le chat.

gift.received

Un cadeau TikTok est reçu pendant le live.

POST/streams/{stream_id}/gift-goals

Créer un objectif cadeaux

Définissez un objectif en diamants, affichez sa progression dans la régie et recevez une notification lorsqu’il est atteint.

POST/streams/{stream_id}/moderation/actions

Modérer un utilisateur

Appliquez une action mute, block ou ajoutez un utilisateur à la liste des modérateurs.

POSTVotre endpoint webhook

Webhooks

Recevez les événements importants de manière fiable, même lorsque votre application n’est pas connectée au flux WebSocket.

Payload exemple
{
  "type": "chat.message",
  "created_at": 1789835040,
  "data": {
    "stream_id": "str_8K4mP2qL",
    "user": "@lina",
    "message": "Le stream est super fluide !"
  }
}
RÉPONSES

Codes d’erreur

Les erreurs utilisent les codes HTTP standards et incluent toujours un identifiant traçable dans le corps de la réponse.

400

Bad RequestParamètres invalides ou manquants.

401

UnauthorizedClé API absente ou invalide.

429

Rate LimitedTrop de requêtes sur la période.

SDKs officiels

Intégrez Orya avec nos clients typés pour TypeScript, Python et Go.

Voir les SDKs

Changelog

Suivez les nouvelles ressources, événements et évolutions de l’API.

Voir les versions
ÉTAPE SUIVANTECréer votre premier relais RTMP