curl --request POST 'https://api.voicecheap.ai/v1/actions/publishing_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/publishing_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/publishing_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",
"originalPublish": {
"id": "7db6b953-7664-4bc2-811a-6aa7aa29038d",
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"title": "Product launch",
"description": "Meet the new product.",
"status": "completed",
"useDynamicSubtitles": false,
"createdAt": 1792152000000,
"updatedAt": 1792152060000,
"channels": [
{
"channelId": "UC1234567890abcdefghijkl",
"platform": "youtube",
"status": "completed",
"videoId": "example1234",
"videoUrl": "https://www.youtube.com/watch?v=example1234"
}
]
},
"translations": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"targetLanguage": "english",
"attempts": [],
"publishedVideos": []
}
],
"scheduled": [
{
"id": "9c186772-fdba-4da7-9f37-b860e319a754",
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"platform": "youtube",
"status": "scheduled",
"scheduledAt": 1918375200000,
"title": "English product launch"
}
]
}
}
Publicação
Consultar o estado de publicação de um projeto
Consulte o progresso da publicação original, as tentativas de publicação traduzida e as publicações agendadas de um projeto acessível.
POST
/
v1
/
actions
/
publishing_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/publishing_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/publishing_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/publishing_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",
"originalPublish": {
"id": "7db6b953-7664-4bc2-811a-6aa7aa29038d",
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"title": "Product launch",
"description": "Meet the new product.",
"status": "completed",
"useDynamicSubtitles": false,
"createdAt": 1792152000000,
"updatedAt": 1792152060000,
"channels": [
{
"channelId": "UC1234567890abcdefghijkl",
"platform": "youtube",
"status": "completed",
"videoId": "example1234",
"videoUrl": "https://www.youtube.com/watch?v=example1234"
}
]
},
"translations": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"targetLanguage": "english",
"attempts": [],
"publishedVideos": []
}
],
"scheduled": [
{
"id": "9c186772-fdba-4da7-9f37-b860e319a754",
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"platform": "youtube",
"status": "scheduled",
"scheduledAt": 1918375200000,
"title": "English product launch"
}
]
}
}
Consulte o progresso da publicação original, as tentativas de publicação traduzida e as publicações agendadas de um projeto acessível.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/publishing_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.
publishing: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/publishing_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/publishing_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/publishing_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 o estado de publicação original do projeto, as tentativas públicas de publicação traduzida e as publicações agendadas pelo ator para esse projeto.{
"data": {
"projectId": "project_launch_2026",
"originalPublish": {
"id": "7db6b953-7664-4bc2-811a-6aa7aa29038d",
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"title": "Product launch",
"description": "Meet the new product.",
"status": "completed",
"useDynamicSubtitles": false,
"createdAt": 1792152000000,
"updatedAt": 1792152060000,
"channels": [
{
"channelId": "UC1234567890abcdefghijkl",
"platform": "youtube",
"status": "completed",
"videoId": "example1234",
"videoUrl": "https://www.youtube.com/watch?v=example1234"
}
]
},
"translations": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"targetLanguage": "english",
"attempts": [],
"publishedVideos": []
}
],
"scheduled": [
{
"id": "9c186772-fdba-4da7-9f37-b860e319a754",
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"platform": "youtube",
"status": "scheduled",
"scheduledAt": 1918375200000,
"title": "English product launch"
}
]
}
}
Campos do resultado
| Campo | Descrição |
|---|---|
data.projectId | Identificador do projeto pai. |
data.originalPublish | Estado público da publicação do original, ou null quando o projeto não tem nenhum. |
data.translations | Uma entrada por versão traduzida com workId, translatedVersionId, targetLanguage, attempts e publishedVideos. Listas vazias de tentativas e publicações são retornadas como []. |
data.translations[].attempts | 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.translations[].publishedVideos | Array opcional com type, videoId, privacyStatus e, opcionalmente, url, datePublished, origin, scheduledAt, plannedPublicationId. |
data.scheduled | Registros de publicação agendada pertencentes ao usuário executor autenticado e a este projeto. Incluem id, workId e translatedVersionId opcionais, platform, status, scheduledAt, title e publishedVideoUrl opcional. |
data.scheduled[].scheduledAt | Horário agendado em milissegundos Unix. |
data.originalPublish.id | Identificador da tentativa de publicação do original. |
data.originalPublish.workId | Identificador opcional do trabalho de idioma usado pelo fluxo original de publicação. |
data.originalPublish.title | Título da publicação. |
data.originalPublish.description | Descrição opcional. |
data.originalPublish.status | idle, scheduled, in-progress, completed ou failed. |
data.originalPublish.useDynamicSubtitles | Indica se o fluxo original de publicação solicitou legendas dinâmicas. |
data.originalPublish.dynamicSubtitlesVideoUrl | URL opcional do vídeo legendado gerado. |
data.originalPublish.scheduledAt | Horário agendado opcional em milissegundos Unix. |
data.originalPublish.createdAt | Horário de criação em milissegundos Unix. |
data.originalPublish.updatedAt | Horário da atualização mais recente em milissegundos Unix. |
data.originalPublish.channels | Estado por canal com channelId, platform, status e, opcionalmente, videoId, videoUrl, scheduledAt. |
Notas da operação
- originalPublish é null quando o projeto não tem estado de publicação original. Sua projeção exclui a contabilização de créditos armazenada, a autenticação de canais, a configuração de privacidade e as mensagens de erro brutas.
- Cada entrada translations tem arrays attempts e publishedVideos, incluindo [] quando não existem registros.
- scheduled é filtrado por projectId e pelo autor autenticado da ação, não pelo proprietário efetivo da cobrança da equipe.
- Esta é a ação de consulta periódica do estado do recurso após uma ação de publicação concluir sua execução no nível da requisição.
- 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": ["publishing:read"]
}
}
Esta página foi útil?

