Asynchrone Jobs
Task-Status abrufen
Rufen Sie den Status und das Ergebnis jeder asynchronen Task über die von den Create-Endpunkten zurückgegebene `poll_url` ab
Ü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
Die von der Create-Anfrage zurückgegebene Task-ID.
Antwort
Ergebnis-, Fehler-, Zeitstempel- und Modellfelder werden zurückgegeben, wenn sie für den Task verfügbar sind.
Task-Bezeichner.
Alias für die asynchrone Task-ID.
Bevorzugte Polling-URL, wenn die Create-Antwort sie bereitstellt.
Task-Status wie pending, processing, completed oder failed. Abgebrochene Tasks werden als failed mit cancelled: true dargestellt.
true, wenn ein wartender asynchroner Task vor der Ausführung abgebrochen wurde.
Abbruchmarker. Bei erfolgreichem Abbruch cancelled.
Für abgeschlossene Bild-Tasks werden die generierten Bildergebnisse hier zurückgegeben. Bild-Tasks geben URLs in data[].url zurück.
Optionaler Fortschrittswert. Wird nur zurückgegeben, wenn ein echter Fortschrittswert verfügbar ist; verwenden Sie status, um den Abschluss zu erkennen.
URL des Ergebnis-Assets, wenn die Task abgeschlossen wird und ein Video erzeugt.
Einzelnes Videoobjekt mit url, duration, width und height, falls verfügbar.
Video-Array, wenn die Generierungsaufgabe mehrere Ausgaben zurückgibt.
Zeitstempel der Erstellung.
Zeitstempel der letzten Aktualisierung.
Für die Task verwendetes Modell.
Fehlermeldung, wenn die Task fehlschlägt.
Fehlerverhalten
Ein abgelaufener oder nicht verfügbarer öffentlicher Task kann 404 async_task_not_found zurückgeben. Ist die Zugehörigkeit zum aktuellen API-Schlüssel nicht feststellbar, lautet die Antwort 403 task_not_owned.
{
"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"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())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());{ "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", "videos": [ {} ], "data": [ {} ], "audio_url": "string", "title": "string", "lyrics": "string", "model_url": "string", "glb_url": "string", "fbx_url": "string"}Autorisierung
BearerAuth API-Key-Authentifizierung. Erstellen oder verwalten Sie API-Keys unter Dashboard > API > API Keys.
Ort: header
Pfadparameter
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