TokenLab

Fichiers & lots

Annuler un batch

Annuler un batch qui n'est pas encore terminé.

POST
/v1/batches/{batch_id}/cancel

Demande l'annulation d'un batch en file d'attente ou en cours d'exécution. La réponse contient son statut actuel : l'annulation peut être encore en cours ou déjà terminée. Un batch déjà terminé conserve son statut terminal existant. Si le statut retourné n'est pas terminal, récupérez à nouveau le batch pour vérifier le résultat. Un identifiant de batch inconnu renvoie 404 batch_not_found.

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
ID du batch.
statusstring
Statut actuel du batch. Ne partez pas du principe que chaque requête d'annulation réussie renvoie 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

application/json