Image Editing (gpt-image-1)

Developing

POST

https://api.comet.com/v1/images/edits

Maintainer:Not configured

Image Editing Request Parameters

Parameter	Type	Required	Description
`image`	file or file array	✅	The image(s) to edit. Must be a supported image file or array. • gpt-image-1: PNG, WEBP, or JPG, each <25MB. • dall-e-3: 1 square PNG <4MB.
`prompt`	string	✅	A text description of the desired image(s). • Max length: 1000 chars for dall-e-3, 32000 chars for gpt-image-1.
`mask`	file		Optional PNG mask image. Transparent areas (alpha = 0) indicate regions to edit. Must match size of image and be <4MB. Applies to 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		For gpt-image-1 only. Options: `"high"`, `"medium"`, `"low"`. Default: `"auto"`.
`response_format`	string or null		Response format. Options: `"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-3: `"256x256"`, `"512x512"`, `"1024x1024"`

Request

Header Params

Authorization

string

optional

Example:

Bearer {{api-key}}

Body Params multipart/form-data

image

file

required

The image(s) to edit. Must be a supported image file or array.

gpt-image-1: PNG, WEBP, or JPG, each <25MB.
dall-e-3: 1 square PNG <4MB.

Example:

MQ==/test.png

prompt

string

required

A text description of the desired image(s).

Max length: 1000 chars for dall-e-3, 32000 chars for gpt-image-1.

Example:

Put on glasses

model

string

optional

Model to use: "dall-e-3" or "gpt-image-1".

Example:

gpt-image-1

mask

file

optional

Optional PNG mask image. Transparent areas (alpha = 0) indicate regions to edit.
Must match size of image and be <4MB. Applies to first image.

string

optional

Number of images to generate. Must be between 1 and 10.

Default:

quality

enum<string>

optional

For gpt-image-1 only. Options: "high", "medium", "low".
Default: "auto".

Allowed values:

highmediumlow

Default:

auto

response_format

enum<string>

optional

Response format. Options: "url" or "b64_json".
Only "dall-e-3" supports "url" (valid for 60 minutes).

Allowed values:

urlb64_json

size

string

optional

Image size:

gpt-image-1: "1024x1024", "1536x1024", "1024x1536", "auto" (default)

dall-e-3: "256x256", "512x512", "1024x1024"

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.comet.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=""'

Responses

🟢200success

application/json

Body

data

array [object {1}]

required

Contains a list of response data objects.

b64_json

string

required

Base64 encoded image data

created

integer

required

The Unix timestamp (in seconds) of when the chat completion was created.

usage

object

required

Usage statistics for the completion request.

completion_tokens

integer

required

Number of tokens in the generated completion.

completion_tokens_details

object

required

Breakdown of tokens used in a completion.

prompt_tokens

integer

required

Number of tokens in the prompt. It equals prompt_cache_hit_tokens + prompt_cache_miss_tokens.

prompt_tokens_details

object

required

Breakdown of tokens used in a promt.

total_tokens

integer

required

Total number of tokens used in the request (prompt + completion).

Example

{
    "created": 1713833628,
    "data": [
        {
            "b64_json": "..."
        }
    ],
    "usage": {
        "total_tokens": 100,
        "input_tokens": 50,
        "output_tokens": 50,
        "input_tokens_details": {
            "text_tokens": 10,
            "image_tokens": 40
        }
    }
}

Realtime

Create speech

Image Editing (gpt-image-1)

Image Editing Request Parameters#

Request

Request samples

Responses

Image Editing Request Parameters