3D

3D-Modell-Status abrufen

Ruft den Status und das Ergebnis einer 3D-Generierungsaufgabe ab

GET
/v1/tasks/{id}

GET /v1/3d/generations/{id} ist ein Kompatibilitäts-Endpunkt. Er wird für bestehende Integrationen weiterhin unterstützt. Neue Integrationen sollten GET /v1/tasks/{id} abfragen; siehe Aufgabenstatus abrufen.

Rufen Sie GET /v1/tasks/{id} auf, um den Status Ihrer 3D-Modell-Generierungsaufgabe zu überprüfen.

id und task_id bezeichnen dieselbe Aufgabe.

Eine abgelaufene oder nicht verfügbare öffentliche Aufgabe kann 404 async_task_not_found zurückgeben. Wenn die Aufgabeninhaberschaft für den aktuellen API-Schlüssel nicht festgestellt werden kann, lautet die Antwort 403 task_not_owned.

Pfad-Parameter

idstringpatherforderlich

Die ID der 3D-Generierungsaufgabe.

Antwort

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

idstring

Aufgaben-ID.

task_idstring

Alias für die Kennung der asynchronen Aufgabe, sofern bereitgestellt.

poll_urlstring

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

statusstring

Aufgabenstatus: pending, processing, completed, failed oder timeout. Eine fehlgeschlagene Aufgabe gibt weiterhin HTTP 200 zurück.

progressinteger

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

model_urlstring

URL zum Herunterladen der 3D-Modelldatei (sobald abgeschlossen). Ein TokenLab-Medien-Ergebnis-Link, der 30 Tage lang gültig bleibt.

glb_urlstring

URL zum Herunterladen des Modells im GLB-Format (sobald verfügbar).

fbx_urlstring

URL zum Herunterladen des Modells im FBX-Format (sobald verfügbar).

errorstring | object

Fehlermeldung (bei Fehlschlag).

error_detailsobject

Fehlerdetails bei fehlgeschlagener 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. Siehe Datenaufbewahrung.

Anfrage

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

Antwort

Response (Completed)
{
  "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "completed",
  "model_url": "https://api.tokenlab.sh/v1/media-results/5e2a7c90-1d4b-4f8e-a3c6-8b9d0e1f2a47.glb?token=…",
  "glb_url": "https://api.tokenlab.sh/v1/media-results/5e2a7c90-1d4b-4f8e-a3c6-8b9d0e1f2a47.glb?token=…",
  "fbx_url": "https://api.tokenlab.sh/v1/media-results/8d1b3f6a-9c2e-4a5d-b7e0-2f4c6a8e0d15.fbx?token=…",
  "media_retention": {
    "days": 30,
    "items": [
      {
        "url": "https://api.tokenlab.sh/v1/media-results/5e2a7c90-1d4b-4f8e-a3c6-8b9d0e1f2a47.glb?token=…",
        "kind": "3d",
        "content_type": "model/gltf-binary",
        "status": "saved",
        "expires_at": "2024-02-22T08:54:20.000Z"
      },
      {
        "url": "https://api.tokenlab.sh/v1/media-results/8d1b3f6a-9c2e-4a5d-b7e0-2f4c6a8e0d15.fbx?token=…",
        "kind": "3d",
        "content_type": "application/octet-stream",
        "status": "saved",
        "expires_at": "2024-02-22T08:54:20.000Z"
      }
    ]
  }
}

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