TokenLab
API-Schlüssel erhalten
DokumentationAPI-ReferenzIntegrationen

Asynchrone Jobs

Task abbrechen

Brechen Sie einen wartenden asynchronen Task ab, wenn Provider und Modell dies unterstützen

DELETE
/v1/tasks/{id}

Überblick

Verwenden Sie DELETE /v1/tasks/{id}, um einen asynchronen Task abzubrechen, der noch nicht gestartet wurde. Verwenden Sie dieselbe Task-ID aus der Create-Antwort oder aus der zurückgegebenen poll_url.

Unterstützte Tasks

Wartende Seedance-Tasks mit seedance-1.5-pro, seedance-2.0, seedance-2.0-fast oder seedance-2.5 können abgebrochen werden, sofern der Task dies unterstützt. Laufende oder terminale Tasks können nicht abgebrochen werden. Der Status bleibt während der Aufbewahrung des öffentlichen Task-Datensatzes abfragbar.

Pfadparameter

idstringpatherforderlich

Die asynchrone Task-ID aus der Create-Anfrage oder aus der poll_url.

Antwort

idstring

Kanonischer asynchroner Task-Bezeichner.

task_idstring

Alias des asynchronen Task-Bezeichners.

poll_urlstring

Bevorzugte Polling-URL für den Task. Sie bleibt nach dem Abbruch gültig.

statusstring

Task-Status. Ein erfolgreich abgebrochener Task wird aus Kompatibilitätsgründen als failed mit cancelled: true zurückgegeben.

cancelledboolean

true, wenn der Task vor der Ausführung abgebrochen wurde.

cancellation_statusstring

Abbruchmarker. Der Wert ist cancelled, wenn der Abbruch erfolgreich war.

errorstring

Abbruchgrund oder Fehlermeldung des Tasks.

Fehlerverhalten

400 unsupported_task_cancel bedeutet, dass Task-Typ, Provider oder Modell keinen Abbruch unterstützt. 409 task_not_cancellable bedeutet, dass der Task bereits verarbeitet wird, terminal ist oder nicht mehr abbrechbar ist. 403 bedeutet, dass der API key keinen Zugriff auf den Task hat.

Beispiel

Anfrage

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

Autorisierung

BearerAuth
AuthorizationBearer <token>

API-Key-Authentifizierung. Erstellen oder verwalten Sie API-Keys unter Dashboard > API > API Keys.

Ort: header

Pfadparameter

id*string

Die asynchrone Task-ID, die über id / task_id zurückgegeben oder in poll_url eingebettet wird

Antwort

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Task-Status abrufen

Zurück

Modelle auflisten

Weiter