TokenLab

Tâches asynchrones

Annuler une tâche

Annulez une tâche asynchrone en file d’attente lorsque le fournisseur et le modèle le permettent

DELETE
/v1/tasks/{id}

Aperçu

Utilisez DELETE /v1/tasks/{id} pour annuler une tâche asynchrone qui n’a pas encore commencé à s’exécuter. Utilisez le même ID de tâche que celui de la réponse create ou celui inclus dans poll_url.

Tâches prises en charge

Les tâches Seedance en attente utilisant seedance-1.5-pro, seedance-2.0, seedance-2.0-fast ou seedance-2.5 peuvent être annulées si elles le permettent. Les tâches en cours ou dans un état final ne peuvent pas être annulées. Le statut reste consultable tant que leur enregistrement public est conservé.

Paramètres de chemin

idstringpathrequis

ID de tâche asynchrone retourné par la requête create ou inclus dans poll_url.

Réponse

idstring

Identifiant canonique de tâche asynchrone.

task_idstring

Alias de l’identifiant de tâche asynchrone.

poll_urlstring

URL de polling recommandée pour la tâche. Elle reste valide après l’annulation.

statusstring

Statut de la tâche. Une tâche annulée avec succès est retournée comme failed avec cancelled: true pour rester compatible avec les valeurs de statut existantes.

cancelledboolean

true lorsque la tâche a été annulée avant l’exécution.

cancellation_statusstring

Marqueur d’annulation. La valeur est cancelled lorsque l’annulation réussit.

errorstring

Raison de l’annulation ou message d’échec de la tâche.

Comportement des erreurs

400 unsupported_task_cancel signifie que le type de tâche, le fournisseur ou le modèle ne prend pas en charge l’annulation. 409 task_not_cancellable signifie que la tâche est déjà en cours de traitement, terminale ou n’est plus annulable. 403 signifie que la clé API ne peut pas accéder à cette tâche.

Exemple

Requête

cURL
curl -X DELETE "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"
Response
{
  "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "failed",
  "cancelled": true,
  "cancellation_status": "cancelled",
  "error": "Task cancelled before execution"
}
{  "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "status": "failed",  "cancelled": true,  "cancellation_status": "cancelled",  "error": "Task cancelled before execution"}

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

id*string

L'ID de tâche asynchrone renvoyé par id / task_id, ou intégré dans poll_url

Réponse

application/json

application/json

application/json

application/json

application/json

application/json

application/json