Skip to content

GPT Image 2 Editing

POST/v1/run

GPT Image 2 Editing supports image editing and multi-image synthesis with high-quality results.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to openai/gpt-image-2/edit.

Default: openai/gpt-image-2/edit

array<string>imagesrequired

The URLs of the images to use for image-to-image generation or image editing.

stringpromptrequired

The text prompt to generate an image from.

Default: Generate a photorealistic image of a gift basket on a white background labeled 'Relax & Unwind' with a ribbon and handwriting-like font, containing all the items in the reference pictures.

Optional<string>quality

Quality for the generated image

Allowed values: low, medium, high

Default: high

Optional<string>resolution

The resolution of the generated image. Leave unset to preserve the provider's standard dimensions.

Allowed values: 1k, 2k, 4k

Optional<string>aspect_ratio

The aspect ratio of the generated image.

Allowed values: 1:1, 1:2, 2:1, 1:3, 3:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 9:21, 21:9

Optional<string>output_format

The format of the generated image.

Allowed values: jpeg, png, webp

Default: png

Response Schema

The submit endpoint returns an accepted generation task. Poll the result endpoint with the returned id for terminal outputs or errors.

Optional<string>error

Error message if the task failed. Empty on success.

stringidrequired

Unique identifier for the generation task.

Optional<string>model

Model ID used for the prediction.

Optional<array>outputs

Array of generated content. Empty when status is not completed.

stringstatusrequired

Status of the task: pending, running, completed, failed, or timeout.

Allowed values: pending, running, completed, failed, timeout

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: image-to-image, commercial

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async