TokenLab

Fichiers & lots

Récupérer un lot de messages

Récupère le statut et le nombre de requêtes d'un lot de messages.

GET
/v1/messages/batches/{message_batch_id}

Aperçu

Renvoie le statut, le nombre de requêtes et les horodatages d'un lot de messages créé par votre organisation. Interrogez ce point de terminaison jusqu'à ce que processing_status soit ended, puis récupérez les résultats.

Remarques

  • processing_status peut être in_progress, canceling ou ended.
  • results_url est null tant que le lot n'est pas terminé.
  • Un lot qui n'existe pas ou qui a été supprimé renvoie 404. Un lot qui n'est pas encore prêt à être lu peut renvoyer 409 ; réessayez plus tard.

Exemple

Requête

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"

Exemple de réponse

Réponse

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

Champs importants

processing_statusstring
in_progress, canceling ou ended.
request_countsobject
Nombre de requêtes en cours de traitement (processing), réussies (succeeded), en erreur (errored), annulées (canceled) ou expirées (expired).
ended_atstring|null
Date et heure de fin du traitement, ou null.
cancel_initiated_atstring|null
Date et heure auxquelles une demande d'annulation a été acceptée, ou null.
results_urlstring|null
URL des résultats, ou null.

Autorisation

BearerAuth
AuthorizationBearer <token>

Authentification par clé API. Créez ou gérez vos clés API dans Dashboard > API > API Keys.

Emplacement: header

Paramètres de chemin

message_batch_id*string

Identifiant du lot de messages

Réponse

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json