Arquivos e lotes

Cancelar Lote

Cancela um trabalho de lote em fila ou em execução.

POST
/v1/batches/{batch_id}/cancel

Solicite o cancelamento de um lote na fila ou em execução. A resposta contém o estado atual: o cancelamento pode estar em andamento ou já ter terminado. Um lote já encerrado mantém seu estado final. Se o estado retornado não for final, consulte o lote novamente para verificar o resultado.

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
Identificador para chamadas seguintes e suporte.
statusstring
Estado atual do lote. Uma solicitação de cancelamento bem-sucedida nem sempre retorna 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