Skip to main content
GET
List the available image engines
Returns the text-to-image engines available to your organization, default first. Each entry lists its aspect_ratios, resolutions (with default_aspect_ratio and default_resolution), max_num_outputs, credits_per_image at each resolution, and whether it accepts trained models (supports_trained_refs) and a color palette (supports_color_palette). The endpoint is free and needs the images.generate scope. Read this endpoint before calling POST /images/generations and pass an entry’s id as engine — an engine, aspect ratio, or resolution outside the list returns 422 before any credits are charged. A request costs credits_per_image at the chosen resolution × num_outputs.
If your organization generates only with its trained models, data is empty and unavailable_reason is organization_restricted. Omit engine and pass at least one trained model (style_id, object_ids, person_ids, setting_ids) or a color_palette_id — see Image Generation. For every other caller, unavailable_reason is null.

Authorizations

Authorization
string
header
required

Organization API key (Authorization: Bearer samsa_sk_...) or OAuth 2.1 access token (Authorization: Bearer samsa_at_...).

Response

Successful Response

GET /images/models response — the public text-to-image engine catalog.

data
PublicImageEngine · object[]
required
unavailable_reason
string | null

organization_restricted when your organization generates only with its trained models (data is then empty: omit engine and pass trained models); null otherwise.

Allowed value: "organization_restricted"