Remix — Ideogram | Documentation

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

Request

This endpoint expects a multipart form containing a file.

image_requestobjectRequired

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

image_filefileRequired

Response

This endpoint returns an object.

createddatetime

The time the request was created.

datalist of objects

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

Errors

1 curl -X POST https://api.ideogram.ai/remix \ 2 -H "Api-Key: <apiKey>" \ 3 -H "Content-Type: multipart/form-data" \ 4 -F image_request='{ 5 "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.", 6 "aspect_ratio": "ASPECT_10_16", 7 "image_weight": 50, 8 "magic_prompt_option": "ON", 9 "model": "V_2" 10 }' \ 11 -F image_file=@<file1>

1 { 2 "created": "2000-01-23T04:56:07Z", 3 "data": [ 4 { 5 "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.", 6 "resolution": "1024x1024", 7 "is_image_safe": true, 8 "seed": 12345, 9 "url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g" 10 }, 11 { 12 "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.", 13 "resolution": "1024x1024", 14 "is_image_safe": true, 15 "seed": 12345, 16 "url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g" 17 } 18 ] 19 }

1	curl -X POST https://api.ideogram.ai/remix \
2	-H "Api-Key: <apiKey>" \
3	-H "Content-Type: multipart/form-data" \
4	-F image_request='{
5	"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.",
6	"aspect_ratio": "ASPECT_10_16",
7	"image_weight": 50,
8	"magic_prompt_option": "ON",
9	"model": "V_2"
10	}' \
11	-F image_file=@<file1>

1	{
2	"created": "2000-01-23T04:56:07Z",
3	"data": [
4	{
5	"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.",
6	"resolution": "1024x1024",
7	"is_image_safe": true,
8	"seed": 12345,
9	"url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g"
10	},
11	{
12	"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.",
13	"resolution": "1024x1024",
14	"is_image_safe": true,
15	"seed": 12345,
16	"url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g"
17	}
18	]
19	}