Skip to content

GPT Image 1 Mini Edit

POST/v1/run

Gpt Image 1 Mini Edit is OpenAI's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion.

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-1-mini/edit.

Default: openai/gpt-image-1-mini/edit

stringpromptrequired

The prompt for image generation

Optional<array<string>>images

The URLs of the images to use as a reference for the generation.

Optional<string>output_format

Output format for the images

Allowed values: jpeg, png

Default: png

Optional<string>background

Background for the generated image

Allowed values: auto, transparent, opaque

Default: auto

Optional<string>quality

Quality for the generated image

Allowed values: auto, low, medium, high

Default: auto

Optional<string>aspect_ratio

The aspect ratio of the generated image.

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

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

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async