Arquivos e lotes

Cancelar Batch

Cancele um batch que não foi finalizado.

POST
/v1/batches/{batch_id}/cancel

Solicite o cancelamento de um batch na fila ou em execução. A resposta contém seu status atual: o cancelamento ainda pode estar em andamento ou já ter sido concluído. Um batch que já foi finalizado mantém seu status terminal existente. Se o status retornado não for terminal, recupere o batch novamente para verificar o resultado. Um ID de batch desconhecido retorna 404 batch_not_found.

Requisição

cURL
curl -X POST "https://api.tokenlab.sh/v1/batches/batch_abc123/cancel" \
  -H "Authorization: Bearer sk-your-api-key"

Resposta

200 OK
{
  "id": "batch_abc123",
  "object": "batch",
  "status": "cancelling",
  "input_file_id": "file_abc123"
}
idstring
ID do batch.
statusstring
Status atual do batch. Não presuma que toda solicitação de cancelamento bem-sucedida retorne cancelling.

Autorização

BearerAuth
AuthorizationBearer <token>

Autenticação por Chave de API. Crie ou gerencie chaves de API em Dashboard > API > API Keys.

Local: header

Parâmetros de caminho

batch_id*string

Resposta

application/json

application/json

application/json