Archivos y lotes

Recuperar lote de mensajes

Recupera el estado y los conteos de solicitudes de un lote de mensajes.

GET
/v1/messages/batches/{message_batch_id}

Descripción general

Devuelve el estado, los conteos de solicitudes y las marcas de tiempo de un lote de mensajes que su organización creó. Realice consultas a este endpoint hasta que processing_status sea ended, luego obtenga los resultados.

Notas

  • processing_status puede ser in_progress, canceling o ended.
  • results_url es null hasta que el lote haya finalizado.
  • Un lote que no existe o que fue eliminado devuelve 404. Un lote que aún no está listo para ser leído puede devolver 409; inténtelo de nuevo más tarde.

Ejemplo

Solicitud

cURL
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"

Ejemplo de respuesta

Respuesta

200 OK
{
  "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 o ended.
request_countsobject
Número de solicitudes que están en estado processing, succeeded, errored, canceled o expired.
ended_atstring|null
Cuándo finalizó el procesamiento, o null.
cancel_initiated_atstring|null
Cuándo se aceptó una solicitud de cancelación, o null.
results_urlstring|null
URL de los resultados, o null.

Autorización

BearerAuth
AuthorizationBearer <token>

Autenticación con API Key. Cree o gestione API keys en Dashboard > API > API Keys.

Ubicación: header

Parámetros de ruta

message_batch_id*string

Identificador del lote de mensajes.

Respuesta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json