Overview
Use the gpt-image-2 model to edit images. Upload an original image and provide an editing prompt to generate an edited image.
API details
Constraints
- You must have an API key. For more information, see Manage AI API keys.
Request path
POST https://ai-api-g.oceanbase.com/api/v1/images/edits
Request header
Parameter |
Required |
Description |
Example value |
|---|---|---|---|
| Authorization | Yes | Authentication information. | Bearer YOUR_API_KEY |
| Content-Type | No | Request body format for file uploads. | multipart/form-data |
Request parameters
Path parameters
None
Query parameters
None
Body parameters (multipart/form-data)
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| model | string | Yes | Model name. | gpt-image-2 |
| prompt | string | Yes | Image editing prompt. | Change the background to a beach scene |
| image | file | Yes | Original image file. | @./input.png |
| n | integer | No | Number of images to generate. | 1 |
| size | string | No | Generated image size. | 1024x1024 |
Response
Response parameters
Field |
Type |
Description |
|---|---|---|
| success | boolean | Whether the request was successful. |
| code | string | Response code. |
| message | string | Response message. |
| data | object | Response data. |
Response data
Returns the edited image data.
Request example
curl -sS -X POST "https://ai-api-g.oceanbase.com/api/v1/images/edits" \
-H "Authorization: Bearer YOUR_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"
Response example
Successful response
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"b64_json": "<base64 encoded image data>"
}
}
Error response
{
"error": {
"message": "error message",
"type": "error_type",
"code": "error_code"
}
}