Integración API

Su primera transcripción

La transcripción se realiza en segundo plano. Al crear un trabajo, la respuesta es inmediata; consulte su estado hasta que el resultado esté listo.

1. 1

   Crear un trabajo

   Envíe POST /transcripts con una URL multimedia directa y pública. Guarde el id devuelto.

2. 2

   Consultar el progreso

   Consulte GET /transcripts/{id} cada 15–30 segundos hasta que status sea complete o error.

3. 3

   Usar la transcripción

   Lea el JSON de data o descargue el archivo de export_url si solicita SRT o VTT.

Estado del trabajo

Considere cualquier otro estado como «en curso». Pueden añadirse nuevos estados intermedios.

Autenticación

Envíe su clave API en la cabecera Authorization de cada solicitud, exactamente como se mostró al crearla.

Authorization: <your api key>

No añada el prefijo Bearer.

Las claves nuevas empiezan por tp_live_. La clave completa solo se muestra una vez, al crearla. Si la pierde, revóquela y cree una nueva; una clave revocada deja de funcionar de inmediato.

Se requiere una suscripción activa y una clave de API con los permisos necesarios.

Crear una transcripción

Inicie un trabajo de transcripción para un archivo multimedia en una URL pública. La respuesta se devuelve cuando el trabajo entra en la cola, con status: "initializing".

Taption descarga el archivo directamente. Los enlaces a páginas compartidas, como una vista previa de Google Drive o Dropbox, no funcionan.

media_urlstringobligatorio

Enlace de descarga directa del archivo multimedia.

Máximo 2048 caracteres

extensionstringobligatorio

Formato del archivo multimedia.

mp3wavm4aaacflacwmaopusmp4

languagestringobligatorio

Idioma hablado en el archivo, como etiqueta de idioma. Consulte la referencia de idiomas.

Ver etiquetas de idioma

namestring

Nombre de la transcripción. De forma predeterminada se usa el nombre del archivo de `media_url`. Los nombres más largos se recortan a 200 caracteres.

Máximo 200 caracteres

export_typestring

Formato de salida. El valor predeterminado es json, que devuelve el contenido de la transcripción analizado en data. srt y vtt devuelven un enlace al archivo en export_url.

jsonsrtvtt

Predeterminado: json

max_charinteger

Máximo de caracteres por segmento de subtítulo. El valor predeterminado es `16` para chino, japonés, coreano y cantonés, y `65` para otros idiomas. Los valores fuera de 1–200 se ignoran y se usa el predeterminado.

1–200

Respuestas

Obtener una transcripción

Obtenga el estado actual y el resultado de una transcripción. Consulte cada 15–30 segundos mientras el trabajo esté en curso.

Con json o sin especificar el tipo de exportación, el resultado final aparece en data. Con srt o vtt, descargue el archivo de export_url.

idstringobligatorio

El ID de transcripción devuelto por POST /transcripts.Máximo 256 caracteres

Respuestas

El objeto de transcripción

Las solicitudes de creación y consulta de estado devuelven un objeto JSON. Sus campos describen el trabajo y, cuando está listo, su resultado.

idstring

El ID de transcripción. Úselo con `GET /transcripts/{id}`.

statusstring

Estado del trabajo: `initializing`, `transcribing`, `complete` o `error`. Considere cualquier otro valor como «en curso».

dataJSON

Exportación JSON analizada cuando está lista, para json o si se omite export_type; en caso contrario, una cadena vacía.

export_urlstring

Enlace de descarga para una exportación srt o vtt. Vacío hasta que esté lista. Se omite en las respuestas de estado para json o si se omite export_type.

messagestring

Detalles adicionales del estado actual. Durante `transcribing`, puede indicar una fase como `ANALYZING` o `FINALIZING`. Cuando `status` es `error`, describe el fallo. Está dirigido a personas; no lo analice mediante código.

error_codestring

Código opcional legible por máquina para un error de límite de envío.

limitinteger

Límite aplicable a la cuenta, incluido en las respuestas HTTP 429.

Errores y reintentos

Use el código de estado HTTP para decidir el siguiente paso. El campo message está dirigido a personas; su redacción puede cambiar.

Las respuestas de la API incluyen la cabecera X-Request-Id. Inclúyala cuando contacte con soporte sobre una solicitud.