Skip to main content
POST
Generate Image

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Headers

Moda-Version
enum<string>
default:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Available options:
2026-04-12,
2026-05-01
Example:

"2026-05-01"

Body

application/json
prompt
string
required

Sent to the selected model VERBATIM.

Minimum string length: 1
model
string
required

Concrete registry model id (no 'auto'); see GET /v1/media/models.

aspect_ratio
string | null
num_images
integer
default:1
Required range: 1 <= x <= 4
resolution
string | null
width
integer | null
Required range: x > 0
height
integer | null
Required range: x > 0
source_images
string[] | null

Images the prompt modifies/preserves: file_ ids or http(s) URLs.

reference_images
string[] | null

Style/subject/composition references: file_ ids or http(s) URLs.

model_params
Model Params · object | null
idempotency_key
string | null

A retried call with the same key replays the stored response (replayed:true) instead of paying for a second provider render.

Maximum string length: 200

Response

Successful Response

The response is of type Response Mediagenerateimage · object.