Reframe

POST

Reframe a square image to a chosen resolution. The supported image formats include JPEG, PNG, and WebP.

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

Request

This endpoint expects a multipart form containing a file.

image_filefileRequired

resolutionenumRequired

(For model_version for 2.0 only, cannot be used in conjunction with aspect_ratio) The resolution to use for image generation, represented in width x height. If not specified, defaults to using aspect_ratio.

modelenumRequired

The model used to generate an image or edit one. /generate and /remix supports all model types, however, /edit is only supported for V_2 and V_2_TURBO.

num_imagesintegerOptional>=1<=8

seedintegerOptional>=0<=2147483647

style_typeenumOptional

The style type to generate with; this is only applicable for models V_2 and above and should not be specified for model versions V_1.

Response

Image re-frames generated successfully.

createddatetime

The time the request was created.

datalist of objects

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

Errors

POST

1 curl -X POST https://api.ideogram.ai/reframe \
2      -H "Api-Key: <apiKey>" \
3      -H "Content-Type: multipart/form-data" \
4      -F image_file=@<file1> \
5      -F resolution="RESOLUTION_512_1536" \
6      -F model="V_1"

200Successful

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       "style_type": "REALISTIC"
11     }
12   ]
13 }

Built with

1	curl -X POST https://api.ideogram.ai/reframe \
2	-H "Api-Key: <apiKey>" \
3	-H "Content-Type: multipart/form-data" \
4	-F image_file=@<file1> \
5	-F resolution="RESOLUTION_512_1536" \
6	-F model="V_1"

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	"style_type": "REALISTIC"
11	}
12	]
13	}