Skip to main content
POST
  1. After submission, a task_id will be returned. If you provided a callback_url, when the task status becomes finished or failed, a POST request will be sent to the callback_url.
  2. Regardless of whether callback_url is provided, you can retrieve the response result through the unified Query Task Status endpoint.
The Ideogram 4.6 API brings Ideogram’s latest image model to PoYo. Use it for posters, logos, packaging, social graphics, and any image where the words on the picture need to be right. The Ideogram 4.6 API takes a prompt and returns 1 to 8 images, with a choice of four quality levels, aspect-ratio presets or exact sizes up to 4096 pixels per side, and an optional transparent background. To change an existing image, use the Ideogram 4.6 Edit API.

Ideogram 4.6 API models

  • ideogram-v4.6 — Text-to-image generation with quality, size, background, and seed controls
  • ideogram-v4.6-edit — Image editing with masks and reference images. See Ideogram V4.6 Edit

Ideogram 4.6 API features

  • Text in images: Put the exact words in the prompt, for example a title or a sign, and the model renders them on the image.
  • Four quality levels: very_low for fast drafts, then low, medium (default), and high.
  • Sizes up to 4K: auto, six aspect-ratio presets, or a custom WIDTHxHEIGHT from 256 to 4096 pixels per side.
  • Transparent backgrounds: Set background to transparent to get an image with an alpha channel, ready for stickers, icons, and logos.
  • Batches and seeds: Generate up to 8 images per request, and set seed to repeat a result.

Required parameters

  • prompt (string): Description of the image, 1–10,000 characters. Must contain non-whitespace text. Put any exact on-image text in quotes.

Optional parameters

  • size (string): auto, 1:1, 1:1 HD, 4:3, 3:4, 16:9, 9:16, or a custom WIDTHxHEIGHT. Default is auto. See Size.
  • quality (string): very_low, low, medium, or high. Default is medium. very_low is limited to outputs of at most 4,194,304 pixels (2048×2048 in area).
  • n (integer): Number of images, 1 to 8. Default is 1.
  • background (string): transparent or opaque. transparent returns an image with an alpha channel; opaque forces a solid background. Omit it to let the model decide.
  • seed (integer): Random seed, 0 to 2147483647. Omit it to pick one automatically.
  • callback_url (string): Optional webhook URL for task completion notification. Send it at the top level of the request, not inside input.
The Ideogram 4.6 API accepts only these fields in input. Any other field is rejected with an unsupported fields error.

Size

Custom sizes use a lowercase x, for example 2048x1152. Both sides must be from 256 to 4096 pixels and multiples of 32, and the aspect ratio must be within 1:6 and 6:1. Sizes that the Ideogram 4.5 API accepted but are not multiples of 32, such as 1296x3168, are rejected.

Output

When the task is finished, files contains one entry per generated image, each with file_url and file_type: image. With background set to transparent, the images have an alpha channel.

Ideogram 4.6 API examples

Send each Ideogram 4.6 API request below to POST /api/generate/submit with your API key in the Authorization header.

Text To Image

This request uses the defaults (auto, medium, one image).

Poster At 4K Size

2048x3072 is 6,291,456 pixels, which is above 4,194,304 pixels, so very_low is not available at this size.

Transparent Sticker

Notes

  • very_low with a custom size above 4,194,304 pixels is rejected with the message “very_low quality supports sizes up to 2048x2048 pixels in area (4,194,304 pixels)”.
  • n must be an integer. Strings and booleans are rejected.
  • Prompt expansion is always on for the Ideogram 4.6 API, as it is for Ideogram 4.5.
  • Generated image files are accessible for 3 days after creation. Download and store them promptly.
  • The response returns a task_id. Query the task status to get the generated images.

Authorizations

Authorization
string
header
required

All API endpoints require Bearer Token authentication.

Create an API key: sign in to PoYo, open Dashboard → API Key at poyo.ai/dashboard/api-key, and click to create a key.

Add it to the request header:

Body

application/json
model
enum<string>
required

Ideogram 4.6 text-to-image model identifier.

Available options:
ideogram-v4.6
input
object
required

Generate 1-8 images from a prompt.

callback_url
string<uri>

Optional webhook URL for task completion or failure.

Response

Task submitted successfully

code
enum<integer>
required

Business status code. 200 means success; any other value means the request failed. Always check this field: some validation errors return HTTP 200 with code: 400 in the body.

  • 200: Success
  • 400: Invalid request parameters
  • 401: Missing or invalid API key
  • 402: Insufficient credits
  • 403: Permission denied
  • 404: Resource not found
  • 408: Request timeout
  • 429: Rate limit exceeded
  • 500: Internal server error
  • 502: Upstream service error
  • 503: Service unavailable

See Error Codes for details.

Available options:
200,
400,
401,
402,
403,
404,
408,
429,
500,
502,
503
Example:

200

data
object
required