> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Transcribir un vídeo de YouTube
> Recupera o genera una transcripción de YouTube con segmentos temporizados, texto sin formato y subtítulos SRT. Guarda el historial de transcripciones. Devuelve una referencia compacta al resultado guardado; usa su getAction o downloadAction para recuperar la salida completa.
Recupera o genera una transcripción de YouTube con segmentos temporizados, texto sin formato y subtítulos SRT. Guarda el historial de transcripciones. Devuelve una referencia compacta al resultado guardado; usa su getAction o downloadAction para recuperar la salida completa.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/youtube_transcript_create
```
## Autenticación y permisos
Envía una clave de API de VoiceCheap en esta cabecera. También se admite Authorization: Bearer con la misma clave de API. Los tokens de acceso OAuth
solo se aceptan en MCP, no en este endpoint REST.
Permisos necesarios: `transcription:write`.
Se requiere una suscripción de pago activa. Los permisos no cambian los roles del equipo, la propiedad de los recursos, los créditos multimedia ni los límites del plan.
## Parámetros
Valor de texto.
Longitud máxima: 2048. Formato: "uri".
Opcional en la capa de transporte: el servidor introduce un identificador antes de la validación si se omite. Proporciona tu propio UUID v4 estable para recuperar la solicitud de forma segura si se pierde la respuesta.
Formato: "uuid". Patrón: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`.
El JSON Schema siguiente conserva los nombres exactos de los campos, los tipos anidados, los valores predeterminados, los límites y los valores aceptados que expone el descubrimiento. Las reglas adicionales entre campos se indican en las notas de la operación.
```json theme={null}
{
"type": "object",
"properties": {
"youtubeUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"requestId": {
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
"type": "string",
"format": "uuid",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"required": ["youtubeUrl"],
"additionalProperties": false
}
```
## Idempotencia
Usa un UUID v4 en requestId o en la cabecera HTTP Idempotency-Key para cada modificación. Reutiliza el mismo identificador y argumentos idénticos después de un fallo de red. Si proporcionas ambos, deben coincidir. Repetir una solicitud guardada no vuelve a ejecutar la operación ni consume otra llamada mensual. Las solicitudes fallidas o interrumpidas no se reinician automáticamente.
Toda modificación puede devolver HTTP 202 cuando un reintento encuentra la misma solicitud todavía en ejecución, incluso si su primera ejecución suele ser síncrona. Si la ejecución ha terminado pero resultStored es false, un reintento devuelve HTTP 200 con el estado de la solicitud guardada en lugar del resultado original. Recupera la salida mediante la acción de historial, resultado o descarga de su ámbito.
## Ejemplos de solicitud
Sustituye los identificadores de recursos y las claves multimedia de los ejemplos por valores devueltos para tu cuenta. Mantén el identificador de solicitud al reintentar la misma modificación.
```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/youtube_transcript_create' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"youtubeUrl":"https://www.youtube.com/watch?v=abcdefghijk","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
```
```javascript JavaScript theme={null}
const input = {
youtubeUrl: 'https://www.youtube.com/watch?v=abcdefghijk',
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/youtube_transcript_create', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
```
```python Python theme={null}
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/youtube_transcript_create",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"youtubeUrl": "https://www.youtube.com/watch?v=abcdefghijk", "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```
## Respuesta
Esta operación devuelve HTTP 202 mientras se ejecuta. Guarda requestId y consulta action\_request\_get con ese identificador y el nombre de la operación original. Los estados de consulta son running, completed, failed e interrupted. Un resultado completado puede apuntar a un trabajo multimedia independiente; continúa con la acción de estado o de salida específica de la operación.
Una referencia guardada de transcripción de YouTube. El JSON completo contiene metadatos del vídeo, segmentos con tiempos, text, srt, createdAt y language opcional; puede conservarse una etiqueta de origen para los subtítulos nativos de YouTube.
```json HTTP 202 theme={null}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
```
```json HTTP 200 theme={null}
{
"data": {
"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
"operation": "youtube_transcript_create",
"createdAt": 1792152000000,
"fileName": "voicecheap-youtube_transcript_create-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
"byteLength": 461,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "transcription_result_get",
"downloadAction": "transcription_result_download",
"listAction": "transcription_result_list"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
```
```json HTTP 202 replay_running theme={null}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "youtube_transcript_create",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
```
```json HTTP 200 replay_completed_without_result theme={null}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "youtube_transcript_create",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
```
## Campos del resultado
| Campo | Descripción |
| - | - |
| `data.resultId` | UUID de una salida guardada que pertenece a la cuenta. Úsalo con getAction o downloadAction; es distinto de requestId y de cualquier historyId. |
| `data.operation` | Acción de generación que produjo este JSON guardado. |
| `data.createdAt` | Marca de tiempo Unix en milisegundos del momento en que se preparó el resultado guardado. |
| `data.fileName` | Nombre de archivo sugerido para una exportación JSON. |
| `data.byteLength` | Bytes UTF-8 de la salida serializada completa, no de los metadatos compactos. |
| `data.contentType` | application/json; charset=utf-8. |
| `data.status` | completed cuando la generación tiene éxito. El historial de resultados también puede mostrar entradas pendientes de recuperación. |
| `data.requestId` | UUID de la solicitud de acción original cuando se ha registrado. |
| `data.getAction` | Acción de recuperación de contenido propio; includeContent tiene como valor predeterminado false y debe ser true para obtener la salida estructurada completa. |
| `data.downloadAction` | Acción de exportación autenticada que devuelve el JSON completo como una cadena de contenido. |
| `data.listAction` | Acción de listado de salidas guardadas de tu propiedad para este ámbito de permisos. |
## Recuperar y consultar esta solicitud
Usa el mismo identificador incluso después de perder la conexión. Si resultStored es false, recupera la salida mediante la acción correspondiente de historial, resultado o descarga. Nunca inicies una segunda generación solo para comprobar el progreso.
```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab","operation":"youtube_transcript_create"}'
```
```json HTTP 200 theme={null}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "youtube_transcript_create",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
"operation": "youtube_transcript_create",
"createdAt": 1792152000000,
"fileName": "voicecheap-youtube_transcript_create-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
"byteLength": 461,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "transcription_result_get",
"downloadAction": "transcription_result_download",
"listAction": "transcription_result_list"
}
}
}
```
## Notas de la operación
* Requiere una suscripción de pago y el permiso de la acción. El plan personal de herramientas del actor se comprueba de nuevo al ejecutar; las herramientas guardadas y las referencias de carga pertenecen a ese actor, también cuando la credencial está asociada a un equipo.
* Una acción correcta consume una llamada mensual compartida de API/MCP. Beginner permite 500, Starter 5,000 y Creator 25,000 llamadas al mes; Pro, Scale y Enterprise no tienen límite mensual. Siguen aplicándose los límites por minuto: 30, 60, 120, 180, 300 y 600, respectivamente. Las cuotas de generación de las herramientas son independientes.
* Usa un requestId UUID v4 o un encabezado Idempotency-Key idéntico, y conserva la misma acción, el mismo ID y los mismos argumentos en los reintentos. Una repetición desde la caché no consume otra llamada mensual.
* Esta es una acción asíncrona. El resultado inicial del transporte es una solicitud en ejecución con pollAction; consulta periódicamente action\_request\_get con esta operación y el requestId original. El resultado de la operación completada que se muestra aquí es una referencia compacta a la salida guardada, no el cuerpo generado.
* El resultado completo se guarda con la titularidad autenticada en almacenamiento cifrado, independientemente de la caché limitada de consulta de acciones. Llama al getAction devuelto con resultId e includeContent: true para obtener JSON estructurado, o a downloadAction con resultId para obtener texto JSON. listAction permite recuperarlo cuando solo se conoce la solicitud original.
* El JSON guardado está limitado a 32 MiB. Los metadatos nunca exponen su clave de cifrado de almacenamiento ni una URL de descarga de la transcripción sin autenticación.
* Una generación correcta consume una unidad de la cuota personal de la herramienta. Una generación fallida normalmente libera su reserva de herramienta. Cuando no se sabe con certeza si la salida se ha guardado, revisa la misma solicitud y el historial de resultados guardados antes de volver a generar; el servidor mantiene la reserva para evitar un consumo duplicado.
* Los planes superiores sin límite mensual de integración siguen teniendo las cuotas diarias específicas de cada herramienta y los límites multimedia que se indican a continuación. Estas acciones independientes consumen su cuota de herramienta en lugar de minutos de doblaje o caracteres TTS.
* Usa una URL HTTPS pública de YouTube en youtube.com, [www.youtube.com](http://www.youtube.com), m.youtube.com, music.youtube.com o youtu.be, sin credenciales integradas ni un puerto explícito. El vídeo no debe durar más de 2 horas.
* Cuota diaria por herramienta: Beginner 5, Starter 15, Creator 30, Pro 60, Scale 100 y Enterprise 100 generaciones completadas correctamente. Se comparte con la herramienta web correspondiente y utiliza el periodo de restablecimiento de herramientas de la cuenta.
* En todos los planes se aplica un límite adicional de 12 intentos diarios de transcripción de YouTube, incluidos los fallidos. Puede ser inferior a la cuota de generaciones completadas correctamente. La vía de integración utiliza el límite compartido por minuto de la integración.
* El JSON de integración guardado se captura antes del posterior intento de guardar el historial de transcripciones de YouTube. Por tanto, transcriptId no forma parte de esta salida completa persistida; busca el historial de la herramienta web mediante youtube\_transcript\_history\_list cuando lo necesites.
* No se utiliza ningún origen subido previamente. El resultado completo contiene startSeconds/endSeconds de los segmentos de transcripción en segundos, mientras que createdAt está en milisegundos.
## Uso
Cada invocación correcta consume una llamada mensual de API/MCP. También se aplican los créditos multimedia y las cuotas de generación propias de la operación.
## Errores
| Estado HTTP | Código | Significado o solución |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Se han proporcionado credenciales en un parámetro de consulta access\_token o api\_key. Envía las credenciales en las cabeceras. |
| 400 | `DURATION_TOO_LONG` | El vídeo de YouTube supera los 7,200 segundos. |
| 400 | `DURATION_UNKNOWN` | No se pudo determinar una duración positiva para el vídeo de YouTube. |
| 400 | `IDEMPOTENCY_CONFLICT` | Los ID de solicitud de la cabecera y del cuerpo son distintos. |
| 400 | `INVALID_REQUEST_ID` | requestId o Idempotency-Key no es un UUID v4. |
| 400 | `INVALID_YOUTUBE_URL` | La URL HTTPS de YouTube no identifica un vídeo compatible. |
| 400 | `VALIDATION_ERROR` | Los argumentos no cumplen el esquema de la acción o se ha proporcionado un argumento desconocido. |
| 400 | `VIDEO_AGE_RESTRICTED` | El vídeo de YouTube tiene una restricción de edad. |
| 400 | `VIDEO_PRIVATE` | El vídeo de YouTube es privado. |
| 400 | `VIDEO_REGION_BLOCKED` | El vídeo de YouTube está bloqueado en la región del servidor. |
| 400 | `VIDEO_UNAVAILABLE` | El vídeo de YouTube no está disponible. |
| 401 | `API_KEY_EXPIRED` | La clave API ha caducado. |
| 401 | `INVALID_API_KEY` | Proporciona una clave de API válida que no haya caducado. |
| 401 | `INVALID_CREDENTIAL` | La cabecera Authorization tiene un formato incorrecto o entra en conflicto con x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No se proporcionó ninguna credencial de cabecera utilizable o superaba 4096 caracteres. |
| 401 | `USER_NOT_FOUND` | La cuenta de la credencial ya no existe. |
| 403 | `ACCOUNT_UNAVAILABLE` | La cuenta que realiza la acción o la cuenta de facturación no está disponible o se está eliminando. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | El usuario de la credencial pertenece a más de un equipo, por lo que el contexto de facturación es ambiguo. |
| 403 | `INSUFFICIENT_SCOPE` | La clave de API o la conexión MCP no tiene el permiso necesario para la acción. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | No se han podido verificar los límites de integración de la cuenta. |
| 403 | `PAID_SUBSCRIPTION_REQUIRED` | El actor autenticado ya no tiene una suscripción de pago cuando se ejecuta esta acción de la herramienta. |
| 403 | `SUBSCRIPTION_REQUIRED` | Usa una suscripción de pago activa. |
| 403 | `TEAM_OWNER_NOT_FOUND` | No se pudo encontrar la cuenta del propietario efectivo del equipo. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Esta cuenta ya tiene 10 acciones de integración en ejecución. Consulta una solicitud existente antes de iniciar otra. |
| 409 | `IDEMPOTENCY_CONFLICT` | Reutiliza un identificador solo con la misma operación y los mismos argumentos. |
| 410 | `TOOL_RESULT_ACCOUNT_UNAVAILABLE` | La cuenta del actor se está eliminando o ya no existe, por lo que no se puede guardar un resultado duradero. |
| 413 | `TOOL_RESULT_TOO_LARGE` | El JSON completo generado supera 32 MiB y no puede guardarse como resultado de integración. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Las llamadas usadas y pendientes han alcanzado la cuota mensual compartida de API/MCP. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | La cuenta ha alcanzado su límite de integración por minuto; consulta retryAfterSeconds. |
| 429 | `YOUTUBE_TRANSCRIPT_TOOL_ATTEMPT_LIMIT_REACHED` | Se ha agotado el límite independiente de 12 intentos de transcripción de YouTube al día. |
| 429 | `YOUTUBE_TRANSCRIPT_TOOL_DAILY_LIMIT_REACHED` | Se ha agotado la cuota diaria de usos correctos de la herramienta de transcripción de YouTube. |
| 500 | `INTERNAL_ERROR` | La herramienta original o la persistencia del resultado fallaron internamente. Revisa la solicitud guardada y el historial de salidas antes de reintentar una generación. |
| 502 | `INTERNAL_ERROR` | La generación o el guardado del resultado ha fallado. Consulta la solicitud original y el historial de resultados guardados antes de iniciar otra generación. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | La acción se ha ejecutado, pero no se ha podido confirmar la persistencia del resultado de la solicitud. Consulta la misma acción y requestId y revisa el historial del recurso antes de iniciar otra escritura. |
| 503 | `INTERNAL_ERROR` | El resultado de la generación o de la persistencia del resultado guardado es incierto o no está disponible temporalmente; usa la recuperación autenticada de resultados antes de volver a generar. |
| 503 | `SERVER_RESTARTING` | El servidor se está reiniciando. Reinténtalo en breve y conserva el mismo identificador de solicitud para una modificación. |
```json theme={null}
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["transcription:write"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.