Sign in
images-remix

Remix an existing image with Ideogram 4.0, guided by a prompt

Transform an existing image with Ideogram 4.0, guided by a text prompt. Supply the source either as an image_asset_identifier reference (an image already stored with Ideogram) or as raw image bytes (multipart requests only). Supplying both is rejected rather than one being ignored. image_weight controls how closely the result follows the source; when omitted the server picks a value from your prompt.

Omit resolution to keep the source image's shape. A resolution whose aspect ratio differs from the source's cannot be combined with image_weight — that request is rejected with a 400.

The prompt is always interpreted by an instruction-editing model, so there is no magic_prompt option. Remixes are not reproducible, so no seed is accepted; the response reports the seed the request resolved to.

By default the request blocks until the 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/image/remix/ideogram-4

Query parameters

dry_runboolean

When true, the request is validated and priced but not run: nothing is generated, stored, or billed, and no safety review is performed. The response is a PriceQuote object instead of the usual response for this endpoint. Send exactly the request you would send to generate, so the quote reflects the same options.

Request body

promptstring required

The prompt that guides the remix.

imagestring binary

The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or image_asset_identifier, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image.

image_weightinteger

Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. Only accepted when the output keeps the source image's shape: combining image_weight with a resolution whose aspect ratio differs from the source's is rejected with a 400.

num_imagesinteger

The number of images to generate.

resolution'2048x2048' | '1440x2880' | '2880x1440' | '1664x2496' | '2496x1664' | '1792x2240' | '2240x1792' | '1440x2560' | '2560x1440' | '1600x2560' | '2560x1600' | '1728x2304' | '2304x1728' | '1296x3168' | '3168x1296' | '1152x2944' | '2944x1152' | '1248x3328' | '3328x1248' | '1280x3072' | '3072x1280' | '1024x3072' | '3072x1024' | '1024x1024' | '896x1120' | '1120x896' | '864x1152' | '1152x864' | '832x1248' | '1248x832' | '800x1280' | '1280x800' | '720x1280' | '1280x720' | '720x1440' | '1440x720' | '512x1536' | '1536x512'

The 1K and 2K resolutions supported for Ideogram 4.0 image generation.

rendering_speed'turbo' | 'default' | 'quality'

The rendering speed to use.

enable_copyright_detectionboolean nullable

Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with is_image_safe: false.

asyncboolean

When false (the default), the request blocks until the 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_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "resolution": "2048x2048",
  "webhook_url": "https://api.example.com/webhooks/ideogram"
}

Response

The remixed 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.

Example response

{
  "data": [
    {
      "seed": 12345,
      "prompt": "prompt",
      "resolution": "1024x1024",
      "url": "https://openapi-generator.tech",
      "is_image_safe": true
    },
    {
      "seed": 12345,
      "prompt": "prompt",
      "resolution": "1024x1024",
      "url": "https://openapi-generator.tech",
      "is_image_safe": true
    }
  ],
  "seed": 12345,
  "generation_id": "generation_id"
}

Changes

Changed in 3 of the 33 revisions of this API.613

  • 987f73fc82de4See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 4e95197be44a68See the full diff
    • ▲

      removed the enum value DEFAULT of the request property (media type: multipart/form-data)

      request-property-enum-value-removed

    • ▲

      removed the enum value DEFAULT of the request property (media type: application/json)

      request-property-enum-value-removed

    • ▲

      removed the enum value QUALITY of the request property (media type: multipart/form-data)

      request-property-enum-value-removed

    • ▲

      removed the enum value QUALITY of the request property (media type: application/json)

      request-property-enum-value-removed

    • ▲

      removed the enum value TURBO of the request property (media type: multipart/form-data)

      request-property-enum-value-removed

    • ▲

      removed the enum value TURBO of the request property (media type: application/json)

      request-property-enum-value-removed

    • ○

      the request property default value changed from DEFAULT to default (media type: multipart/form-data)

      request-property-default-value-changed

    • ○

      the request property default value changed from DEFAULT to default (media type: application/json)

      request-property-default-value-changed

    • ○

      added the new default enum value to the request property (media type: multipart/form-data)

      request-property-enum-value-added

    • ○

      added the new default enum value to the request property (media type: application/json)

      request-property-enum-value-added

    • ○

      added the new quality enum value to the request property (media type: multipart/form-data)

      request-property-enum-value-added

    • ○

      added the new quality enum value to the request property (media type: application/json)

      request-property-enum-value-added

    • ○

      added the new turbo enum value to the request property (media type: multipart/form-data)

      request-property-enum-value-added

    • ○

      added the new turbo enum value to the request property (media type: application/json)

      request-property-enum-value-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9d3ff2d98e271See the full diff
    • ○

      endpoint added

      endpoint-added