Sign in

v4

latestOpenAPI 3.0.22026-08-02109239415.7 KB
generate

Generate (legacy)

Generates images synchronously based on a given prompt and optional parameters.

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

post/generate

Request body

Example request

{
  "image_request": {
    "aspect_ratio": "ASPECT_10_16",
    "magic_prompt_option": "AUTO",
    "model": "V_2",
    "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."
  }
}

Response

Image(s) generated successfully.

request_idstring

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.

createdstring date-time required

The time the request was created.

Example response

{
  "data": [
    {
      "style_type": "REALISTIC",
      "seed": 12345,
      "upscaled_resolution": "4096x4096",
      "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",
      "url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g",
      "is_image_safe": true
    },
    {
      "style_type": "REALISTIC",
      "seed": 12345,
      "upscaled_resolution": "4096x4096",
      "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",
      "url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g",
      "is_image_safe": true
    }
  ],
  "created": "2000-01-23T04:56:07+00:00",
  "request_id": "request_id"
}