> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tokenlab.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# 獲取圖片狀態

> 獲取非同步圖片生成任務的狀態與結果

## 路徑參數

<ParamField path="id" type="string" required>
  從初始圖片生成請求中返回的任務 ID。
</ParamField>

<Info>
  如果建立請求的響應中包含 `poll_url`，建議優先調用該 URL 進行輪詢。某些圖片任務可能會在 `/v1/tasks/{id}` 下顯示 `poll_url`，而非圖片特定的狀態路徑。

  你也可以用 `/v1/images/{id}` 輪詢 `ldtask_...` 這類公開圖片任務 ID。這個相容 alias 會沿用與 `/v1/images/generations/{id}` 完全相同的鑑權、ownership 檢查、計費 header、終態快照和回應格式。

  如果該任務已不存在，或無法再從公開任務記錄中查詢到，TokenLab 會回傳 `async_task_not_found`，並附上訊息 `Task not found or no longer available.`
</Info>

## 響應

<ResponseField name="created" type="integer">
  建立時的 Unix 時間戳。
</ResponseField>

<ResponseField name="task_id" type="string">
  任務識別碼。
</ResponseField>

<ResponseField name="status" type="string">
  任務狀態：`pending`、`processing`、`completed` 或 `failed`。
</ResponseField>

<ResponseField name="data" type="array">
  生成的圖片陣列（當 `status` 為 `completed` 時填充）。

  每個物件包含：

  * `url` (string): 生成圖片的 URL
  * `revised_prompt` (string): 用於生成的提示詞
</ResponseField>

<ResponseField name="error" type="string">
  錯誤訊息（僅在 `status` 為 `failed` 時出現）。
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
    -H "Authorization: Bearer sk-your-api-key"
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      headers={"Authorization": "Bearer sk-your-api-key"}
  )

  data = response.json()
  print(f"Status: {data['status']}")

  if data["status"] == "completed":
      print(f"Image URL: {data['data'][0]['url']}")
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
    {
      headers: {
        'Authorization': 'Bearer sk-your-api-key'
      }
    }
  );

  const data = await response.json();
  console.log(`Status: ${data.status}`);

  if (data.status === 'completed') {
    console.log(`Image URL: ${data.data[0].url}`);
  }
  ```
</RequestExample>

<ResponseExample>
  ```json 等待中 theme={null}
  {
    "created": 1706000000,
    "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "status": "pending",
    "data": [
      {
        "url": "",
        "revised_prompt": "a beautiful sunset over mountains"
      }
    ]
  }
  ```

  ```json 已完成 theme={null}
  {
    "created": 1706000000,
    "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "status": "completed",
    "data": [
      {
        "url": "https://cdn.example.com/generated/image-abc123.png",
        "revised_prompt": "a beautiful sunset over mountains with vibrant orange and purple colors"
      }
    ]
  }
  ```

  ```json 失敗 theme={null}
  {
    "created": 1706000000,
    "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "status": "failed",
    "error": "Content policy violation",
    "data": []
  }
  ```
</ResponseExample>

## 輪詢最佳實踐

<Tip>
  **建議輪詢間隔**：3-5 秒。大多數圖片生成任務會在 30-120 秒內完成，具體取決於模型和路由的供應商路徑。
</Tip>

```python theme={null}
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)
        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}")
```