Skip to content

Ideogram 4.5 Edit

POST/v1/run

Ideogram 4.5 edits an image from a text instruction, with an optional mask and style references, with reliable text rendering and polished graphic design output.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to ideogram/4.5/edit.

Default: ideogram/4.5/edit

stringpromptrequired

The generation or editing prompt.

stringimagerequired

Primary source image to edit.

Optional<string>mask

Mask matching the source dimensions. Black edits, white preserves. Must contain both regions after rounding.

Optional<string>edit_precision

regular uses Generate; high uses Precise Edit with unchanged-pixel restoration. Both always prepare structured edit instructions.

Allowed values: regular, high

Default: regular

Optional<array<string>>reference_image_urls

Up to four references plus the primary source, or three references plus the primary source and mask.

Optional<string>quality

Quality tier for either edit precision. Defaults to medium.

Allowed values: very_low, low, medium, high

Default: medium

Optional<string>aspect_ratio

The aspect ratio of the generated image.

Allowed values: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16

Optional<integer>seed

Random seed. Omit to choose automatically.

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: image-to-image

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async