TokenLab
API キーを取得
ドキュメントAPIリファレンス連携

3D

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

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

GET
/v1/tasks/{id}

このエンドポイントをポーリングして、3Dモデル生成タスクのステータスを確認します。

作成レスポンスに poll_url が含まれている場合は、ポーリングにはその URL を優先して使ってください。id と task_id は同じ非同期タスク ID として扱います。

期限切れまたは利用できない公開タスクでは 404 async_task_not_found が返る場合があります。現在の API キーでタスクの所有権を確認できない場合は 403 task_not_owned が返ります。

パスパラメータ

idstringpath必須

3D生成タスクのID。

レスポンス

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

idstring

タスクID。

task_idstring

利用可能な場合の非同期タスク ID 別名です。

poll_urlstring

利用可能な場合に返される優先ポーリング URL です。

statusstring

タスクのステータス：pending、processing、completed、またはfailed。

progressinteger

任意の進捗値です。実際の進捗値が利用できる場合のみ返されます。完了判定には status を使用してください。

model_urlstring

3DモデルファイルをダウンロードするためのURL（完了時）。

glb_urlstring

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

fbx_urlstring

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

errorstring | object

エラーメッセージ（失敗時）。

リクエスト

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

レスポンス

レスポンス (完了)
{
  "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

3Dモデルの作成

前へ

タスクのステータスを取得

次へ