Skip to main content
POST
Submission returns a task_id. Use Query Task Status to track completion, or supply callback_url for completion and failure notifications.

Parameters and combinations

prompt is required (1–10,000 characters). n defaults to 1 and accepts 1–8. quality defaults to medium. Use existing aspect ratios 1:1, 1:1 HD, 4:3, 3:4, 16:9, 9:16, or a supported WIDTHxHEIGHT size. image_urls must contain exactly one primary image. Pass additional references through reference_image_urls: at most four without a mask, or three with mask_url. size defaults to auto. A mask or edit_precision=high requires auto (or omitted size). edit_precision defaults to regular. For regular unmasked edits, custom dimensions must be at least 256, divisible by 32, total at most 4,194,304 pixels, and aspect ratio at most 6:1. A mask must match the primary image dimensions and contain both black (edit) and white (preserve) areas. Image-content requirements are checked during processing. quality accepts very_low, low, medium, and high.

Examples

Task results

The query response uses the common task structure: task_id, status, progress, files, and error_message. A finished task has status="finished"; each result file has file_url and file_type. Preserve the task ID while polling. Images appear as file_type="image".

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
model
enum<string>
required
Available options:
ideogram-v4.5-edit
input
object
required
callback_url
string<uri>

Optional completion or failure callback URL.

Response

200 - application/json

Task accepted; query the task for final files.

code
integer
required
Example:

200

data
object
required