curl --request POST 'https://api.voicecheap.ai/v1/actions/translations_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_list', {
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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/translations_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projectId": "project_launch_2026",
"works": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"projectId": "project_launch_2026",
"targetLanguage": "english",
"originalLanguage": "fr",
"createdAt": 1792152000000,
"isWorkWaitingForProofreading": false,
"pendingSegmentIndexes": [],
"versions": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"targetLanguage": "english",
"status": "completed",
"currentStep": "done",
"progress": 100,
"createdAt": 1792152060000,
"completedAt": 1792152300000,
"translatedVideoUrl": "https://media.example.com/launch/english.mp4",
"translatedAudioUrl": "https://media.example.com/launch/english.mp3",
"settings": {
"voiceCloning": true,
"uploadType": "video",
"keepBackgroundMusic": true,
"keepOriginalVoice": false,
"originalVoiceVolume": 30,
"subtitles": {
"isEnable": false,
"source": "translated"
},
"smartSync": true,
"dubbingMode": "translate",
"voiceIsolatorOption": "studio"
}
}
]
}
]
}
}
Tradução e dublagem
Listar trabalhos de idioma de um projeto
Liste os trabalhos de idioma e suas versões públicas de tradução de um projeto acessível.
POST
/
v1
/
actions
/
translations_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/translations_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_list', {
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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/translations_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projectId": "project_launch_2026",
"works": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"projectId": "project_launch_2026",
"targetLanguage": "english",
"originalLanguage": "fr",
"createdAt": 1792152000000,
"isWorkWaitingForProofreading": false,
"pendingSegmentIndexes": [],
"versions": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"targetLanguage": "english",
"status": "completed",
"currentStep": "done",
"progress": 100,
"createdAt": 1792152060000,
"completedAt": 1792152300000,
"translatedVideoUrl": "https://media.example.com/launch/english.mp4",
"translatedAudioUrl": "https://media.example.com/launch/english.mp3",
"settings": {
"voiceCloning": true,
"uploadType": "video",
"keepBackgroundMusic": true,
"keepOriginalVoice": false,
"originalVoiceVolume": 30,
"subtitles": {
"isEnable": false,
"source": "translated"
},
"smartSync": true,
"dubbingMode": "translate",
"voiceIsolatorOption": "studio"
}
}
]
}
]
}
}
Liste os trabalhos de idioma e suas versões públicas de tradução de um projeto acessível.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/translations_list
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.
projects:read.
É 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: 200. Padrão:
^[^/\\]+$.Esquema de entrada completo
Esquema de entrada completo
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.
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
}
},
"required": ["projectId"],
"additionalProperties": false
}
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.curl --request POST 'https://api.voicecheap.ai/v1/actions/translations_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_list', {
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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/translations_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
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 todos os trabalhos de idioma acessíveis do projeto, com versões públicas de saída e índices de segmentos pendentes.{
"data": {
"projectId": "project_launch_2026",
"works": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"projectId": "project_launch_2026",
"targetLanguage": "english",
"originalLanguage": "fr",
"createdAt": 1792152000000,
"isWorkWaitingForProofreading": false,
"pendingSegmentIndexes": [],
"versions": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"targetLanguage": "english",
"status": "completed",
"currentStep": "done",
"progress": 100,
"createdAt": 1792152060000,
"completedAt": 1792152300000,
"translatedVideoUrl": "https://media.example.com/launch/english.mp4",
"translatedAudioUrl": "https://media.example.com/launch/english.mp3",
"settings": {
"voiceCloning": true,
"uploadType": "video",
"keepBackgroundMusic": true,
"keepOriginalVoice": false,
"originalVoiceVolume": 30,
"subtitles": {
"isEnable": false,
"source": "translated"
},
"smartSync": true,
"dubbingMode": "translate",
"voiceIsolatorOption": "studio"
}
}
]
}
]
}
}
Campos do resultado
| Campo | Descrição |
|---|---|
data.projectId | Identificador do projeto pai. |
data.works | Array de projeções de trabalhos de idioma. |
data.works[].workId | Identificador do trabalho de idioma. |
data.works[].projectId | Identificador do projeto pai. |
data.works[].targetLanguage | Idioma de destino. |
data.works[].originalLanguage | Idioma de origem. |
data.works[].createdAt | Horário de criação do trabalho de idioma normalizado para milissegundos Unix. |
data.works[].isWorkWaitingForProofreading | Estado de revisão; false quando não definido explicitamente. |
data.works[].pendingSegmentIndexes | Índices de segmentos de origem ainda pendentes de tradução; array vazio por padrão. |
data.works[].versions | Todas as versões públicas deste trabalho, ordenadas da mais recente para a mais antiga. |
data.works[].versions[].workId | Identificador do trabalho de idioma que contém esta versão. |
data.works[].versions[].translatedVersionId | Identificador de uma versão específica da saída de dublagem. |
data.works[].versions[].targetLanguage | Idioma de destino da versão, usando como alternativa o idioma do seu trabalho de idioma. |
data.works[].versions[].status | Estado da versão armazenada: not-started, in-progress, completed ou failed. |
data.works[].versions[].currentStep | Etapa opcional do fluxo de dublagem; progress é um valor numérico opcional de progresso. |
data.works[].versions[].progress | Valor opcional de progresso da dublagem. |
data.works[].versions[].createdAt | Horário de criação normalizado em milissegundos Unix; usa como alternativa o horário de criação do trabalho de idioma. |
data.works[].versions[].completedAt | Horário opcional de conclusão em milissegundos Unix. |
data.works[].versions[].failedAt | Horário opcional da falha em milissegundos Unix. |
data.works[].versions[].timedOutAt | Horário opcional de esgotamento do prazo em milissegundos Unix. |
data.works[].versions[].translatedVideoUrl | URL armazenada do vídeo traduzido ou uma string vazia quando indisponível. |
data.works[].versions[].translatedAudioUrl | URL armazenada do áudio traduzido ou uma string vazia quando indisponível. |
data.works[].versions[].error | {code,message} opcional quando a versão falhou. |
data.works[].versions[].settings | Configurações públicas da versão: voiceCloning, uploadType, keepBackgroundMusic, keepOriginalVoice, originalVoiceVolume, subtitles, smartSync, dubbingMode, voiceIsolatorOption e, opcionalmente, translationQualityMode, cutBecauseFreeUser, originalDurationSeconds, cutDurationSeconds, voiceCloningSettings. |
data.works[].versions[].settings.dubbingMode | translate ou dub-only. SmartSync é false para versões dub-only. |
data.works[].versions[].lipSync | {latest,history} opcional; cada entrada tem jobId, status, videoUrl, errorMessage, type, createdAt e, opcionalmente, requestedAt, retryRequestedAt, completedAt, failedAt, timedOutAt, activeSpeakerDetectionEnabled, isRetried. Os horários de sincronização labial são armazenados como strings ISO. |
data.works[].versions[].dynamicSubtitles | Objeto opcional com used, inProgress, magicZooms, magicBrolls, magicBrollsPercentage, videoUrl, errorMessage e, opcionalmente, removeSilencePace, removeBadTakes, templateName, requestedAt, rerunCount. requestedAt está em milissegundos Unix. |
data.works[].versions[].publicationAttempts | Array opcional de tentativas públicas de publicação: id, status, origin, além dos opcionais scheduledAt, processingStartedAt, publishedAt, failedAt, privacyStatus, url, videoId, errorMessage. |
data.works[].versions[].publishedVideos | Array opcional com type, videoId, privacyStatus e, opcionalmente, url, datePublished, origin, scheduledAt, plannedPublicationId. |
Notas da operação
- Isso retorna trabalhos de idioma, não segmentos da transcrição. Use transcripts_get para exportar o texto original ou traduzido.
- Cada array versions usa a mesma projeção pública de versão traduzida de projects_get.translations.
- As falhas salvas retornam códigos de erro da VoiceCheap e mensagens fixas. Use o código e o estado atual do recurso para decidir como se recuperar.
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
| Status HTTP | Código | Significado ou recuperação |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Foram fornecidas credenciais em um parâmetro de consulta access_token ou api_key. Envie as credenciais nos cabeçalhos. |
| 400 | VALIDATION_ERROR | Corrija a entrada usando o esquema. Valores inválidos ou inconsistentes são rejeitados antes da execução. |
| 401 | API_KEY_EXPIRED | A chave de API expirou. |
| 401 | INVALID_API_KEY | Forneça uma chave de API válida e dentro do prazo de validade. |
| 401 | INVALID_CREDENTIAL | O cabeçalho Authorization está malformado ou entra em conflito com x-api-key. |
| 401 | MISSING_CREDENTIAL | Nenhuma credencial utilizável foi fornecida no cabeçalho, ou ela excedeu 4096 caracteres. |
| 401 | USER_NOT_FOUND | A conta da credencial não existe mais. |
| 403 | AMBIGUOUS_TEAM_API_KEY | O usuário da credencial pertence a mais de uma equipe, portanto o contexto de cobrança é ambíguo. |
| 403 | FORBIDDEN | O autor autenticado da ação não pode acessar este projeto. |
| 403 | INSUFFICIENT_SCOPE | Conceda todas as permissões necessárias ou escolha outra credencial. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Não foi possível verificar os limites de integração da conta. |
| 403 | SUBSCRIPTION_REQUIRED | Use uma assinatura paga ativa. |
| 403 | TEAM_OWNER_NOT_FOUND | Não foi possível encontrar a conta efetiva do proprietário da equipe. |
| 404 | PROJECT_NOT_FOUND | O projeto não existe na conta acessível. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Aguarde a renovação do limite mensal ou mude de plano. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Aguarde o prazo de Retry-After, quando presente, e aumente progressivamente o intervalo entre as tentativas. |
| 500 | INTERNAL_ERROR | Verifique o estado da requisição salva e o histórico do recurso antes de decidir repetir uma alteração. |
| 503 | SERVER_RESTARTING | O servidor está reiniciando. Tente novamente em breve e mantenha o mesmo identificador de requisição para uma alteração. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["projects:read"]
}
}
Esta página foi útil?

