Skip to main content
POST
Crea un proyecto a partir de tu fileKey subido, transcríbelo y tradúcelo, y después sintetiza la voz. Admite SRT propios, voces, subtítulos y sincronización labial opcional. Usa los créditos multimedia habituales. Una webhookUrl opcional recibe eventos de procesamiento. Consulta projects_status.

​
Autenticación y permisos

​
string
requerido
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: projects:write, translations:write, 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

​
string
requerido
Valor de texto.Longitud mínima: 1. Longitud máxima: 1024.
​
string
requerido
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”.
​
string
Valor de texto.Valores permitidos: “af”, “sq”, “am”, “ar”, “hy”, “as”, “ast”, “az”, “ba”, “eu”, “be”, “bn”, “bs”, “br”, “bg”, “my”, “ca”, “ceb”, “zh”, “hr”, “cs”, “da”, “nl”, “en”, “eo”, “at”, “et”, “fil”, “fo”, “fi”, “fr”, “fr-CA”, “fy”, “ff”, “gd”, “gl”, “lg”, “ka”, “de”, “el”, “gu”, “ht”, “ha”, “haw”, “he”, “hi”, “hu”, “is”, “ig”, “ilo”, “id”, “ia”, “ga”, “it”, “ja”, “jv”, “kea”, “kn”, “kk”, “km”, “kur”, “kir”, “ko”, “lo”, “la”, “luo”, “lv”, “lb”, “ln”, “lt”, “mk”, “mg”, “ms”, “ml”, “mt”, “mi”, “mr”, “mo”, “mn”, “ne”, “no”, “nn”, “nso”, “nya”, “oc”, “or”, “pa”, “ps”, “fa”, “pl”, “pt”, “ro”, “ru”, “sa”, “sr”, “sn”, “sd”, “si”, “sk”, “sl”, “so”, “es”, “su”, “sw”, “ss”, “sv”, “tl”, “tg”, “ta”, “tt”, “te”, “th”, “bo”, “tn”, “tr”, “tk”, “ug”, “uk”, “umb”, “ur”, “uz”, “vi”, “cy”, “wo”, “xh”, “yi”, “yo”, “zu”, “cmn”, “yue”, “en-GB”, “en-US”, “en-AU”, “auto-detect”.
​
string
Valor de texto.Longitud mínima: 1. Longitud máxima: 200.
​
string
Valor de texto.Valores permitidos: “1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “10”, “11”, “12”, “13”, “14”, “15”, “16”, “17”, “18”, “19”, “20”, “21”, “22”, “23”, “24”, “25”, “26”, “27”, “28”, “29”, “30”, “31”, “32”, “auto-detect”.
​
array
Lista de valores. Consulta la estructura de sus elementos en el esquema completo de entrada.Número máximo de elementos: 1000.
​
boolean
Valor booleano.
​
string
Valor de texto.Longitud máxima: 1000000.
​
string
Valor de texto.Longitud máxima: 2048. Formato: “uri”.
​
string
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}$.
​
boolean
Valor booleano.
​
boolean
Valor booleano.
​
number
Valor numérico.Mínimo: 1. Máximo: 70.
​
string
Valor de texto.Valores permitidos: “cloning”, “custom”.
​
string
Valor de texto.Longitud mínima: 1. Longitud máxima: 128.
​
boolean
Valor booleano.
​
string
Valor de texto.Valores permitidos: “translated”, “original”.
​
string
Valor de texto.Valores permitidos: “studio”, “realistic”.
​
string
Valor de texto.Valores permitidos: “standard”, “pro”, “studio”.
​
boolean
Valor booleano.
​
object
Objeto JSON. Consulta sus campos anidados en el esquema completo de entrada.
​
array
Lista de valores. Consulta la estructura de sus elementos en el esquema completo de entrada.Número máximo de elementos: 100.
​
string
Valor de texto.Longitud máxima: 1000000.
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.

​
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.

​
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 nuevo identificador de proyecto tras iniciar la transcripción seguida de la traducción y la generación de voz, o el doblaje con la traducción proporcionada.

​
Campos del resultado

​
translatedSrt se proporciona y se acepta.

Los mismos campos del resultado confirman el doblaje del texto de destino proporcionado.
HTTP 200

​
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.
HTTP 200

​
Notas de la operación

  • El fileKey completado debe pertenecer al actor autenticado. El servidor mide la duración y el tamaño del archivo multimedia almacenado.
  • Un sourceSrt opcional requiere un originalLanguage explícito. Cuando también se proporciona translatedSrt, ambos SRT deben tener el mismo número de entradas de subtítulos; la traducción proporcionada se empareja por el índice de cada entrada.
  • Cuando se proporciona translatedSrt, el flujo de trabajo dobla ese texto y devuelve la confirmación de traducción proporcionada. Con sourceSrt, los bloques se alinean por índice; sin sourceSrt, se utiliza la línea temporal de la transcripción automática.
  • El resultado de creación no contiene workId ni translatedVersionId. Obtenlos de projects_status o projects_get cuando existan.
  • voiceMode usa cloning de forma predeterminada. Con voiceMode custom, utiliza una voz del catálogo o una voz personalizada guardada por la cuenta autenticada; no envíes voiceCloningSettings. La facturación del equipo no da acceso a las voces guardadas de otro miembro.
  • Los campos opcionales subtitles, lipSyncMode y translationTimeSkips requieren una entrada de vídeo. Los intervalos omitidos deben permanecer dentro de la duración del contenido multimedia, keepBackgroundMusic debe ser true y keepOriginalVoice debe ser false.
  • lipSyncMode acepta standard, pro o studio, sujeto al plan y a las comprobaciones normales de créditos multimedia. La voz y la sincronización labial no pasan a ser gratuitas porque las llamadas mensuales a la API sean ilimitadas.
  • Consulta periódicamente projects_status para seguir el flujo multimedia; recupera todas las versiones por idioma con projects_get.
  • originalLanguage usa códigos del idioma de origen como fr o en (o auto-detect donde se acepte); targetLanguage usa nombres de idiomas de destino compatibles como english.

​
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