Intégration API

Votre première transcription

La transcription s’effectue en arrière-plan. La création d’une tâche renvoie une réponse immédiate ; consultez son état jusqu’à ce que le résultat soit prêt.

1. 1

   Créer une tâche

   Envoyez POST /transcripts avec une URL de média directe et publique. Conservez l’id renvoyé.

2. 2

   Suivre la progression

   Interrogez GET /transcripts/{id} toutes les 15 à 30 secondes jusqu’à ce que status soit complete ou error.

3. 3

   Utiliser votre transcription

   Lisez le JSON dans data ou téléchargez le fichier via export_url si vous demandez du SRT ou du VTT.

État de la tâche

Considérez tout autre état comme « en cours ». De nouveaux états intermédiaires peuvent être ajoutés.

Authentification

Envoyez votre clé API dans l’en-tête Authorization de chaque requête, exactement telle qu’elle s’est affichée lors de sa création.

Authorization: <your api key>

N’ajoutez pas le préfixe Bearer.

Les nouvelles clés commencent par tp_live_. La clé complète n’est affichée qu’une seule fois, lors de sa création. Si vous la perdez, révoquez-la et créez-en une nouvelle ; une clé révoquée cesse immédiatement de fonctionner.

Un abonnement actif et une clé API avec les autorisations requises sont nécessaires.

Créer une transcription

Lancez une tâche de transcription pour un fichier média accessible via une URL publique. La réponse est renvoyée dès sa mise en file d’attente, avec status: "initializing".

Taption télécharge le fichier directement. Les liens vers des pages de partage, comme un aperçu Google Drive ou Dropbox, ne fonctionnent pas.

media_urlstringobligatoire

Lien de téléchargement direct de votre fichier média.

2048 caractères maximum

extensionstringobligatoire

Le format du fichier média.

mp3wavm4aaacflacwmaopusmp4

languagestringobligatoire

Langue parlée dans le média, sous forme de balise de langue. Consultez la référence des langues.

Voir les balises de langue

namestring

Nom affiché pour la transcription. Par défaut, le nom de fichier dans `media_url` est utilisé. Les noms plus longs sont tronqués à 200 caractères.

200 caractères maximum

export_typestring

Format de sortie. La valeur par défaut est json, qui renvoie le contenu de la transcription analysé dans data. srt et vtt renvoient un lien de fichier dans export_url.

jsonsrtvtt

Par défaut : json

max_charinteger

Nombre maximal de caractères par segment de sous-titre. La valeur par défaut est `16` pour le chinois, le japonais, le coréen et le cantonais, et `65` pour les autres langues. Les valeurs hors de 1–200 sont ignorées au profit de la valeur par défaut.

1–200

Réponses

Récupérer une transcription

Récupérez l’état actuel et le résultat d’une transcription. Interrogez toutes les 15 à 30 secondes tant que la tâche est en cours.

Avec json ou sans type d’export spécifié, le résultat final apparaît dans data. Avec srt ou vtt, téléchargez le fichier via export_url.

idstringobligatoire

L’ID de transcription renvoyé par POST /transcripts.256 caractères maximum

Réponses

L’objet transcription

Les requêtes de création et de consultation de l’état renvoient un objet JSON. Ses champs décrivent la tâche et, lorsqu’il est prêt, son résultat.

idstring

L’ID de transcription. Utilisez-le avec `GET /transcripts/{id}`.

statusstring

État de la tâche : `initializing`, `transcribing`, `complete` ou `error`. Considérez toute autre valeur comme « en cours ».

dataJSON

Export JSON analysé une fois prêt pour json ou si export_type est omis ; sinon, une chaîne vide.

export_urlstring

Lien de téléchargement d’un export srt ou vtt. Vide tant que le résultat n’est pas prêt. Absent des réponses d’état pour json ou si export_type est omis.

messagestring

Détails supplémentaires sur l’état actuel. Pendant `transcribing`, il peut s’agir d’une étape comme `ANALYZING` ou `FINALIZING`. Lorsque `status` est `error`, ce champ décrit l’échec. Destiné à être lu par des personnes ; ne l’analysez pas par programme.

error_codestring

Code facultatif lisible par machine indiquant une limite de soumission.

limitinteger

Limite applicable au compte, incluse dans les réponses HTTP 429.

Erreurs et nouvelles tentatives

Utilisez le code d’état HTTP pour décider de la suite. Le champ message est destiné à être lu par des personnes ; sa formulation peut changer.

Les réponses de l’API contiennent un en-tête X-Request-Id. Indiquez-le lorsque vous contactez le support au sujet d’une requête.