Skip to main content
GET
Retrieve one of your models
Returns full detail for a single model owned by your organization, including presigned reference-image URLs, the default prompt, trigger words, and the model’s user_instruction. That user_instruction is the model’s always-applied guidance: it is injected as mandatory (“MUST FOLLOW”) direction into every image and video generation that composes the model — not passive metadata. It contrasts with default_prompt, an AI-generated capability description that is also appended at generation. Set or change it via PATCH /models/{model_id}. Unknown, other-organization, or deleted ids return 404 not_found. Requires the models.read scope.

Authorizations

Authorization
string
header
required

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

Path Parameters

model_id
string<uuid>
required

Response

Successful Response

A single model with full detail — the GET /models/{id} body (ADR §10).

id
string<uuid>
required
name
string
required
Example:

"Acme Brand Style"

status
enum<string>
required

Creation status: pending, processing, completed, or failed.

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

"completed"

is_ready
boolean
required

True when the model is completed AND active — usable for generation.

Example:

true

created_at
string<date-time>
required
updated_at
string<date-time>
required
category
enum<string> | null

Model category — one of style, object, person, setting.

Available options:
style,
object,
person,
setting
Example:

"style"

thumbnail_url
string | null

Presigned, time-limited HTTPS thumbnail URL (null when the model has none).

Example:

"https://cdn.samsa.ai/models/…/thumbnail.webp?X-Amz-Signature=…"

reference_image_urls
string[]

Presigned, time-limited HTTPS URLs of the reference images used to create the model.

Example:
user_instruction
string | null

Free-text guidance for how to use the model.

Example:

"Use for hero banners and social posts."

default_prompt
string | null

The model's default prompt / capability description.

Example:

"A bold flat-design illustration in the Acme brand palette."

trigger_words
string[]

Trigger words associated with the model.

Example: