Skip to main content
POST
Generate images from a prompt (and optional trained models)
Submit a prompt to generate one to four images. The call returns 202 Accepted with a job id; poll GET /images/generations/{id} for the result. Combine your organization’s trained models by passing their ids or names — style_id, object_ids, person_ids, setting_ids — plus a color_palette_id. Each ref accepts a name or id that resolves to a model or palette visible to you.

Example: compose multiple trained models

Pass a style model, one or more person and setting models, and a color palette together in one request. Every model reference — by id or name — must resolve to a completed model visible to you.
object_ids, person_ids, and setting_ids are arrays; style_id and color_palette_id take a single value (a name or id). num_outputs (1–4) defaults to 1 and each output is billed. Omit engine to use the default nano_banana_pro. aspect_ratio accepts 1:1 (default), 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 21:9, 1:4, 4:1, 1:8, and 8:1; an unsupported ratio returns 422 before any credits are charged.

Authorizations

Authorization
string
header
required

Organization API key as a bearer token: Authorization: Bearer samsa_sk_....

Body

application/json

POST /images/generations body (ADR §8, §10).

Trained-model refs (style_id, object_ids, person_ids, setting_ids) and the color_palette_id color-palette ref combine on the Gemini path — each accepts a NAME or its UUID id, resolved within your visible set (a model/palette you own, including private ones, or a non-private one shared within your organization); setting_ids maps to the internal scene_ids (ADR §8.2). engine is a public-safe subset of the image engines (ADR §8.3). Note num_outputs defaults to 1 for API ergonomics — the internal app default is 4.

prompt
string
required

Text prompt. Runs the same validation as the app (rejects empty / malformed / policy-violating prompts with a 422).

Minimum string length: 1
Example:

"A minimalist product shot of a ceramic mug on linen, soft daylight"

style_id

A style model NAME or its UUID id (from list_models), resolved within your visible set — a model you own (including your own private models) or a non-private one shared with your organization. A name matching more than one visible model is rejected — pass the id. Must be completed.

object_ids
(string<uuid> | string)[]

object models to compose in — each a model NAME or its UUID id (from list_models), resolved within your visible set (a model you own, including private, or a non-private one your organization shares). A name matching more than one visible model is rejected — pass the id.

person_ids
(string<uuid> | string)[]

person models to compose in — each a model NAME or its UUID id (from list_models), resolved within your visible set (a model you own, including private, or a non-private one your organization shares). A name matching more than one visible model is rejected — pass the id.

setting_ids
(string<uuid> | string)[]

setting models to compose in — each a model NAME or its UUID id (from list_models), resolved within your visible set (a model you own, including private, or a non-private one your organization shares). A name matching more than one visible model is rejected — pass the id. Maps to internal scenes.

color_palette_id

A color palette NAME or its UUID id, resolved within your visible set — a palette you created (including private ones) or a non-private palette shared with your organization. A name matching more than one visible palette is rejected — pass the id.

engine
string | null

Generation engine — one of nano_banana_pro (default) or nano_banana_2. Omit to use the default. Unknown engines return 422.

Example:

"nano_banana_pro"

num_outputs
integer
default:1

Number of images to generate (1-4). Defaults to 1 (the app default is 4); each output is billed.

Required range: 1 <= x <= 4
Example:

1

aspect_ratio
string
default:1:1

Aspect ratio for the generated image(s). One of 1:1 (default), 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 21:9, 1:4, 4:1, 1:8, 8:1. Unsupported ratios return 422 before any credits are charged.

Example:

"1:1"

resolution
string
default:1K

Output resolution — 1K, 2K, or 4K. Credits scale 1K:1x, 2K:2x, 4K:4x per output.

Example:

"1K"

output_format
enum<string>
default:png

Encoding of the returned images. v1 supports png only.

Available options:
png
Example:

"png"

webhook_url
string | null

Optional https webhook notified once on terminal status (signed per the webhook signature scheme; see the webhooks docs).

Example:

"https://example.com/webhooks/samsa"

Response

Successful Response

202 body for POST /images/generations (ADR §7.1).

id
string<uuid>
required

The image job id — poll GET /images/generations/{id}.

status
enum<string>
required

Initial status: always pending at submit.

Available options:
pending,
processing,
completed,
failed,
cancelled
Example:

"pending"

estimated_credits
integer
required

Credits this job is expected to cost (base 5 x num_outputs x resolution multiplier).

Example:

5