Arquivos e lotes
Recuperar Lote de Mensagens
Recupera o status e as contagens de solicitações de um Lote de Mensagens.
Visão geral
Retorna o status, as contagens de solicitações e os registros de data e hora de um Lote de Mensagens que sua organização criou. Consulte este endpoint até que processing_status seja ended, então obtenha os resultados.
Notas
processing_statuspode serin_progress,cancelingouended.results_urlénullaté que o lote tenha sido finalizado.- Um lote que não existe ou foi excluído retorna
404. Um lote que ainda não está pronto para ser lido pode retornar409; tente novamente mais tarde.
Requisição
curl -X GET "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123" \
-H "x-api-key: sk-your-api-key" \
-H "anthropic-version: 2023-06-01"Resposta
{
"id": "msgbatch_01ABC123",
"type": "message_batch",
"processing_status": "ended",
"request_counts": {
"processing": 0,
"succeeded": 2,
"errored": 0,
"canceled": 0,
"expired": 0
},
"ended_at": "2026-11-01T10:20:00Z",
"created_at": "2026-11-01T10:00:00Z",
"expires_at": "2026-11-02T10:00:00Z",
"cancel_initiated_at": null,
"archived_at": null,
"results_url": "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/results"
}Campos importantes
processing_statusstring
in_progress, canceling ou ended.request_countsobject
Número de solicitações que estão em
processing, succeeded, errored, canceled ou expired.ended_atstring|null
Quando o processamento terminou, ou
null.cancel_initiated_atstring|null
Quando uma solicitação de cancelamento foi aceita, ou
null.results_urlstring|null
URL dos resultados, 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