> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Cancelar um envio de imagem de referência > Cancele um envio inacabado de imagem de referência pertencente à conta conectada. Cancele um envio inacabado de imagem de referência pertencente à conta conectada. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/images_upload_abort ``` ## Autenticação e permissões 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. Permissões necessárias: `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 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}$`. 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)$`. 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. ```json theme={null} { "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." } }, "required": ["uploadId"], "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. ```bash cURL theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_abort' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"25b1b11e-ef87-44b0-aee1-c5411141c42f","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a"}' ``` ```javascript JavaScript theme={null} const input = { requestId: '25b1b11e-ef87-44b0-aee1-c5411141c42f', uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_abort', { 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); ``` ```python Python theme={null} import os import requests response = requests.post( "https://api.voicecheap.ai/v1/actions/images_upload_abort", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a"}, 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. success: true quando o envio multipart não concluído foi abortado ou quando não existe uma sessão ativa para esse uploadId. ```json HTTP 200 theme={null} { "data": { "success": true }, "requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f", "operation": "images_upload_abort", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f", "operation": "images_upload_abort", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f" } ``` ## Campos do resultado | Campo | Descrição | | - | - | | `data.success` | Sempre true após um aborto bem-sucedido ou quando não existe sessão ativa. | ## 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. ```bash theme={null} 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":"25b1b11e-ef87-44b0-aee1-c5411141c42f","operation":"images_upload_abort"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f", "operation": "images_upload_abort", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "success": true } } } ``` ## Notas da operação * Requer images:write; nenhum escopo adicional de upload é necessário. * uploadId deve ser um UUID. Um envio ativo pertencente ao usuário conectado é abortado, e sua sessão é removida. Uma sessão desconhecida, expirada, já abortada ou concluída retorna success: true. * Esta ação cancela um upload multipart inacabado. Após a conclusão remover sua sessão, abortar não exclui o arquivo de referência concluído. * 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. * 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. * Abortar uma sessão pertencente a outro usuário é proibido enquanto ela está ativa. Esta ação não retorna uma chave de arquivo nem um prazo de expiração. ## 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 | `UPLOAD_TYPE_NOT_ALLOWED` | A sessão de envio ativa 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 ativa 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. | | 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 upload ativa. Tente novamente com o mesmo identificador de mutaçã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. | ```json theme={null} { "code": "INSUFFICIENT_SCOPE", "message": "This credential does not permit the requested action.", "status": 403, "details": { "requiredScopes": ["images:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.