Sign in

v4

latestOpenAPI 3.0.22026-08-02109239415.7 KB
generate

Generate with P-Image Ideogram

Generates images synchronously using P-Image Ideogram. quality selects the generation quality level and resolution selects the output-size tier. Both parameters have defaults.

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

post/v1/text-to-image/p-image-ideogram

Request body

promptstring required

The prompt for image generation. Accepts either natural language or a structured Ideogram 4.0 JSON prompt; the server detects which was supplied.

prompt_upsampling'AUTO' | 'ON' | 'OFF'

Determine if MagicPrompt should be used in generating the request or not.

seedinteger nullable

Random seed for reproducibility.

magic_prompt_system_prompt_config_idstring

A base64url-encoded magic prompt system prompt config ID to use for this request.

quality'VERY_LOW' | 'LOW' | 'MEDIUM' | 'HIGH'

The generation quality level. Higher levels may use more inference steps or additional prompt processing.

resolution'1K' | '2K'

The output-size tier for P-Image Ideogram.

aspect_ratio'1x3' | '3x1' | '1x2' | '2x1' | '9x16' | '16x9' | '10x16' | '16x10' | '2x3' | '3x2' | '3x4' | '4x3' | '4x5' | '5x4' | '1x1'

The aspect ratio to use for image generation, which determines the image's resolution. Cannot be used in conjunction with resolution. Defaults to 1x1.

custom_widthinteger nullable

Optional. An exact output width in pixels, used together with custom_height for output sizes outside the preset tiers. Must be a positive multiple of 16 between 16 and 4096, and custom_width × custom_height must not exceed 4,194,304 pixels (2048×2048). Cannot be combined with resolution or aspect_ratio; the request is billed at the resolution tier matching its total pixel count.

custom_heightinteger nullable

Optional. An exact output height in pixels, used together with custom_width. See custom_width for the accepted range and billing behavior.

enable_copyright_detectionboolean nullable

Optional. Opt this request into post-generation copyright detection.

Example request

{
  "prompt_upsampling": "ON"
}

Response

Image(s) generated successfully.

response_type'url'

Discriminator for the postGenerateDesignV4 oneOf response. Always "url" for this shape.

createdstring date-time required

The time the request was created.

Example response

{
  "data": [
    {
      "seed": 12345,
      "prompt": "prompt",
      "resolution": "1024x1024",
      "url": "https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89",
      "is_image_safe": true
    },
    {
      "seed": 12345,
      "prompt": "prompt",
      "resolution": "1024x1024",
      "url": "https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89",
      "is_image_safe": true
    }
  ],
  "created": "2000-01-23T04:56:07+00:00",
  "response_type": "url"
}