TokenLab

Fichiers & lots

Annuler un lot de messages

Annule un lot de messages (Message Batch) en cours de traitement.

POST
/v1/messages/batches/{message_batch_id}/cancel

Aperçu

Demandez l'annulation d'un Message Batch en cours de traitement. La réponse indique l'état actuel. Le processing_status est généralement canceling, et les requêtes déjà en cours d'exécution peuvent tout de même se terminer. Un lot qui est déjà terminé est renvoyé sans modification.

Remarques

  • Après avoir effectué l'annulation, récupérez le lot jusqu'à ce que le processing_status soit ended. Les requêtes qui n'avaient pas démarré se terminent avec le statut canceled.
  • Un lot inexistant ou supprimé renvoie une erreur 404. Un lot qui n'est pas encore prêt à être modifié renvoie une erreur 409 ; réessayez plus tard.
  • L'annulation ne supprime pas le lot. Pour le supprimer, supprimez-le une fois qu'il est terminé.

Exemple

Requête

cURL
curl -X POST "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/cancel" \
  -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": "canceling",
  "request_counts": {
    "processing": 1,
    "succeeded": 1,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2026-11-01T10:00:00Z",
  "expires_at": "2026-11-02T10:00:00Z",
  "cancel_initiated_at": "2026-11-01T10:05:00Z",
  "archived_at": null,
  "results_url": null
}

Champs importants

processing_statusstring
canceling pendant que l'annulation est en cours, ended une fois celle-ci terminée. Ne supposez pas que chaque requête d'annulation renvoie canceling.
cancel_initiated_atstring|null
Moment où la requête d'annulation a été acceptée, 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