Arquivos e lotes

Excluir Lote de Mensagens

Exclui um Lote de Mensagens que foi finalizado.

DELETE
/v1/messages/batches/{message_batch_id}

Visão geral

Exclua um Lote de Mensagens que foi finalizado. Após a exclusão, o lote não aparece mais na lista, e seu status e resultados não ficam mais disponíveis (404).

Notas

  • Exclua apenas após o lote ter sido finalizado e o TokenLab ter processado seu uso. Antes disso, a solicitação retorna 409 com o tipo de erro conflict_error. Cancele um lote que ainda esteja em processamento, aguarde até que ele termine e, em seguida, exclua-o.
  • A exclusão não altera o valor que foi cobrado.
  • Baixe os resultados antes de excluir o lote.

Exemplo

Requisição

cURL
curl -X DELETE "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123" \
  -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_deleted"
}

Campos importantes

idstring
ID do lote excluído.
typestring
Sempre message_batch_deleted.

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

application/json