> ## 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 uma ação de segmento na fila > Cancele sua ação de segmento pendente. Uma ação que já está em execução não pode ser cancelada. Cancele sua ação de segmento pendente. Uma ação que já está em execução não pode ser cancelada. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/segment_actions_cancel ``` ## 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: `translations: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 Valor de texto. Comprimento mínimo: 1. Comprimento máximo: 200. Padrão: `^[^/\\]+$`. 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)$`. 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 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": { "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^/\\\\]+$" }, "jobId": { "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)$" }, "requestId": { "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}$", "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries." } }, "required": ["projectId", "jobId"], "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/segment_actions_cancel' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"projectId":"project_launch_2026","jobId":"41321bda-e243-4b6f-96a4-622cd047c991","requestId":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"}' ``` ```javascript JavaScript theme={null} const input = { projectId: 'project_launch_2026', jobId: '41321bda-e243-4b6f-96a4-622cd047c991', requestId: 'c6d1fec6-bf7d-40aa-91e7-e4b0676d6020', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_cancel', { 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/segment_actions_cancel", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"projectId": "project_launch_2026", "jobId": "41321bda-e243-4b6f-96a4-622cd047c991", "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"}, 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 completo e atualizado da fila após cancelar uma ação que ainda estava na fila. ```json HTTP 200 theme={null} { "data": { "projectId": "project_launch_2026", "revision": 2, "items": [ { "id": "41321bda-e243-4b6f-96a4-622cd047c991", "action": { "type": "text", "segmentIndex": 0, "source": "original" }, "status": "cancelled", "createdAt": 1792152000000, "finishedAt": 1792152002000 } ] }, "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020", "operation": "segment_actions_cancel", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020", "operation": "segment_actions_cancel", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020" } ``` ## Campos do resultado | Campo | Descrição | | - | - | | `data.projectId` | Identificador do projeto pai. | | `data.revision` | Revisão do retrato da fila. É independente de projects\_get.segmentStructureRevision. | | `data.items` | Progresso das ações do projeto: identificadores de tarefas, metadados das ações, estado, carimbos de data/hora e errorCode público opcional. | | `data.items[].id` | Identificador da tarefa; é igual ao requestId original do envio à fila. | | `data.items[].action` | Apenas metadados da ação: type, segmentIndex e, opcionalmente, workId, translatedVersionId e source. O texto enviado, os valores de tempo e as instruções de regeneração não são retornados. | | `data.items[].status` | queued, running, completed, failed ou cancelled. | | `data.items[].createdAt` | Horário de criação do item da fila em milissegundos Unix. | | `data.items[].startedAt` | Horário inicial opcional em milissegundos Unix. | | `data.items[].finishedAt` | Horário final opcional em milissegundos Unix. | | `data.items[].errorCode` | Código de falha público opcional. Falhas não classificadas usam ACTION\_FAILED. | | `data.items[].seenAt` | Horário opcional de confirmação apenas para o visualizador autenticado. | ## 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":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020","operation":"segment_actions_cancel"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020", "operation": "segment_actions_cancel", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "projectId": "project_launch_2026", "revision": 2, "items": [ { "id": "41321bda-e243-4b6f-96a4-622cd047c991", "action": { "type": "text", "segmentIndex": 0, "source": "original" }, "status": "cancelled", "createdAt": 1792152000000, "finishedAt": 1792152002000 } ] } } } ``` ## Notas da operação * jobId identifica o item da fila a cancelar; requestId é um UUID v4 estável separado para a requisição de cancelamento. * Somente um item queued pode se tornar cancelled. Itens running, completed e failed não podem ser cancelados. Cancelar um item já cancelled retorna o estado atual. * O processador retorna projectId, revision e items diretamente; não há booleano success nem campo queue aninhado. * Um cancelamento não reembolsa gerações concluídas nem interrompe o processamento de mídia já em execução. * As respostas da fila, incluindo envio, cancelamento, consulta e repetição, contêm apenas metadados das ações. Leia o conteúdo da transcrição com transcripts\_get e a permissão necessária transcription:read. ## 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` | Forneça um requestId ou Idempotency-Key no formato UUID v4. | | 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 | `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 | `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 | `NOT_FOUND` | Nenhum item da fila com este jobId existe no projeto. | | 404 | `PROJECT_NOT_FOUND` | O projeto não existe na conta acessível. | | 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 | `CONFLICT` | Somente ações em espera podem ser canceladas; o item já começou ou terminou. | | 409 | `IDEMPOTENCY_CONFLICT` | Reutilize um identificador apenas com a mesma operação e os mesmos argumentos. | | 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 | `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": ["translations:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.