機能の概要
画像または動画の非同期生成タスクの状態を照会します。終了状態でキャッシュ結果がある場合、上流の結果を返し、task_id と task_status を補足します。
呼び出しの説明
インターフェース制約
- 呼び出し元はAPIキーを保有している必要があります。詳細については、AI APIキーの管理をご参照ください。
リクエストパス
GET {BASE_URL}/api/v1/tasks/{task_id}
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
リクエストパラメータ
Pathパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| task_id | string | はい | なし |
Queryパラメータ
なし
Bodyパラメータ
なし
実行結果
パラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうか |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | 業務データ |
dataフィールドの説明
名前 |
型 |
説明 |
|---|---|---|
| task_id | string | タスクID |
| task_status | string | タスク状態 |
リクエスト例
curl --request GET '{BASE_URL}/api/v1/tasks/{task_id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json'
レスポンス例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"task_id": "example-task-id",
"task_status": "SUCCESS"
}
}