v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB
Message

Edit Image

Uses gpt-image-1 to edit an images based on a given prompt. Note that the images must be base64 encoded and all must have the same mime type.

post/api/message/edit_image

Headers

TR-Datasetstring uuid required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Request body

mime_typestring nullable

The mime type of the uploaded image(s)

ninteger nullable

The number of images to generate (default: 1)

promptstring required

The prompt describing the desired edit

quality'low' | 'medium' | 'high'
size'1024x1024' | '1024x1536' | '1536x1024'

Response

A list of base64 encoded images

image_urlsstring[] required

The URL of the generated image