Remix (legacy) | Ideogram

curl -X POST https://api.ideogram.ai/remix \
     -H "Api-Key: <apiKey>" \
     -H "Content-Type: multipart/form-data" \
     -F image_request='{
  "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
  "aspect_ratio": "ASPECT_10_16",
  "image_weight": 50,
  "magic_prompt_option": "ON",
  "model": "V_2"
}' \
     -F image_file=@string

{
  "created": "2000-01-23 04:56:07+00:00",
  "request_id": "request_id",
  "data": [
    {
      "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there's an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
      "resolution": "1024x1024",
      "is_image_safe": true,
      "seed": 12345,
      "url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g",
      "upscaled_resolution": "4096x4096",
      "style_type": "REALISTIC"
    }
  ]
}

Remix provided images synchronously based on a given prompt and optional parameters.

Input images are cropped to the chosen aspect ratio before being remixed.

Supported image formats include JPEG, PNG, and WebP.

Images links are available for a limited period of time; if you would like to keep the image, you must download it.

Authentication

Api-Keystring

API key for access control. Use in the header with the name “Api-Key”

Request

A request to remix a provided image with Ideogram. Input images are cropped to the chosen aspect ratio before being remixed.

image_requestobjectRequired

A request to generate a new image using a provided image and a prompt.

image_filefileRequired

An image binary (max size 25MB); only JPEG, WebP and PNG formats are supported at this time.

Response

Image(s) generated successfully.

createddatetime

The time the request was created.

request_idstringOptional

URL-safe base64 ID of the sampling request. Present when the caller supplied webhook_url and the request was accepted for async delivery; in that case data is omitted and the generated images will be POSTed to the customer’s webhook_url when ready.

datalist of objectsOptional

A list of ImageObjects that contain the generated image(s).

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error