Reframe (legacy) | Ideogram

curl -X POST https://api.ideogram.ai/reframe \
     -H "Api-Key: <apiKey>" \
     -H "Content-Type: multipart/form-data" \
     -F image_file=@string \
     -F resolution="RESOLUTION_1024_1024" \
     -F model="V_2_TURBO"

{
  "created": "2000-01-23 04:56:07+00:00",
  "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"
    }
  ]
}

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.

curl -X POST https://api.ideogram.ai/reframe \
     -H "Api-Key: <apiKey>" \
     -H "Content-Type: multipart/form-data" \
     -F image_file=@string \
     -F resolution="RESOLUTION_1024_1024" \
     -F model="V_2_TURBO"

{
  "created": "2000-01-23 04:56:07+00:00",
  "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"
    }
  ]
}

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.

Authentication

Api-Keystring

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

Request

A request to reframe an image in a new resolution.

image_filefileRequired

The image being reframed (max size 10MB); only JPEG, WebP and PNG formats are supported at this time.

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.

modelenumRequiredDefaults to V_2

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_imagesintegerOptional1-8Defaults to 1

The number of images to generate.

seedintegerOptional0-2147483647

Random seed. Set for reproducible generation.

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

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

429

Too Many Requests Error

$	curl -X POST https://api.ideogram.ai/reframe \
>	-H "Api-Key: <apiKey>" \
>	-H "Content-Type: multipart/form-data" \
>	-F image_file=@string \
>	-F resolution="RESOLUTION_1024_1024" \
>	-F model="V_2_TURBO"

1	{
2	"created": "2000-01-23 04:56:07+00:00",
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	"upscaled_resolution": "4096x4096",
11	"style_type": "REALISTIC"
12	}
13	]
14	}