> ## 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.
# Obtener o exportar la transcripción de un proyecto
> Recupera la transcripción original o traducida como JSON, SRT o VTT, con etiquetas de hablante opcionales.
Recupera la transcripción original o traducida como JSON, SRT o VTT, con etiquetas de hablante opcionales.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/transcripts_get
```
## 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:read`.
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ínima: 1. Longitud máxima: 200. Patrón: `^[^/\\]+$`.
Valor de texto.
Valores permitidos: "original", "translated". Valor predeterminado: "original".
Valor de texto.
Valores permitidos: "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese", "azerbaijani", "basque", "belarusian", "bengali", "bosnian", "bulgarian", "catalan", "croatian", "czech", "danish", "dutch", "english", "british english", "estonian", "finnish", "french", "french canadian", "galician", "german", "greek", "gujarati", "hebrew", "hindi", "hungarian", "icelandic", "indonesian", "irish", "italian", "japanese", "kannada", "kazakh", "khmer", "korean", "lao", "latvian", "lithuanian", "macedonian", "malay", "malayalam", "mandarin", "marathi", "mongolian", "nepali", "norwegian", "persian", "polish", "portuguese", "brazilian portuguese", "pt\_brazil", "punjabi", "romanian", "russian", "serbian", "slovak", "slovenian", "spanish", "swahili", "swedish", "tagalog", "tamil", "telugu", "thai", "turkish", "ukrainian", "urdu", "vietnamese", "welsh", "yoruba", "zulu".
Valor de texto.
Valores permitidos: "json", "srt", "vtt". Valor predeterminado: "json".
Valor booleano.
Valor predeterminado: false.
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": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
},
"source": {
"default": "original",
"type": "string",
"enum": ["original", "translated"]
},
"targetLanguage": {
"type": "string",
"enum": [
"afrikaans",
"albanian",
"amharic",
"arabic",
"armenian",
"assamese",
"azerbaijani",
"basque",
"belarusian",
"bengali",
"bosnian",
"bulgarian",
"catalan",
"croatian",
"czech",
"danish",
"dutch",
"english",
"british english",
"estonian",
"finnish",
"french",
"french canadian",
"galician",
"german",
"greek",
"gujarati",
"hebrew",
"hindi",
"hungarian",
"icelandic",
"indonesian",
"irish",
"italian",
"japanese",
"kannada",
"kazakh",
"khmer",
"korean",
"lao",
"latvian",
"lithuanian",
"macedonian",
"malay",
"malayalam",
"mandarin",
"marathi",
"mongolian",
"nepali",
"norwegian",
"persian",
"polish",
"portuguese",
"brazilian portuguese",
"pt_brazil",
"punjabi",
"romanian",
"russian",
"serbian",
"slovak",
"slovenian",
"spanish",
"swahili",
"swedish",
"tagalog",
"tamil",
"telugu",
"thai",
"turkish",
"ukrainian",
"urdu",
"vietnamese",
"welsh",
"yoruba",
"zulu"
]
},
"outputFormat": {
"default": "json",
"type": "string",
"enum": ["json", "srt", "vtt"]
},
"includeSpeakerLabels": {
"default": false,
"type": "boolean"
}
},
"required": ["projectId"],
"additionalProperties": false
}
```
## 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/transcripts_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","source":"original","outputFormat":"json","includeSpeakerLabels":false}'
```
```javascript JavaScript theme={null}
const input = {
projectId: 'project_launch_2026',
source: 'original',
outputFormat: 'json',
includeSpeakerLabels: false,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcripts_get', {
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/transcripts_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "source": "original", "outputFormat": "json", "includeSpeakerLabels": False},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```
## Respuesta
Una primera ejecución correcta devuelve HTTP 200 con el resultado de la operación en data. Una repetición puede devolver el estado de la solicitud guardada en su lugar. El ejemplo muestra una respuesta admitida, no todos los campos opcionales.
Devuelve un objeto de transcripción con formato. JSON contiene format, transcript y contentType; SRT/VTT también incluyen content y fileExtension.
```json HTTP 200 theme={null}
{
"data": {
"format": "json",
"transcript": {
"source": "original",
"language": "fr",
"duration": 75,
"text": "Bienvenue au lancement.",
"speakers": [
{
"id": 0,
"label": "Speaker 1"
}
],
"segments": [
{
"index": 0,
"text": "Bienvenue au lancement.",
"begin": 0,
"end": 2,
"duration": 2,
"speaker": 0,
"language": "fr"
}
]
},
"contentType": "application/json"
}
}
```
## Campos del resultado
| Campo | Descripción |
| - | - |
| `data.format` | json, srt o vtt. |
| `data.contentType` | application/json, application/x-subrip; charset=utf-8 o text/vtt; charset=utf-8. |
| `data.content` | Texto de subtítulos solo para srt/vtt. |
| `data.fileExtension` | srt o vtt solo para exportaciones de texto. |
| `data.transcript.source` | original o translated. |
| `data.transcript.language` | Idioma de la transcripción. |
| `data.transcript.duration` | Máximo entre la duración multimedia almacenada y el final del último segmento, en segundos. |
| `data.transcript.text` | Texto unido de los segmentos no vacíos. |
| `data.transcript.speakers` | Hablantes únicos ordenados por id numérico, con etiquetas Speaker N generadas. |
| `data.transcript.segments` | Segmentos normalizados ordenados por begin e index, con index, text, begin, end, duration, speaker, language y los campos opcionales confidence, finalSpeedFactor, words. |
| `data.transcript.workId` | Se incluye para una transcripción traducida. |
| `data.transcript.targetLanguage` | Se incluye para una transcripción traducida. |
| `data.transcript.segments[].begin` | Tiempo de inicio en segundos, normalizado a tres decimales. |
| `data.transcript.segments[].end` | Tiempo de finalización en segundos, normalizado a tres decimales. |
| `data.transcript.segments[].duration` | Duración positiva del segmento en segundos. |
| `data.transcript.segments[].speaker` | Número de hablante con índice desde cero. |
| `data.transcript.segments[].finalSpeedFactor` | Duración opcional de la voz traducida dividida entre la ventana de su segmento, redondeada a tres decimales; los valores superiores a 1 indican que fue necesario acelerar la voz. |
## outputFormat srt; source translated, targetLanguage english, includeSpeakerLabels true.
Devuelve la transcripción traducida y el contenido SRT con prefijos de hablante.
```json HTTP 200 theme={null}
{
"data": {
"format": "srt",
"transcript": {
"source": "translated",
"language": "english",
"duration": 75,
"text": "Welcome to the product launch.",
"speakers": [
{
"id": 0,
"label": "Speaker 1"
}
],
"segments": [
{
"index": 0,
"text": "Welcome to the product launch.",
"begin": 0,
"end": 2,
"duration": 2,
"speaker": 0,
"language": "english",
"finalSpeedFactor": 1.08
}
],
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"targetLanguage": "english"
},
"content": "1\n00:00:00,000 --> 00:00:02,000\nSpeaker 1: Welcome to the product launch.\n",
"contentType": "application/x-subrip; charset=utf-8",
"fileExtension": "srt"
}
}
```
## outputFormat vtt; source translated, targetLanguage english, includeSpeakerLabels true.
Devuelve la transcripción traducida y el contenido WEBVTT con etiquetas de voz.
```json HTTP 200 theme={null}
{
"data": {
"format": "vtt",
"transcript": {
"source": "translated",
"language": "english",
"duration": 75,
"text": "Welcome to the product launch.",
"speakers": [
{
"id": 0,
"label": "Speaker 1"
}
],
"segments": [
{
"index": 0,
"text": "Welcome to the product launch.",
"begin": 0,
"end": 2,
"duration": 2,
"speaker": 0,
"language": "english",
"finalSpeedFactor": 1.08
}
],
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"targetLanguage": "english"
},
"content": "WEBVTT\n\n1\n00:00:00.000 --> 00:00:02.000\nWelcome to the product launch.\n",
"contentType": "text/vtt; charset=utf-8",
"fileExtension": "vtt"
}
}
```
## Notas de la operación
* source tiene como valor predeterminado original, outputFormat json e includeSpeakerLabels false. Una fuente traducida requiere targetLanguage.
* Para las transcripciones traducidas, se selecciona el trabajo de idioma más reciente que coincida con targetLanguage. Esta acción no tiene entrada workId ni translatedVersionId.
* Las exportaciones SRT y VTT siguen siendo resultados de acción JSON: content contiene el texto de los subtítulos y transcript sigue disponible en el mismo objeto. Este controlador no devuelve una respuesta descargable sin procesar.
* includeSpeakerLabels solo afecta a los bloques de exportación de texto: SRT usa prefijos Speaker N: y VTT usa etiquetas de voz.
* Las palabras de la transcripción almacenada, cuando están presentes, exponen index, text, speaker y confidence opcional; no se inventan marcas de tiempo por palabra. Los segmentos traducidos pueden exponer finalSpeedFactor cuando existe información temporal de la voz generada.
## 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 | `VALIDATION_ERROR` | Corrige la entrada según el esquema. Los valores no válidos o incoherentes se rechazan antes de la ejecución. |
| 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 | `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 | `FORBIDDEN` | El actor autenticado no puede acceder a este proyecto. |
| 403 | `INSUFFICIENT_SCOPE` | Concede todos los permisos necesarios o elige otra credencial. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | No se han podido verificar los límites de integración de la cuenta. |
| 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. |
| 404 | `PROJECT_NOT_FOUND` | El proyecto no existe en la cuenta accesible. |
| 404 | `TRANSCRIPT_NOT_FOUND` | No existe ninguna transcripción utilizable para la fuente y el idioma de destino solicitados. |
| 409 | `TRANSCRIPT_NOT_READY` | La transcripción original o traducida solicitada aún se está procesando. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Espera al restablecimiento mensual o cambia de plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Espera el tiempo indicado en Retry-After cuando esté presente y aplica esperas progresivas. |
| 500 | `INTERNAL_ERROR` | Comprueba el estado de la solicitud guardada y el historial del recurso antes de decidir si reintentas una modificación. |
| 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:read"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.