Arquivos e lotes

Listar Lotes de Mensagens

Lista os Lotes de Mensagens que sua organização criou.

GET
/v1/messages/batches

Visão geral

Retorna os Lotes de Mensagens que sua organização criou através desta API, do mais recente para o mais antigo. A lista mostra o status que o TokenLab registrou por último para cada lote. Para verificar um lote agora, recupere-o.

Notas

  • limit é de 1 a 1000 e o padrão é 20.
  • Para paginar, passe after_id (lotes mais antigos) ou before_id (lotes mais recentes) com um ID de lote da lista. Não envie ambos. O TokenLab retorna 400 para um ID desconhecido ou para qualquer outro parâmetro de consulta.
  • Lotes excluídos não são listados.
  • has_more é true quando há mais lotes a seguir.

Exemplo

Requisição

cURL
curl -X GET "https://api.tokenlab.sh/v1/messages/batches?limit=20" \
  -H "x-api-key: sk-your-api-key" \
  -H "anthropic-version: 2023-06-01"

Exemplo de resposta

Resposta

200 OK
{
  "data": [
    {
      "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"
    }
  ],
  "first_id": "msgbatch_01ABC123",
  "last_id": "msgbatch_01ABC123",
  "has_more": false
}

Campos importantes

dataarray
Lotes de mensagens, do mais recente para o mais antigo.
first_idstring|null
ID do primeiro lote em data.
last_idstring|null
ID do último lote em data.
has_moreboolean
Mais lotes estão disponíveis quando has_more é true.

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 consulta

before_id?string

Retorna batches antes deste ID de batch. Não pode ser combinado com after_id.

after_id?string

Retorna batches após deste ID de batch. Não pode ser combinado com before_id.

limit?integer

Número máximo de lotes a retornar

Intervalo1 <= value <= 1000
padrão20

Resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json