Worlds

ワールドステータスの取得

World Labs Marbleワールド生成タスクのステータスと結果を取得します

GET
/v1/worlds/generations/{id}

GET /v1/worlds/generations/{id} は互換性維持のためのエンドポイントです。既存のインテグレーションでは引き続きサポートされます。新規のインテグレーションでは、同じタスク id を使用して GET /v1/tasks/{id} をポーリングしてください。詳細は タスクステータスの取得 を参照してください。

このエンドポイントは、World Labs Marble生成タスクのステータスを返します。作成時のレスポンスに含まれるタスク id を使用してください。

期限切れまたは利用不可能なパブリックタスクの場合、404 async_task_not_found が返されることがあります。現在のAPIキーでタスクの所有権を確認できない場合、レスポンスは 403 task_not_owned となります。

パスパラメータ

idstringpath必須

ワールド生成タスクID。

レスポンス

ステータス取得が成功した場合、最低限 id と status が返されます。タスクエイリアス、オペレーションID、ワールドアセット、キャプションは利用可能な場合に返されます。タスクが完了していても、すべてのアセットURLが存在するとは限りません。タスクが失敗した場合でもHTTP 200 が返されるため、status、error、および error_details を確認してください。

world_marble_url は、インタラクティブなWorld Labsビューアを開きます。glb_url、pano_url、thumbnail_url などの結果ファイルはTokenLabのリンクであり、タスクが完了するまでは空であるか、存在しません。

idstring

パブリックタスクID。

task_idstring

非同期タスク識別子のエイリアス。

operation_idstring

World LabsオペレーションID。

statusstring

タスクステータス: pending、processing、completed、failed、または timeout。

world_idstring

完了時のWorld LabsワールドID。

world_marble_urlstring

完了時に生成されたMarbleワールドのURL。

model_urlstring

生成された主要なワールド/モデルURLのエイリアス。

glb_urlstring

利用可能な場合のコライダーメッシュGLB URL。30日間有効なTokenLabメディア結果リンクです。

pano_urlstring

利用可能な場合のパノラマ画像URL。30日間有効なTokenLabメディア結果リンクです。

thumbnail_urlstring

利用可能な場合のサムネイル画像URL。30日間有効なTokenLabメディア結果リンクです。

captionstring

生成されたワールドのキャプション。

errorstring | object

タスク失敗時のエラーメッセージ。

error_detailsobject

タスク失敗時の詳細情報: status、message、type、code、retryable、およびリクエストフィールドに問題がある場合の param。

media_retentionobject

完了レスポンスにおけるTokenLabメディア結果リンクの保存ステータス: days、および url、kind、status、expires_at を含む items[]。この項目は存在しない場合がありますが、リンクは引き続き機能します。データ保持 を参照してください。

リクエスト

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"      }    ]  }}

認証

BearerAuth
AuthorizationBearer <token>

APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。

場所: header

パスパラメータ

id*string

ワールド生成タスクID。

レスポンス

application/json

application/json

application/json