TokenLab

Worlds

Obtenir le statut du monde

Récupère le statut et le résultat d'une tâche de génération de monde World Labs Marble

GET
/v1/worlds/generations/{id}

GET /v1/worlds/generations/{id} est un endpoint de compatibilité. Il reste pris en charge pour les intégrations existantes. Les nouvelles intégrations doivent interroger GET /v1/tasks/{id} avec le même id de tâche ; voir Obtenir le statut de la tâche.

Cet endpoint renvoie le statut d'une tâche de génération World Labs Marble. Utilisez l'id de la tâche provenant de la réponse de création.

Une tâche publique expirée ou indisponible peut renvoyer 404 async_task_not_found. Si la propriété de la tâche ne peut pas être établie pour la clé API actuelle, la réponse est 403 task_not_owned.

Paramètres de chemin

idstringpathrequis

ID de la tâche de génération de monde.

Réponse

Seuls id et status sont requis dans une réponse de statut réussie. Les alias de tâche, les IDs d'opération, les assets du monde et les légendes sont renvoyés lorsqu'ils sont disponibles. Une tâche terminée ne garantit pas que chaque URL d'asset est présente. Une tâche ayant échoué renvoie tout de même un HTTP 200 : lisez status, error et error_details.

world_marble_url ouvre la visionneuse interactive World Labs. Les fichiers de résultat tels que glb_url, pano_url et thumbnail_url sont des liens TokenLab ; ils sont vides ou absents tant que la tâche n'est pas terminée.

idstring

ID de la tâche publique.

task_idstring

Alias de l'identifiant de la tâche asynchrone.

operation_idstring

ID de l'opération World Labs.

statusstring

Statut de la tâche : pending, processing, completed, failed ou timeout.

world_idstring

ID du monde World Labs une fois terminé.

world_marble_urlstring

URL du monde Marble généré une fois terminé.

model_urlstring

Alias pour l'URL principale du monde/modèle généré.

glb_urlstring

URL du maillage de collision GLB lorsqu'il est disponible. Un lien de résultat média TokenLab qui reste valide pendant 30 jours.

pano_urlstring

URL de l'image panoramique lorsqu'elle est disponible. Un lien de résultat média TokenLab qui reste valide pendant 30 jours.

thumbnail_urlstring

URL de l'image miniature lorsqu'elle est disponible. Un lien de résultat média TokenLab qui reste valide pendant 30 jours.

captionstring

Légende du monde généré.

errorstring | object

Message d'erreur lorsque la tâche a échoué.

error_detailsobject

Détails de l'échec lorsque la tâche a échoué : status, message, type, code, retryable et param lorsqu'un champ de requête est en cause.

media_retentionobject

Statut de conservation des liens de résultat média TokenLab dans une réponse terminée : days et items[] avec url, kind, status et expires_at. Il peut être absent ; les liens fonctionnent toujours. Voir Conservation des données.

Requête

curl --fail-with-body "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"
{  "id": "string",  "task_id": "string",  "operation_id": "string",  "status": "pending",  "world_id": "string",  "world_marble_url": "string",  "model_url": "string",  "glb_url": "string",  "pano_url": "string",  "thumbnail_url": "string",  "caption": "string",  "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"    }  },  "media_retention": {    "days": 0,    "items": [      {        "url": "http://example.com",        "kind": "image",        "content_type": "string",        "status": "saving",        "expires_at": "2019-08-24T14:15:22Z"      }    ]  }}

Autorisation

BearerAuth
AuthorizationBearer <token>

Authentification par clé API. Créez ou gérez vos clés API dans Dashboard > API > API Keys.

Emplacement: header

Paramètres de chemin

id*string

ID de la tâche de génération de monde.

Réponse

application/json

application/json

application/json