機能説明
画像の生成・編集を行うためのAPIです。同期モードでは直接画像結果を返し、非同期モードではタスクIDを返した後、/api/v1/tasks/{task_id} でクエリします。X-Async ヘッダーは省略可能です。
呼び出し説明
インターフェース制約
- 呼び出し元はAPIキーを保有している必要があります。詳細については、AI APIキーの管理をご参照ください。
リクエストパス
POST {BASE_URL}/api/v1/images/generations
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
| X-Async | いいえ | 互換性のための古いパラメータです。新規接続時は設定不要です。サービスはモデルタイプに基づいて自動的に同期または非同期での返却を決定します。このヘッダーは、モードを強制的に切り替えるためには使用されなくなりました。 |
リクエストパラメータ
Pathパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| なし | このAPIにはPathパラメータはありません。 |
Queryパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| なし | このAPIにはQueryパラメータはありません。 |
Bodyパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| model | string | はい | モデル名 |
ベンダー固有のパラメータ説明
異なるベンダーの画像生成モデルでは、リクエストパラメータに違いがあります。詳細なパラメータ説明については、該当するベンダーのドキュメントをご参照ください。
- 火山引擎：火山引擎画像生成APIドキュメントをご参照ください。
- Alibaba Cloud百炼：Alibaba Cloud百炼モデルAPIドキュメントをご参照ください。
実行結果
レスポンスパラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうか |
| code | string | 戻りコード |
| message | string | 返されたメッセージ |
| data | object | ビジネスデータ |
dataフィールドの説明
名前 |
型 |
説明 |
|---|---|---|
| モデルとリクエストによって異なります | unknown | 成功した場合のレスポンスデータ。画像結果やタスクIDなどの情報が含まれます。 |
リクエスト例
curl --request POST '{BASE_URL}/api/v1/images/generations' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"model": "your-model-name"
}'
レスポンス例
成功応答 (200)
{
"success": true,
"code": "200",
"message": "successful",
"data": {
// 具体返回数据根据模型类型（同步/异步）而定
}
}
リクエストパラメータエラー (400)
{
"success": false,
"code": "400",
"message": "Invalid request parameters"
}
未認証 (401)
{
"success": false,
"code": "401",
"message": "Unauthorized"
}
リクエスト頻度が上限を超えました (429)
{
"success": false,
"code": "429",
"message": "Rate limit exceeded"
}