Arquivos e lotes

Cancelar Lote de Mensagens

Cancela um Lote de Mensagens que ainda está em processamento.

POST
/v1/messages/batches/{message_batch_id}/cancel

Visão geral

Solicite o cancelamento de um Lote de Mensagens que ainda está em processamento. A resposta mostra o estado atual. O processing_status geralmente é canceling, e as solicitações que já estão em execução ainda podem ser concluídas. Um lote que já foi encerrado é retornado inalterado.

Notas

  • Após cancelar, recupere o lote até que o processing_status seja ended. As solicitações que não haviam iniciado terminam como canceled.
  • Um lote que não existe ou foi excluído retorna 404. Um lote que ainda não está pronto para ser alterado retorna 409; tente novamente mais tarde.
  • O cancelamento não exclui o lote. Para removê-lo, exclua-o após ele ter sido encerrado.

Exemplo

Requisição

cURL
curl -X POST "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/cancel" \
  -H "x-api-key: sk-your-api-key" \
  -H "anthropic-version: 2023-06-01"

Exemplo de resposta

Resposta

200 OK
{
  "id": "msgbatch_01ABC123",
  "type": "message_batch",
  "processing_status": "canceling",
  "request_counts": {
    "processing": 1,
    "succeeded": 1,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2026-11-01T10:00:00Z",
  "expires_at": "2026-11-02T10:00:00Z",
  "cancel_initiated_at": "2026-11-01T10:05:00Z",
  "archived_at": null,
  "results_url": null
}

Campos importantes

processing_statusstring
canceling enquanto o cancelamento está em andamento, ended assim que for concluído. Não presuma que toda solicitação de cancelamento retorna canceling.
cancel_initiated_atstring|null
Quando a solicitação de cancelamento foi aceita, ou null.

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

message_batch_id*string

Identificador do lote de mensagens

Resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json