3D

3Dモデルステータスの取得

3D生成タスクのステータスと結果を取得します

GET
/v1/tasks/{id}

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

GET /v1/tasks/{id} を呼び出して、3Dモデル生成タスクのステータスを確認します。

id と task_id は同一のタスクを識別します。

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

パスパラメータ

idstringpath必須

3D生成タスクのID。

レスポンス

結果、エラー、タイムスタンプ、モデルを記述するフィールドは、タスクで利用可能な場合に返されます。

idstring

タスクID。

task_idstring

提供されている場合の非同期タスク識別子のエイリアス。

poll_urlstring

このタスクのステータスURL。id を指定して GET /v1/tasks/{id} をポーリングしてください。

statusstring

タスクのステータス: pending(保留中)、processing(処理中)、completed(完了)、failed(失敗)、または timeout(タイムアウト)。失敗したタスクでもHTTP 200 が返されます。

progressinteger

オプションの進捗値。実際の進捗値が利用可能な場合にのみ返されます。完了の判定には status を使用してください。

model_urlstring

3DモデルファイルをダウンロードするためのURL(完了時)。30日間有効なTokenLabメディア結果リンクです。

glb_urlstring

GLB形式のモデルをダウンロードするためのURL(利用可能な場合)。

fbx_urlstring

FBX形式のモデルをダウンロードするためのURL(利用可能な場合)。

errorstring | object

エラーメッセージ(失敗時)。

error_detailsobject

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

media_retentionobject

結果リンクの保存ステータス: days および url、kind、status、expires_at を含む items[]。このフィールドは存在しない場合がありますが、リンクは引き続き機能します。データ保持 を参照してください。

リクエスト

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

レスポンス

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

認証

BearerAuth
AuthorizationBearer <token>

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

場所: header

パスパラメータ

id*string

id / task_id によって返される、または poll_url に埋め込まれた非同期タスクID

レスポンス

application/json

application/json

application/json

application/json

application/json

application/json

application/json