Edit image

Creates an edited image from one or more source images and a prompt.

Authorization

bearerAuth

AuthorizationBearer <token>

Bearer token authentication using API keys

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

images*array<>

Input image references to edit. Provide image_url as HTTPS URL or data URL.

Items1 <= items <= 16

prompt*string

A text description of the desired image edit.

Length1 <= length

background?string

Background behavior for generated image output.

Value in"transparent" | "opaque" | "auto"

input_fidelity?string

Controls fidelity to the original input image(s).

Value in"high" | "low"

model?string

The model to use for image editing.

n?integer

The number of edited images to generate.

Range1 <= value <= 10

output_compression?integer

Compression level for jpeg or webp output.

Range0 <= value <= 100

output_format?string

Output image format.

Value in"png" | "jpeg" | "webp"

quality?string

Output quality for image models.

Value in"low" | "medium" | "high" | "auto"

size?string

Requested output image size. Supported values depend on the model and provider.

aspect_ratio?string

The aspect ratio of the edited images (e.g. '1:1', '16:9', '4:3', '5:4'). Takes precedence over size-derived defaults.

Response Body

`application/json`

curl -X POST "https://example.com/v1/images/edits" \  -H "Content-Type: application/json" \  -d '{    "images": [      {        "image_url": "https://example.com/source-image.png"      }    ],    "prompt": "Add a watercolor effect to this image"  }'

{
  "created": 0,
  "data": [
    {
      "b64_json": "string",
      "revised_prompt": "string"
    }
  ],
  "background": "transparent",
  "output_format": "png",
  "quality": "low",
  "size": "string",
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 0
    },
    "output_tokens": 0,
    "total_tokens": 0,
    "output_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 0
    }
  }
}

Edit image

Authorization

Request Body

Response Body

200application/json

`application/json`