curl --request POST 'https://api.voicecheap.ai/v1/actions/thumbnails_upload_initialize' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"19372a86-ee2f-4c6d-835b-ec1b10b7c68b","filename":"reference.png","contentType":"image/png","fileSize":7340032}'
const input = {
requestId: '19372a86-ee2f-4c6d-835b-ec1b10b7c68b',
filename: 'reference.png',
contentType: 'image/png',
fileSize: 7340032,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/thumbnails_upload_initialize', {
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/thumbnails_upload_initialize",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b", "filename": "reference.png", "contentType": "image/png", "fileSize": 7340032},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a",
"key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"partSize": 5242880,
"maxConcurrency": 4
},
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b"
}
{
"data": {
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b",
"operation": "thumbnails_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b"
}
{
"data": {
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b",
"operation": "thumbnails_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b"
}
Miniaturas
Iniciar um envio de referência de miniatura
Prepare o envio de uma referência JPG, PNG ou WebP de até 8 MiB. Use thumbnails_upload_sign_parts para obter as URLs PUT, envie os bytes e chame thumbnails_upload_complete; use o fileKey retornado na geração.
POST
/
v1
/
actions
/
thumbnails_upload_initialize
curl --request POST 'https://api.voicecheap.ai/v1/actions/thumbnails_upload_initialize' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"19372a86-ee2f-4c6d-835b-ec1b10b7c68b","filename":"reference.png","contentType":"image/png","fileSize":7340032}'
const input = {
requestId: '19372a86-ee2f-4c6d-835b-ec1b10b7c68b',
filename: 'reference.png',
contentType: 'image/png',
fileSize: 7340032,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/thumbnails_upload_initialize', {
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/thumbnails_upload_initialize",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b", "filename": "reference.png", "contentType": "image/png", "fileSize": 7340032},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a",
"key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"partSize": 5242880,
"maxConcurrency": 4
},
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b"
}
{
"data": {
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b",
"operation": "thumbnails_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b"
}
{
"data": {
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b",
"operation": "thumbnails_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b"
}
Prepare o envio de uma referência JPG, PNG ou WebP de até 8 MiB. Use thumbnails_upload_sign_parts para obter as URLs PUT, envie os bytes e chame thumbnails_upload_complete; use o fileKey retornado na geração.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/thumbnails_upload_initialize
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.
thumbnails: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 nome do arquivo da imagem, com uma extensão correspondente a contentType.Comprimento mínimo: 1. Comprimento máximo: 250. Padrão:
\.(?:jpe?g|png|webp)$.string
obrigatório
Valor de texto.Valores aceitos: “image/jpeg”, “image/png”, “image/webp”.
integer
obrigatório
Tamanho exato do arquivo em bytes, até 8 MiB.Mínimo: 1. Máximo: 8388608.
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}$"
},
"filename": {
"type": "string",
"minLength": 1,
"maxLength": 250,
"pattern": "\\.(?:jpe?g|png|webp)$",
"description": "The image filename, with an extension matching contentType."
},
"contentType": {
"type": "string",
"enum": ["image/jpeg", "image/png", "image/webp"]
},
"fileSize": {
"type": "integer",
"minimum": 1,
"maximum": 8388608,
"description": "Exact file size in bytes, up to 8 MiB."
}
},
"required": ["filename", "contentType", "fileSize"],
"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/thumbnails_upload_initialize' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"19372a86-ee2f-4c6d-835b-ec1b10b7c68b","filename":"reference.png","contentType":"image/png","fileSize":7340032}'
const input = {
requestId: '19372a86-ee2f-4c6d-835b-ec1b10b7c68b',
filename: 'reference.png',
contentType: 'image/png',
fileSize: 7340032,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/thumbnails_upload_initialize', {
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/thumbnails_upload_initialize",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b", "filename": "reference.png", "contentType": "image/png", "fileSize": 7340032},
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 nova sessão de upload de referência de imagem em várias partes, a futura chave do objeto, o tamanho da parte em bytes e o número máximo de uploads paralelos. Isso não envia bytes de imagem nem torna key pronta para geração.{
"data": {
"uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a",
"key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"partSize": 5242880,
"maxConcurrency": 4
},
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b"
}
{
"data": {
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b",
"operation": "thumbnails_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b"
}
{
"data": {
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b",
"operation": "thumbnails_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b"
}
Campos do resultado
| Campo | Descrição |
|---|---|
data.uploadId | UUID que identifica a sessão de upload ativa. Passe-o às demais ações de upload. |
data.key | Chave de objeto futura pertencente ao usuário. Use fileKey de uma conclusão bem-sucedida como referência de geração. |
data.partSize | Tamanho obrigatório de cada parte em bytes, exceto a parte final, que contém os bytes restantes. |
data.maxConcurrency | Número máximo sugerido de envios paralelos de partes: 4. |
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":"19372a86-ee2f-4c6d-835b-ec1b10b7c68b","operation":"thumbnails_upload_initialize"}'
HTTP 200
{
"data": {
"requestId": "19372a86-ee2f-4c6d-835b-ec1b10b7c68b",
"operation": "thumbnails_upload_initialize",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a",
"key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"partSize": 5242880,
"maxConcurrency": 4
}
}
}
Notas da operação
- Requer thumbnails:write; nenhum escopo adicional de envio é necessário.
- Os espaços nas extremidades de filename são removidos; ele deve conter 1–250 caracteres e terminar em .jpg, .jpeg, .png ou .webp. Sua extensão deve corresponder a contentType: image/jpeg, image/png ou image/webp. fileSize é o número inteiro exato de bytes, de 1 a 8,388,608.
- A implementação compartilhada de upload retorna partSize de 5 MiB (5,242,880 bytes) para essas referências. Um arquivo de até 5 MiB usa uma parte; um arquivo maior, de até 8 MiB, usa duas. Solicite URLs PUT com thumbnails_upload_sign_parts, envie os bytes e chame thumbnails_upload_complete.
- Use o fileKey retornado pela conclusão como uma entrada de referenceImageKeys em thumbnails_generate. O resultado da inicialização usa key, não fileKey. Não passe key para a geração antes da conclusão.
- 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.
- Esta ação usa as criações e os envios do próprio usuário conectado, inclusive quando a credencial está conectada em um contexto de equipe.
- 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.
- O nome do arquivo na chave do objeto é sanitizado e pode ser encurtado. Mantenha a chave e o uploadId exatos retornados; não os construa por conta própria. Os bytes da imagem são validados durante a geração, além do tamanho e do tipo declarados durante o upload.
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 | 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 | REFERENCE_IMAGE_INVALID | A extensão do nome do arquivo não corresponde ao contentType de imagem declarado. |
| 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 | 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. |
| 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 criar ou salvar a sessão de envio. Tente novamente com o mesmo identificador de alteração e inspecione seu estado registrado. |
| 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": ["thumbnails:write"]
}
}
Esta página foi útil?

