Asynchrone Jobs

Aufgabenstatus abrufen

Ruft den Status und das Ergebnis einer beliebigen asynchronen Aufgabe ab: Bilder, Video, Musik, 3D, Worlds und asynchrone Audiotranskription

GET
/v1/tasks/{id}

Übersicht

Verwenden Sie GET /v1/tasks/{id}, um eine beliebige asynchrone Aufgabe zu überprüfen. Dies unterstützt Aufgaben für Bilder, Video, Musik, 3D, Worlds und asynchrone Audiotranskription. Übergeben Sie die id oder task_id aus der Erstellungsantwort.

World-Ergebnisfelder wie world_id und world_marble_url sind unter World-Status abrufen dokumentiert. Für eine World-Aufgabe lautet X-Task-Type 3d.

Für die meisten Aufgaben ist die poll_url in der Erstellungsantwort identisch mit diesem Pfad. Eine Worlds-Erstellungsantwort gibt eine poll_url unter /v1/worlds/generations/{id} zurück; pollen Sie für Worlds ebenfalls /v1/tasks/{id} mit der Aufgaben-id.

Modalspezifische Statuspfade wie /v1/images/{id}, /v1/videos/generations/{id}, /v1/music/generations/{id} und /v1/3d/generations/{id} sind Kompatibilitätsendpunkte. Sie werden für bestehende Integrationen weiterhin unterstützt.

Eine Statusabfrage gibt bei einer fehlgeschlagenen Aufgabe den HTTP-Status 200 zurück. Lesen Sie status, nicht den HTTP-Code, um das Ergebnis zu sehen. Die Ergebnisfelder hängen vom Aufgabentyp ab; siehe Bildstatus abrufen, Videostatus abrufen, Musikstatus abrufen und 3D-Status abrufen. Ergebnis-Links sind TokenLab-Medien-Ergebnis-URLs, die 30 Tage lang gültig bleiben; siehe Datenaufbewahrung.

Pfadparameter

idstringpatherforderlich

Die id oder task_id, die von der Erstellungsanfrage zurückgegeben wurde.

Antwort

Felder, die Ergebnisse, Fehler, Zeitstempel und das Modell beschreiben, werden zurückgegeben, sobald sie für die Aufgabe verfügbar sind.

idstring

Kanonischer Bezeichner der asynchronen Aufgabe.

task_idstring

Alias des Bezeichners der asynchronen Aufgabe.

poll_urlstring

Status-URL für diese Aufgabe. Pollen Sie GET /v1/tasks/{id} mit der id.

billing_transaction_idstring

Abrechnungs-Transaktions-ID, sofern eine für die Aufgabe aufgezeichnet wurde. Der Header X-Billing-Transaction-ID enthält denselben Wert. Es handelt sich um einen Abrechnungsbezeichner, nicht um einen Aufgabenbezeichner.

statusstring

Aufgabenstatus: pending, processing, completed, failed oder timeout. Beenden Sie das Polling bei completed, failed oder timeout. Abgebrochene Aufgaben werden als failed mit cancelled: true dargestellt.

cancelledboolean

true, wenn eine asynchrone Aufgabe in der Warteschlange vor der Ausführung abgebrochen wurde.

cancellation_statusstring

Abbruch-Marker. Erscheint als cancelled, wenn der Abbruch erfolgreich war.

dataarray

Für abgeschlossene Bildaufgaben werden hier die generierten Bildergebnisse zurückgegeben. Bildaufgaben geben URLs in data[].url zurück.

progressnumber

Optionaler Fortschrittswert. Wird nur zurückgegeben, wenn ein tatsächlicher Fortschrittswert verfügbar ist; verwenden Sie status, um den Abschluss zu bestimmen.

video_urlstring

Ergebnis-Asset-URL, wenn die Aufgabe abgeschlossen ist und ein Video erstellt wurde.

videoobject

Einzelnes Video-Payload mit url, duration, width und height, sofern verfügbar.

videosarray

Mehrere Video-Payloads, wenn mehr als eine Ausgabe verfügbar ist.

errorstring | object

Grund für das Scheitern der Aufgabe: ein String oder ein Objekt mit message und, falls bekannt, type, code, param und retryable.

error_detailsobject

Fehlerdetails bei Scheitern der Aufgabe: status, message, type, code, retryable und param, wenn ein Anforderungsfeld fehlerhaft ist.

media_retentionobject

Speicherstatus der Ergebnis-Links: days und items[] mit url, kind, status und expires_at. Kann fehlen; die Links funktionieren weiterhin.

createdinteger

Erstellungszeitstempel, sofern verfügbar.

updatedinteger

Zeitstempel der letzten Aktualisierung, sofern verfügbar.

modelstring

Modell, das von der Aufgabe verwendet wurde, sofern verfügbar.

Antwort-Header

Erfolgreiche Statusantworten enthalten diese Header:

HeaderBeschreibung
X-Task-IDÖffentliche Aufgaben-ID
X-Task-TypeAufgabenfamilie, wie image, video, music, 3d oder audio
Cache-Controlno-store. Statusantworten nicht zwischenspeichern
X-Billing-Transaction-IDAbrechnungs-Transaktions-ID, sofern eine aufgezeichnet wurde
X-Task-CostAbgerechnete Aufgabenkosten, wenn die Aufgabe abgerechnet wurde

Fehlerverhalten

HTTPCodeBedeutung
400missing_task_id, invalid_task_idDie Aufgaben-ID fehlt oder ist keine gültige Aufgaben-ID
403task_not_ownedDie Aufgabe gehört nicht zum Workspace dieses API-Keys. Beenden Sie das Polling
404async_task_not_foundDie Aufgabe ist abgelaufen oder nicht verfügbar
503async_task_owner_unavailableDie Aufgabe kann derzeit nicht gelesen werden. Versuchen Sie es erneut
{
  "error": {
    "message": "Task not found or no longer available.",
    "type": "invalid_request_error",
    "code": "async_task_not_found"
  }
}

Beispiele

Anfrage

curl "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"
{  "id": "string",  "status": "pending",  "progress": 0,  "created": 0,  "updated": 0,  "model": "string",  "video": {    "url": "string",    "duration": 0,    "width": 0,    "height": 0  },  "error": "string",  "error_details": {    "projection_version": 0,    "status": 400,    "message": "string",    "type": "string",    "code": "string",    "param": "string",    "retryable": true,    "upstream": {      "source": "string",      "code": "string",      "message": "string",      "param": "string"    }  },  "task_id": "string",  "poll_url": "string",  "cancelled": true,  "cancellation_status": "cancelled",  "billing_transaction_id": "string",  "video_url": "string",  "last_frame_url": "string",  "videos": [    {}  ],  "data": [    {}  ],  "audio_url": "string",  "title": "string",  "lyrics": "string",  "model_url": "string",  "glb_url": "string",  "fbx_url": "string",  "media_retention": {    "days": 0,    "items": [      {        "url": "http://example.com",        "kind": "image",        "content_type": "string",        "status": "saving",        "expires_at": "2019-08-24T14:15:22Z"      }    ]  }}

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