Skip to main content
POST
Crie um projeto a partir do fileKey enviado, transcreva e traduza, depois sintetize a fala. Aceita SRT próprios, vozes, legendas e sincronização labial opcional. Usa os créditos de mídia habituais. Uma webhookUrl opcional recebe os eventos de processamento. Consulte projects_status.

​
Autenticação e permissões

​
string
obrigatório
Envie uma chave de API VoiceCheap neste cabeçalho. Authorization: Bearer com a mesma chave de API também é aceito. Tokens de acesso OAuth são aceitos apenas pelo MCP, não por este endpoint REST.
Permissões necessárias: projects:write, translations:write, transcription:write. É necessária uma assinatura paga ativa. As permissões não alteram funções na equipe, propriedade dos recursos, créditos de mídia ou limites do plano.

​
Parâmetros

​
string
obrigatório
Valor de texto.Comprimento mínimo: 1. Comprimento máximo: 1024.
​
string
obrigatório
Valor de texto.Valores aceitos: “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 aceitos: “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.Comprimento mínimo: 1. Comprimento máximo: 200.
​
string
Valor de texto.Valores aceitos: “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. Consulte o esquema de entrada completo para ver a estrutura dos itens.Máximo de itens: 1000.
​
boolean
Valor booleano.
​
string
Valor de texto.Comprimento máximo: 1000000.
​
string
Valor de texto.Comprimento máximo: 2048. Formato: “uri”.
​
string
Opcional na camada de transporte: o servidor insere um identificador antes da validação quando ele é omitido. Forneça seu próprio UUID v4 estável para recuperar com segurança uma resposta perdida.Formato: “uuid”. Padrão: ^[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 aceitos: “cloning”, “custom”.
​
string
Valor de texto.Comprimento mínimo: 1. Comprimento máximo: 128.
​
boolean
Valor booleano.
​
string
Valor de texto.Valores aceitos: “translated”, “original”.
​
string
Valor de texto.Valores aceitos: “studio”, “realistic”.
​
string
Valor de texto.Valores aceitos: “standard”, “pro”, “studio”.
​
boolean
Valor booleano.
​
object
Objeto JSON. Consulte o esquema de entrada completo para ver os campos aninhados.
​
array
Lista de valores. Consulte o esquema de entrada completo para ver a estrutura dos itens.Máximo de itens: 100.
​
string
Valor de texto.Comprimento máximo: 1000000.
O JSON Schema abaixo preserva os nomes exatos dos campos, tipos aninhados, valores padrão, limites e valores aceitos expostos pela descoberta. Regras adicionais entre campos são listadas nas notas da operação.

​
Idempotência

Use um UUID v4 em requestId ou no cabeçalho HTTP Idempotency-Key para cada alteração. Reutilize o mesmo identificador e argumentos idênticos após uma falha de rede. Se ambos forem fornecidos, devem ser iguais. Repetir uma requisição salva não repete a operação nem consome outra chamada mensal. Requisições com falha ou interrompidas não são reiniciadas automaticamente. Qualquer alteração pode retornar HTTP 202 quando uma nova tentativa encontra a mesma requisição ainda em execução, mesmo que a primeira execução normalmente seja síncrona. Se a execução foi concluída, mas resultStored é false, uma nova tentativa retorna HTTP 200 com o estado salvo da requisição em vez do resultado original. Recupere a saída pela ação de histórico, resultado ou download do domínio correspondente.

​
Exemplos de requisição

Substitua os identificadores de recursos e as chaves de mídia dos exemplos pelos valores retornados para sua conta. Mantenha o identificador da requisição ao tentar novamente a mesma alteração.

​
Resposta

Uma primeira execução bem-sucedida retorna HTTP 200 com o resultado da operação em data. Uma repetição pode retornar o estado salvo da requisição. O exemplo mostra uma resposta aceita, não todos os campos opcionais. Retorna um novo identificador de projeto após iniciar a transcrição seguida de tradução e geração de fala, ou a dublagem com tradução fornecida.

​
Campos do resultado

​
translatedSrt é fornecido e aceito.

Os mesmos campos de resultado confirmam a dublagem do texto de destino fornecido.
HTTP 200

​
Recuperar e consultar esta requisição

Use o mesmo identificador mesmo após perder a conexão. Se resultStored for false, recupere a saída pela ação correspondente de histórico, resultado ou download. Nunca inicie uma segunda geração apenas para verificar o progresso.
HTTP 200

​
Notas da operação

  • O fileKey concluído deve pertencer ao ator autenticado. O servidor mede a duração e o tamanho da mídia armazenada.
  • Um sourceSrt opcional requer um originalLanguage explícito. Quando translatedSrt também é fornecido, ambos os SRTs devem ter o mesmo número de blocos; a tradução fornecida é pareada pelo índice do bloco.
  • Quando translatedSrt é fornecido, o fluxo de trabalho dubla esse texto e retorna a confirmação de tradução fornecida. Com sourceSrt, o alinhamento dos blocos é feito por índice; sem sourceSrt, ele usa a linha do tempo da transcrição automática.
  • O resultado da criação não contém workId nem translatedVersionId. Obtenha-os em projects_status ou projects_get assim que existirem.
  • voiceMode usa cloning por padrão. Com voiceMode custom, use uma voz do catálogo ou uma voz personalizada salva pela conta autenticada; não envie voiceCloningSettings. A cobrança da equipe não concede acesso às vozes salvas de outros membros.
  • Os campos opcionais subtitles, lipSyncMode e translationTimeSkips exigem uma entrada de vídeo. Os intervalos ignorados devem ficar dentro da duração da mídia, keepBackgroundMusic deve ser true e keepOriginalVoice deve ser false.
  • lipSyncMode aceita standard, pro ou studio, sujeito ao plano e às verificações normais de créditos de mídia. Fala e sincronização labial não se tornam gratuitas porque as chamadas mensais de API são ilimitadas.
  • Consulte projects_status periodicamente para acompanhar o fluxo de mídia; obtenha todas as versões de idioma com projects_get.
  • originalLanguage usa códigos do idioma de origem, como fr ou en (ou auto-detect, quando aceito); targetLanguage usa nomes de idiomas de destino compatíveis, como english.

​
Uso

Cada chamada bem-sucedida consome uma chamada mensal da API/MCP. Os créditos de mídia e as cotas de geração da própria operação também se aplicam.

​
Erros