curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_complete' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"b7d73225-716b-45ec-ae43-559cfb3b6412","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","parts":[{"partNumber":1,"etag":"\"d41d8cd98f00b204e9800998ecf8427e\""},{"partNumber":2,"etag":"\"0cc175b9c0f1b6a831c399e269772661\""}]}'
const input = {
requestId: 'b7d73225-716b-45ec-ae43-559cfb3b6412',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
parts: [
{
partNumber: 1,
etag: '"d41d8cd98f00b204e9800998ecf8427e"',
},
{
partNumber: 2,
etag: '"0cc175b9c0f1b6a831c399e269772661"',
},
],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_complete', {
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/images_upload_complete",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "parts": [{"partNumber": 1, "etag": "\"d41d8cd98f00b204e9800998ecf8427e\""}, {"partNumber": 2, "etag": "\"0cc175b9c0f1b6a831c399e269772661\""}]},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"fileKey": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"readUrl": "https://media.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
Imagens
Concluir um envio de imagem de referência
Conclua um envio de imagem de referência que lhe pertence usando os números das partes e os ETags das requisições PUT. Verifica o tamanho do arquivo armazenado. Use o fileKey retornado como referência de geração.
POST
/
v1
/
actions
/
images_upload_complete
curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_complete' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"b7d73225-716b-45ec-ae43-559cfb3b6412","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","parts":[{"partNumber":1,"etag":"\"d41d8cd98f00b204e9800998ecf8427e\""},{"partNumber":2,"etag":"\"0cc175b9c0f1b6a831c399e269772661\""}]}'
const input = {
requestId: 'b7d73225-716b-45ec-ae43-559cfb3b6412',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
parts: [
{
partNumber: 1,
etag: '"d41d8cd98f00b204e9800998ecf8427e"',
},
{
partNumber: 2,
etag: '"0cc175b9c0f1b6a831c399e269772661"',
},
],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_complete', {
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/images_upload_complete",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "parts": [{"partNumber": 1, "etag": "\"d41d8cd98f00b204e9800998ecf8427e\""}, {"partNumber": 2, "etag": "\"0cc175b9c0f1b6a831c399e269772661\""}]},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"fileKey": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"readUrl": "https://media.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
Conclua um envio de imagem de referência que lhe pertence usando os números das partes e os ETags das requisições PUT. Verifica o tamanho do arquivo armazenado. Use o fileKey retornado como referência de geração.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/images_upload_complete
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.
images: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
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}$.string
obrigatório
O uploadId retornado pela ação upload_initialize deste domínio.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)$.array
obrigatório
Lista de valores. Consulte o esquema de entrada completo para ver a estrutura dos itens.Mínimo de itens: 1. Máximo de itens: 2.
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": {
"requestId": {
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
"type": "string",
"format": "uuid",
"pattern": "^[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}$"
},
"uploadId": {
"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)$",
"description": "The uploadId returned by this domain’s upload_initialize action."
},
"parts": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"type": "object",
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1,
"maximum": 2
},
"etag": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": ["partNumber", "etag"],
"additionalProperties": false
}
}
},
"required": ["uploadId", "parts"],
"additionalProperties": false
}
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.curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_complete' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"b7d73225-716b-45ec-ae43-559cfb3b6412","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","parts":[{"partNumber":1,"etag":"\"d41d8cd98f00b204e9800998ecf8427e\""},{"partNumber":2,"etag":"\"0cc175b9c0f1b6a831c399e269772661\""}]}'
const input = {
requestId: 'b7d73225-716b-45ec-ae43-559cfb3b6412',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
parts: [
{
partNumber: 1,
etag: '"d41d8cd98f00b204e9800998ecf8427e"',
},
{
partNumber: 2,
etag: '"0cc175b9c0f1b6a831c399e269772661"',
},
],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_complete', {
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/images_upload_complete",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "parts": [{"partNumber": 1, "etag": "\"d41d8cd98f00b204e9800998ecf8427e\""}, {"partNumber": 2, "etag": "\"0cc175b9c0f1b6a831c399e269772661\""}]},
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. A chave de referência concluída pertencente ao usuário e sua URL de leitura, retornadas somente após o tamanho em bytes armazenado corresponder exatamente ao tamanho declarado do arquivo. Use fileKey, não readUrl, nos argumentos de geração.{
"data": {
"fileKey": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"readUrl": "https://media.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
Campos do resultado
| Campo | Descrição |
|---|---|
data.fileKey | Chave de objeto concluído pertencente à conta para usar como referência de geração. |
data.readUrl | URL de leitura do objeto de referência enviado. Ações de geração aceitam fileKey, não esta URL. |
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.curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"b7d73225-716b-45ec-ae43-559cfb3b6412","operation":"images_upload_complete"}'
HTTP 200
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"fileKey": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"readUrl": "https://media.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"
}
}
}
Notas da operação
- Requer images:write; nenhum escopo adicional de upload é necessário.
- uploadId é o UUID de initialize. parts contém exatamente as 1–2 partes exigidas pela sessão. Cada parte tem um partNumber inteiro de 1 a 2 e uma string etag de 1–256 caracteres obtida de sua resposta PUT bem-sucedida.
- Todos os números de partes devem estar presentes e ser únicos. As partes são ordenadas antes da conclusão; ETags são normalizados para valores entre aspas. Você pode manter as aspas do ETag retornadas pelo armazenamento.
- O tamanho real em bytes do objeto concluído é verificado em relação a fileSize e ao limite de 8 MiB. Um tamanho ausente, divergente ou excessivo causa a remoção do objeto e da sessão ativa e retorna UPLOAD_SIZE_MISMATCH.
- Passe fileKey como referenceImageKey em images_generate. Arquivos de referência concluídos podem ser reutilizados em gerações posteriores de imagens ou miniaturas pertencentes ao mesmo usuário; a geração não consome a referência.
- Somente um envio pertencente ao usuário conectado pode ser assinado, concluído ou abortado. Esses aliases aceitam apenas sessões JPG, PNG e WebP de no máximo 8 MiB, mesmo que a sessão tenha sido criada por outra família de envio.
- A sessão de upload de produção expira após 24 horas. As URLs assinadas das partes expiram após uma hora. A conclusão e o aborto removem a sessão ativa; sign-parts e complete passam então a retornar Upload not found. Nenhuma das respostas inclui um campo expiresAt.
- Use um requestId UUID v4 ou o cabeçalho HTTP Idempotency-Key e reutilize-o com entradas idênticas ao tentar novamente. A camada de integração registra cada alteração e retorna seu estado ou resultado registrado sem executá-la novamente. Uma requisição com falha ou interrompida não é repetida automaticamente.
- A conclusão fecha a sessão multipart. Repita a conclusão com o requestId original para recuperar seu resultado registrado; uma nova requisição de conclusão para esse uploadId fechado retorna Upload not found. Esta ação não retorna um prazo de expiração da retenção da referência.
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 | BAD_REQUEST | A lista de conclusão tem números de partes ausentes, duplicados ou inválidos. |
| 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 | IDEMPOTENCY_CONFLICT | O cabeçalho Idempotency-Key e o campo requestId do corpo devem ser iguais. |
| 400 | INVALID_REQUEST_ID | requestId ou Idempotency-Key não é um UUID v4. |
| 400 | UPLOAD_SIZE_MISMATCH | O tamanho armazenado do objeto concluído está indisponível, difere de fileSize ou excede 8 MiB; o objeto e a sessão são removidos. |
| 400 | UPLOAD_TYPE_NOT_ALLOWED | A sessão de upload não é de um tipo de imagem compatível ou excede 8 MiB. |
| 400 | VALIDATION_ERROR | Um argumento está ausente, tem um valor não compatível, excede seu limite ou não faz parte do esquema estrito de entrada. |
| 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 | UNAUTHORIZED | A sessão de upload pertence a outro usuário. |
| 401 | USER_NOT_FOUND | A conta da credencial não existe mais. |
| 403 | ACCOUNT_UNAVAILABLE | A conta que executa a ação ou a conta de cobrança está indisponível ou em processo de exclusão. |
| 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 | 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 | NOT_FOUND | A sessão de upload é desconhecida, expirou, já foi concluída ou foi abortada. |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | Esta conta já tem 10 ações de integração em execução. Consulte uma requisição existente antes de iniciar outra. |
| 409 | IDEMPOTENCY_CONFLICT | O identificador da requisição já foi usado com argumentos diferentes; uma divergência entre o identificador do cabeçalho e o do corpo retorna HTTP 400 com o mesmo código. |
| 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 | ACTION_RESULT_UNAVAILABLE | A ação foi executada, mas não foi possível salvar seu resultado. Inspecione o estado salvo da requisição e o histórico do recurso antes de iniciar uma nova geração. |
| 503 | INTERNAL_ERROR | Não foi possível ler a sessão de envio ativa. Inspecione o estado da requisição antes de outra tentativa de conclusã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": ["images:write"]
}
}
Esta página foi útil?