Asynchrone Jobs

Aufgabe abbrechen

Bricht eine in der Warteschlange befindliche asynchrone Aufgabe ab, sofern das Modell den Abbruch unterstützt

DELETE
/v1/tasks/{id}

Überblick

Verwenden Sie DELETE /v1/tasks/{id}, um eine asynchrone Aufgabe abzubrechen, die noch nicht mit der Ausführung begonnen hat. Verwenden Sie dieselbe Aufgaben-ID aus der Erstellungsantwort oder der zurückgegebenen poll_url.

Unterstützte Aufgaben

Der Abbruch ist für in der Warteschlange befindliche Seedance-Aufgaben verfügbar, die seedance-2.0, seedance-2.0-fast oder seedance-2.5 verwenden, sofern die Aufgabe den Abbruch unterstützt. Eine Aufgabe, die bereits ausgeführt wird oder sich in einem Endzustand befindet, kann nicht abgebrochen werden. Eine abgebrochene Aufgabe wird nicht berechnet. Der Status bleibt abfragbar, solange der öffentliche Aufgabendatensatz gespeichert ist.

Informationen zum Abbrechen einer Aufgabe, die über den Volc-kompatiblen Seedance-Endpunkt erstellt wurde, finden Sie unter Aufgabe abbrechen (Volc-kompatibel).

Pfadparameter

idstringpatherforderlich

Die asynchrone Aufgaben-ID, die von der Erstellungsanfrage zurückgegeben oder in poll_url eingebettet wurde.

Antwort

idstring

Kanonischer Bezeichner der asynchronen Aufgabe.

task_idstring

Alias des Bezeichners der asynchronen Aufgabe.

poll_urlstring

Status-URL für die Aufgabe. Sie bleibt nach dem Abbruch gültig. Fragen Sie GET /v1/tasks/{id} mit id ab.

statusstring

Aufgabenstatus. Eine erfolgreich abgebrochene Aufgabe wird als failed mit cancelled: true zurückgegeben, um die Kompatibilität mit bestehenden Statuswerten zu gewährleisten.

cancelledboolean

true, wenn die Aufgabe vor der Ausführung abgebrochen wurde.

cancellation_statusstring

Abbruch-Marker. Der Wert ist cancelled, wenn der Abbruch erfolgreich war.

errorstring

Grund für den Abbruch oder Fehlermeldung der Aufgabe.

Fehlerverhalten

HTTPCodeBedeutung
400missing_task_id, invalid_task_idDie Aufgaben-ID fehlt oder ist keine gültige Aufgaben-ID
400unsupported_task_cancelDer Aufgabentyp oder das Modell unterstützt keinen Abbruch
403task_not_ownedDie Aufgabe gehört nicht zum Workspace dieses API-Keys
404async_task_not_foundDie Aufgabe ist abgelaufen oder nicht verfügbar
409task_not_cancellableDie Aufgabe wird bereits verarbeitet, ist abgeschlossen oder kann anderweitig nicht mehr abgebrochen werden. current_status gibt den Zustand an
503async_task_owner_unavailableDie Aufgabe kann derzeit nicht gelesen werden. Versuchen Sie es erneut

Beispiel

Anfrage

cURL
curl -X DELETE "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"

Antwort

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

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