機能の概要
gpt-image-2 モデルを使用して画像を編集します。元の画像と編集プロンプトをアップロードすることで、編集後の画像を生成できます。
呼び出しの説明
インターフェース制約
- 呼び出し元はAPIキーを保有している必要があります。詳細については、AI APIキーの管理を参照してください。
リクエストパス
POST https://ai-api-g.oceanbase.com/api/v1/images/edits
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer YOUR_API_KEY | 認証情報 |
| Content-Type | いいえ | multipart/form-data | リクエストボディの形式。ファイルアップロードに使用されます |
リクエストパラメータ
Pathパラメータ
なし
Queryパラメータ
なし
Bodyパラメータ (multipart/form-data)
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| model | string | はい | gpt-image-2 | モデル名 |
| prompt | string | はい | Change the background to a beach scene | 画像編集のプロンプト |
| image | file | はい | @./input.png | 元の画像ファイル |
| n | integer | いいえ | 1 | 生成する画像の数 |
| size | string | いいえ | 1024x1024 | 生成する画像のサイズ |
実行結果
戻り値パラメータ
プロパティ |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうかを示します。 |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | ビジネスデータを返します。 |
dataフィールドの説明
生成された編集後の画像データを返します。
リクエスト例
curl -sS -X POST "https://ai-api-g.oceanbase.com/api/v1/images/edits" \
-H "Authorization: Bearer ${API_KEY}" \
-F "model=gpt-image-2" \
-F "prompt=Change the background to a beach scene" \
-F "image=@./input.png" \
-F "n=1" \
-F "size=1024x1024"
レスポンス例
成功応答
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"b64_json": "<base64 encoded image data>"
}
}
エラー応答
{
"error": {
"message": "error message",
"type": "error_type",
"code": "error_code"
}
}