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.

Authentication

Api-Keystring

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

Request

A request to generate an image with P-Image Ideogram.

promptstringRequired

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

prompt_upsamplingenumOptional

Controls magic-prompt (prompt upsampling). Defaults to AUTO.

Allowed values:
seedinteger or nullOptional
Random seed for reproducibility.
qualityenumOptional

The generation quality level. Defaults to MEDIUM.

Allowed values:
resolutionenumOptional

The output-size tier. Defaults to 1K.

Allowed values:
aspect_ratioenumOptional

The output aspect ratio. Defaults to 1x1.

custom_widthinteger or nullOptional
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 or nullOptional

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

Response

Image(s) generated successfully.

createddatetime
The time the request was created.
datalist of objects

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

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

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
429
Too Many Requests Error