curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_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/segment_actions_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/segment_actions_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",
"revision": 3,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "completed",
"createdAt": 1792152000000,
"startedAt": 1792152001000,
"finishedAt": 1792152002000
}
]
}
}
Transcrições e edição
Consultar ações de segmentos na fila
Consulte ações de edição ou regeneração de segmentos de um projeto que estão na fila, em execução ou concluídas.
POST
/
v1
/
actions
/
segment_actions_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_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/segment_actions_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/segment_actions_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",
"revision": 3,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "completed",
"createdAt": 1792152000000,
"startedAt": 1792152001000,
"finishedAt": 1792152002000
}
]
}
}
Consulte ações de edição ou regeneração de segmentos de um projeto que estão na fila, em execução ou concluídas.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/segment_actions_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/segment_actions_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/segment_actions_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/segment_actions_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 a revisão atual da fila do projeto e os itens públicos de ação queued, running e em estado terminal.{
"data": {
"projectId": "project_launch_2026",
"revision": 3,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "completed",
"createdAt": 1792152000000,
"startedAt": 1792152001000,
"finishedAt": 1792152002000
}
]
}
}
Campos do resultado
| Campo | Descrição |
|---|---|
data.projectId | Identificador do projeto pai. |
data.revision | Revisão do retrato da fila. É independente de projects_get.segmentStructureRevision. |
data.items | Progresso das ações do projeto: identificadores de tarefas, metadados das ações, estado, carimbos de data/hora e errorCode público opcional. |
data.items[].id | Identificador da tarefa; é igual ao requestId original do envio à fila. |
data.items[].action | Apenas metadados da ação: type, segmentIndex e, opcionalmente, workId, translatedVersionId e source. O texto enviado, os valores de tempo e as instruções de regeneração não são retornados. |
data.items[].status | queued, running, completed, failed ou cancelled. |
data.items[].createdAt | Horário de criação do item da fila em milissegundos Unix. |
data.items[].startedAt | Horário inicial opcional em milissegundos Unix. |
data.items[].finishedAt | Horário final opcional em milissegundos Unix. |
data.items[].errorCode | Código de falha público opcional. Falhas não classificadas usam ACTION_FAILED. |
data.items[].seenAt | Horário opcional de confirmação apenas para o visualizador autenticado. |
Notas da operação
- Consulte periodicamente items[].id correspondente ao jobId retornado por segments_text_update, segments_timestamps_update ou segments_regenerate. completed, failed e cancelled são estados terminais.
- revision é a revisão da fila, não a segmentStructureRevision de origem exigida para exclusão ou mesclagem.
- Uma ação pode retornar um envio bem-sucedido e falhar posteriormente na fila. Inspecione items[].errorCode; atualize o estado do projeto, da transcrição e da saída afetados antes de decidir sobre uma nova ação.
- Esta operação não tem entrada de paginação. Um projeto sem fila retorna projectId, revision 0 e um array items vazio.
- As respostas da fila, incluindo envio, cancelamento, consulta e repetição, contêm apenas metadados das ações. Leia o conteúdo da transcrição com transcripts_get e a permissão necessária transcription:read.
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?

