Image Editing (gpt-image-1)
POST
https://api.elkapi.com/v1/images/edits
https://platform.openai.com/docs/api-reference/images/createEdit
Image Edit Request Parameters
| Parameter Name | Type | Required | Description |
|---|---|---|---|
image | File or Array of Files | β | The image to be edited. Must be a supported image file or array. - gpt-image-1: PNG, WEBP, or JPG, each less than 25MB. - dall-e-3: A square PNG, less than 4MB. |
prompt | String | β | A textual description of the desired image. - Max length: 1000 characters for dall-e-3, 32000 characters for gpt-image-1. |
mask | File | An optional PNG mask image. Transparent areas (alpha=0) indicate areas that need editing. Must match the image dimensions and be smaller than 4MB. Applies to the first image. | |
model | string | Model to use: dall-e-3 or gpt-image-1. | |
n | integer or null | Number of images to generate. Must be between 1 and 10. Default: 1. | |
quality | string or null | Applies only to gpt-image-1. Possible values: high, medium, low. Default: auto. | |
response_format | string or null | Response format. Possible values: url or b64_json. Only dall-e-3 supports url (valid for 60 minutes). | |
size | string or null | Image size: - gpt-image-1: 1024x1024, 1536x1024, 1024x1536, auto (default) - dall-e-2: 256x256, 512x512, 1024x1024 |
Request
Header Params
Body Params multipart/form-data
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.elkapi.com/v1/images/edits' \
--header 'Authorization: Bearer {{api-key}}' \
--form 'image=@"MQ==/test.png"' \
--form 'prompt="Put on glasses"' \
--form 'model="gpt-image-1"' \
--form 'mask=@""' \
--form 'n=""' \
--form 'quality=""' \
--form 'response_format=""' \
--form 'size=""'Response Response Example
{
"data": [
{
"b64_json": ".........................."
}
],
"created": 1747124651,
"usage": {
"prompt_tokens": 0,
"completion_tokens": 0,
"total_tokens": 6605,
"prompt_tokens_details": {
"cached_tokens_details": {}
},
"completion_tokens_details": {},
"input_tokens": 365,
"output_tokens": 6240,
"input_tokens_details": {
"text_tokens": 42,
"image_tokens": 323,
"cached_tokens_details": {}
}
}
}