curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_result_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"limit":30}'
const input = {
limit: 30,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_result_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/subtitles_result_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"limit": 30},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"items": [
{
"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
"operation": "captions_transcribe",
"createdAt": 1792152000000,
"fileName": "voicecheap-captions_transcribe-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
"byteLength": 190,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "subtitles_result_get",
"downloadAction": "subtitles_result_download",
"listAction": "subtitles_result_list"
},
{
"resultId": "a12bc34d-5e67-4890-8abc-0123456789de",
"operation": "subtitles_create",
"createdAt": 1792152000000,
"fileName": "voicecheap-subtitles_create-a12bc34d-5e67-4890-8abc-0123456789de.json",
"byteLength": 411,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "subtitles_result_get",
"downloadAction": "subtitles_result_download",
"listAction": "subtitles_result_list"
}
],
"nextCursor": null
}
}
Legendas
Listar resultados salvos de ações de legendas
Liste suas saídas de integração salvas, incluindo resultados grandes que não cabem nas respostas de consulta de ações. Use nextCursor como beforeResultId.
POST
/
v1
/
actions
/
subtitles_result_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_result_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"limit":30}'
const input = {
limit: 30,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_result_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/subtitles_result_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"limit": 30},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"items": [
{
"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
"operation": "captions_transcribe",
"createdAt": 1792152000000,
"fileName": "voicecheap-captions_transcribe-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
"byteLength": 190,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "subtitles_result_get",
"downloadAction": "subtitles_result_download",
"listAction": "subtitles_result_list"
},
{
"resultId": "a12bc34d-5e67-4890-8abc-0123456789de",
"operation": "subtitles_create",
"createdAt": 1792152000000,
"fileName": "voicecheap-subtitles_create-a12bc34d-5e67-4890-8abc-0123456789de.json",
"byteLength": 411,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "subtitles_result_get",
"downloadAction": "subtitles_result_download",
"listAction": "subtitles_result_list"
}
],
"nextCursor": null
}
}
Liste suas saídas de integração salvas, incluindo resultados grandes que não cabem nas respostas de consulta de ações. Use nextCursor como beforeResultId.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/subtitles_result_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.
subtitles: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
integer
Valor inteiro.Mínimo: 1. Máximo: 100. Valor padrão: 30.
string
Valor de texto.Formato: “uuid”. Padrão:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.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": {
"limit": {
"default": 30,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"beforeResultId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"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/subtitles_result_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"limit":30}'
const input = {
limit: 30,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_result_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/subtitles_result_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"limit": 30},
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. Uma lista paginada de metadados de resultados de integração pertencentes ao usuário. Cada item fornece as operações necessárias para recuperar a saída completa.{
"data": {
"items": [
{
"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
"operation": "captions_transcribe",
"createdAt": 1792152000000,
"fileName": "voicecheap-captions_transcribe-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
"byteLength": 190,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "subtitles_result_get",
"downloadAction": "subtitles_result_download",
"listAction": "subtitles_result_list"
},
{
"resultId": "a12bc34d-5e67-4890-8abc-0123456789de",
"operation": "subtitles_create",
"createdAt": 1792152000000,
"fileName": "voicecheap-subtitles_create-a12bc34d-5e67-4890-8abc-0123456789de.json",
"byteLength": 411,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "subtitles_result_get",
"downloadAction": "subtitles_result_download",
"listAction": "subtitles_result_list"
}
],
"nextCursor": null
}
}
Campos do resultado
| Campo | Descrição |
|---|---|
data.items | Objetos de metadados de saídas salvas deste domínio, incluindo resultId, operation, timestamps, metadados de arquivo, status e ações de recuperação. |
data.nextCursor | Último resultId quando existe outra página; caso contrário, null. |
Notas da operação
- Requer uma assinatura paga e a permissão da ação. O plano pessoal de ferramentas do usuário executor é verificado novamente na execução; as ferramentas salvas e as referências de envio pertencem a esse usuário, inclusive quando a credencial está associada a uma equipe.
- Uma ação bem-sucedida usa uma chamada mensal compartilhada de API/MCP. Beginner permite 500, Starter 5,000 e Creator 25,000 chamadas/mês; Pro, Scale e Enterprise não têm teto mensal. Os limites por minuto ainda se aplicam: 30, 60, 120, 180, 300 e 600, respectivamente. As cotas de geração das ferramentas são separadas.
- resultId é um UUID de uma referência de geração concluída ou do result_list deste domínio. Ele é diferente do requestId da ação e do historyId da ferramenta da web.
- Os resultados pertencem ao ator autenticado e ao domínio de permissão. Um resultado de subtitles não pode ser lido por ações de transcription, ou vice-versa.
- O JSON completo salvo é criptografado em repouso e mantido independentemente do cache limitado de consultas periódicas da ação. A recuperação continua autenticada; nenhuma URL pública de JSON de transcrição ou legendas é emitida.
- Estas ações recuperam saídas existentes e não geram mídia nem usam uma cota diária. Cada recuperação bem-sucedida ainda usa uma chamada mensal de integração.
- Metadados pending significam que a persistência da saída precisa de recuperação. Ler o conteúdo ou baixá-lo tenta recuperar um objeto criptografado já salvo; verifique-o antes de iniciar outra geração.
- limit tem 30 como padrão e aceita de 1 a 100. Os resultados são ordenados por createdAt em ordem decrescente. Passe nextCursor como beforeResultId para recuperar a próxima página; null indica o fim.
- Os itens incluem metadados pending e completed. Uma entrada da lista não contém texto gerado, palavras das legendas, chave de armazenamento nem material de criptografia.
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 | Os argumentos não atendem ao esquema da ação ou um argumento desconhecido foi fornecido. |
| 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 | INSUFFICIENT_SCOPE | A chave de API ou a conexão MCP não tem a permissão necessária para a ação. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Não foi possível verificar os limites de integração da conta. |
| 403 | PAID_SUBSCRIPTION_REQUIRED | O ator autenticado não tem mais uma assinatura paga quando esta ação da ferramenta é executada. |
| 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 | TOOL_RESULT_NOT_FOUND | beforeResultId não é um cursor pertencente ao usuário executor neste domínio de permissões. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | As chamadas usadas e pendentes atingiram a cota mensal compartilhada de API/MCP. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | A conta atingiu seu limite de integração por minuto; inspecione retryAfterSeconds. |
| 500 | INTERNAL_ERROR | Não foi possível listar os metadados dos resultados salvos. |
| 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": ["subtitles:read"]
}
}
Esta página foi útil?

