Zum Hauptinhalt springen

​
Übersicht

Verwenden Sie diesen Endpunkt für ein einheitliches asynchrones Polling über verschiedene Task-Typen hinweg, z. B. Video-, Bild-, Musik- und 3D-Generierung. Wenn eine Create-Antwort poll_url enthält, rufen Sie genau diesen Pfad auf. Bei neueren asynchronen Workflows kann poll_url auf /v1/tasks/{id} verweisen.

​
Pfadparameter

​
id
string
erforderlich
Die von der Create-Anfrage zurückgegebene Task-ID.

​
Antwort

​
id
string
Task-Bezeichner.
​
task_id
string
Alias für die asynchrone Task-ID.
​
poll_url
string
Bevorzugte Polling-URL, wenn die Create-Antwort sie bereitstellt.
​
status
string
Task-Status wie pending, processing, completed oder failed. Abgebrochene Tasks werden als failed mit cancelled: true dargestellt.
​
cancelled
boolean
true, wenn ein wartender asynchroner Task vor der Ausführung abgebrochen wurde.
​
cancellation_status
string
Abbruchmarker. Bei erfolgreichem Abbruch cancelled.
​
data
array
Für abgeschlossene Bild-Tasks werden die generierten Bildergebnisse hier zurückgegeben. Bild-Tasks geben URLs in data[].url zurück.
​
progress
number
Optionaler Fortschrittswert. Wird nur zurückgegeben, wenn ein echter Fortschrittswert verfügbar ist; verwenden Sie status, um den Abschluss zu erkennen.
​
video_url
string
URL des Ergebnis-Assets, wenn die Task abgeschlossen wird und ein Video erzeugt.
​
error
string
Fehlermeldung, wenn die Task fehlschlägt.

​
Fehlerverhalten

Wenn die Task nicht mehr existiert, abgelaufen ist oder im öffentlichen Task-Datensatz nicht mehr verfügbar ist, gibt TokenLab Folgendes zurück: 
{
  "error": {
    "message": "Task not found or no longer available.",
    "type": "invalid_request_error",
    "code": "async_task_not_found"
  }
}

​
Beispiele

curl "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"
Python
import requests

poll_url = "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
response = requests.get(
    f"https://api.tokenlab.sh{poll_url}",
    headers={"Authorization": "Bearer sk-your-api-key"},
)
print(response.json())
JavaScript
const pollUrl = '/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa';
const response = await fetch(`https://api.tokenlab.sh${pollUrl}`, {
  headers: { Authorization: 'Bearer sk-your-api-key' },
});
console.log(await response.json());