TokenLab

Fichiers & lots

Annuler le lot

Annule un travail de lot en attente ou en cours.

POST
/v1/batches/{batch_id}/cancel

Demandez l’annulation d’un lot en attente ou en cours. La réponse contient son état actuel : l’annulation peut être en cours ou déjà terminée. Un lot déjà terminé conserve son état final. Si l’état renvoyé n’est pas final, récupérez à nouveau le lot pour vérifier le résultat.

Requête

cURL
curl -X POST "https://api.tokenlab.sh/v1/batches/batch_abc123/cancel" \
  -H "Authorization: Bearer sk-your-api-key"

Réponse

200 OK
{
  "id": "batch_abc123",
  "object": "batch",
  "status": "cancelling",
  "input_file_id": "file_abc123"
}
idstring
Identifiant pour les appels suivants et le support.
statusstring
État actuel du lot. Une demande d’annulation réussie ne renvoie pas toujours cancelling.

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

batch_id*string

Réponse

application/json

application/json