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

非同期ジョブ

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

create エンドポイントが返す `poll_url` を使用して、任意の非同期タスクのステータスと結果を取得します

GET
/v1/tasks/{id}

概要

このエンドポイントは、動画、画像、音楽、3D生成などのタスクタイプにまたがる統一された非同期ポーリングに使用します。

create レスポンスに poll_url が含まれている場合は、正確にそのパスを呼び出してください。画像モデルの中には、タスクベースのレスポンスを画像専用のステータスパス、または /v1/tasks/{id} のいずれかで返すものがあります。

パスパラメータ

idstringpath必須

create リクエストが返すタスクID。

レスポンス

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

idstring

標準的な非同期タスク識別子。

task_idstring

非同期タスク識別子の別名。

poll_urlstring

create レスポンスが提供する場合の推奨ポーリングURL。

statusstring

タスクステータス。pending、processing、completed、failed などです。キャンセルされたタスクは failed として表され、cancelled: true が付きます。

cancelledboolean

キュー中の非同期タスクが実行前にキャンセルされた場合は true です。

cancellation_statusstring

キャンセルマーカー。キャンセル成功時は cancelled です。

dataarray

完了した画像タスクでは、生成された画像結果がここに返されます。画像タスクは data[].url に URL を返します。

progressnumber

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

video_urlstring

タスクが完了して動画を生成した場合の結果アセットのURL。

videoobject

利用可能な場合に url, duration, width, height を含む単一の動画ペイロード。

videosarray

タスクが複数出力を返す場合の複数の動画ペイロード。

errorstring | object

タスクが失敗したときのエラーメッセージ。

createdinteger

利用可能な場合の作成タイムスタンプ。

updatedinteger

利用可能な場合の最終更新タイムスタンプ。

modelstring

利用可能な場合にタスクで使用されたモデル。

エラー時の挙動

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

{
  "error": {
    "message": "Task not found or no longer available.",
    "type": "invalid_request_error",
    "code": "async_task_not_found"
  }
}

例

リクエスト

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

poll_url = "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
response = requests.get(
    f"https://api.tokenlab.sh{poll_url}",
    headers={"Authorization": "Bearer sk-your-api-key"},
)
print(response.json())
JavaScript
const pollUrl = '/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa';
const response = await fetch(`https://api.tokenlab.sh${pollUrl}`, {
  headers: { Authorization: 'Bearer sk-your-api-key' },
});
console.log(await response.json());
{  "id": "string",  "status": "pending",  "progress": 0,  "created": 0,  "updated": 0,  "model": "string",  "video": {    "url": "string",    "duration": 0,    "width": 0,    "height": 0  },  "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"    }  },  "task_id": "string",  "poll_url": "string",  "cancelled": true,  "cancellation_status": "cancelled",  "billing_transaction_id": "string",  "video_url": "string",  "videos": [    {}  ],  "data": [    {}  ],  "audio_url": "string",  "title": "string",  "lyrics": "string",  "model_url": "string",  "glb_url": "string",  "fbx_url": "string"}

認証

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モデルステータスの取得

前へ

タスクをキャンセル

次へ