Sign in
images-edit

Edit images with Gemini 3.0 Pro from an instruction, by asset id or by uploaded bytes

Edit one or more source images by describing the change in plain language, with output up to 4K. Supply the sources either as image_asset_identifiers references (images already stored with Ideogram) or as raw images bytes (multipart requests only) — callers are never required to upload assets first. If both are supplied, the references win and the bytes are ignored.

By default the request blocks until the edited images are ready and returns them in data. Set async to true to return immediately after the request is accepted, then poll for completion and results with GET /v1/generations/{generation_id} using the returned generation_id.

Supplying a webhook_url makes the request asynchronous whatever async says: the response returns as soon as the request is accepted, and the finished result is POSTed to that URL.

post/v2/images/edit/gemini-3.0-pro

Request body

promptstring required

The edit instruction to apply to the source images.

imagesstring[]

The source images to edit (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if image_asset_identifiers is also supplied.

num_imagesinteger

The number of edited images to generate.

seedinteger

Random seed. Set for reproducible generation.

aspect_ratiostring

The requested output aspect ratio, for example "1:1", "16:9", or "9:16". The output is served at the closest aspect ratio the model supports, at the requested resolution_tier. Defaults to "1:1".

resolution_tier'1K' | '2K' | '4K'

The output resolution tier. The model sizes its output by tier and aspect ratio; exact pixel dimensions cannot be requested. Defaults to "1K".

asyncboolean

When false (the default), the request blocks until the edited images are ready and returns them in data. When true, the request returns as soon as it is accepted; poll for completion and results with GET /v1/generations/{generation_id} using the returned generation_id.

webhook_urlstring uri

HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a JSON POST to this URL once all images for the request have finished generating. The body mirrors the synchronous generate response: request_id, created, and a data array containing every generated image (url, prompt, resolution, seed, is_image_safe). Each delivery is signed with Ed25519 and verifiable against the public keys at https://api.ideogram.ai/v1/.well-known/jwks.json. Must be HTTPS; private and loopback hosts and the cloud metadata service are rejected.

privateboolean nullable

When true or omitted, the output is kept private to your account. Set to false to publish the output to the public feed. Enterprise accounts always generate privately.

target_collection_idstring

A collection you can write to, by its URL-safe base64 collection id. The output images are added to it when the request completes.

Example request

{
  "image_asset_identifiers": [
    {
      "asset_type": "RESPONSE",
      "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
    }
  ],
  "seed": 12345,
  "webhook_url": "https://api.example.com/webhooks/ideogram"
}

Response

The edited images (synchronous requests), or an acknowledgement to poll with GET /v1/generations/{generation_id} (async requests).

generation_idstring required

URL-safe base64 ID of the accepted generation. Accepted by the GET /v1/generations/{generation_id} polling endpoint.

seedinteger required

Random seed. Set for reproducible generation.

widthinteger required

The output width in pixels this request resolved to.

heightinteger required

The output height in pixels this request resolved to.

Example response

{
  "data": [
    {
      "seed": 12345,
      "prompt": "prompt",
      "resolution": "2048x2048",
      "url": "https://openapi-generator.tech",
      "is_image_safe": true
    },
    {
      "seed": 12345,
      "prompt": "prompt",
      "resolution": "2048x2048",
      "url": "https://openapi-generator.tech",
      "is_image_safe": true
    }
  ],
  "seed": 12345,
  "generation_id": "generation_id",
  "width": 0,
  "height": 6
}

Changes

Changed in 3 of the 16 revisions of this API.7

  • 3eb3216eed392See the full diff
    • ○

      added the new optional request property webhook_url (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new optional request property webhook_url (media type: application/json)

      new-optional-request-property

  • 204996bf317a4See the full diff
    • ○

      added the new optional request property private (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new optional request property private (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property target_collection_id (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new optional request property target_collection_id (media type: application/json)

      new-optional-request-property

  • 898026c78d681See the full diff
    • ○

      endpoint added

      endpoint-added