画像

画像ステータスの取得

非同期画像生成タスクのステータスと結果を取得します

GET
/v1/tasks/{id}

画像専用パスである /v1/images/generations/{id} および /v1/images/{id} は互換性維持のためのエンドポイントです。既存のインテグレーション向けに引き続きサポートされます。新規のインテグレーションでは GET /v1/tasks/{id} をポーリングしてください。詳細は タスクステータスの取得 を参照してください。

パスパラメータ

idstringpath必須

初期の画像生成リクエストから返されたタスクID。

作成時のレスポンスに含まれる id または task_id を使用してください。

/v1/images/{id} 互換エイリアスは、ldtask_... のようなパブリックな画像タスクIDを受け付けます。これは /v1/images/generations/{id} と同じ認証、所有権チェック、課金ヘッダー、ターミナルスナップショット、およびレスポンス形式を使用します。

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

レスポンス

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

idstring

正規の非同期タスク識別子。

poll_urlstring

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

createdinteger

作成時のUnixタイムスタンプ。

task_idstring

タスク識別子。

statusstring

タスクのステータス: pending(保留中)、processing(処理中)、completed(完了)、または failed(失敗)。

dataarray

生成された画像の配列(status が completed の場合に格納されます)。

各オブジェクトの内容:

  • url (string): 生成された画像のTokenLabメディア結果URL(30日間有効)
  • revised_prompt (string): 選択したモデルがプロンプトの修正を返した場合のオプションのプロンプト修正内容
errorstring | object

タスクが失敗した理由(status が failed の場合のみ): 文字列、または message を含むオブジェクト。既知の場合は type、code、param、retryable も含まれます。

error_detailsobject

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

media_retentionobject

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

usageobject

gpt-image-2 のようなトークン課金モデルにおけるトークン使用量(利用可能な場合)。

リクエスト

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

レスポンス

{
  "created": 1706000000,
  "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "pending",
  "data": []
}

チェック間隔

ステータスが pending または processing の間は3〜5秒ごとにチェックし、completed または failed になった時点で停止してください。

import requests
import time

def poll_image_task(task_id, api_key, max_wait=300, interval=3):
    """Poll for image generation result with timeout."""
    url = f"https://api.tokenlab.sh/v1/tasks/{task_id}"
    headers = {"Authorization": f"Bearer {api_key}"}

    start_time = time.time()
    while time.time() - start_time < max_wait:
        response = requests.get(url, headers=headers, timeout=30)
        response.raise_for_status()
        data = response.json()

        if data["status"] == "completed":
            return data["data"][0]["url"]
        elif data["status"] == "failed":
            raise Exception(data.get("error", "Generation failed"))

        time.sleep(interval)

    raise TimeoutError(f"Task {task_id} did not complete within {max_wait}s")

# Usage
image_url = poll_image_task("ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sk-your-api-key")
print(f"Generated image: {image_url}")

認証

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