Skip to main content
GET
Retrieve one of your models
Restituisce il dettaglio completo di un singolo modello di proprietà della tua organizzazione, incluse le presigned URL delle immagini di riferimento, il prompt predefinito, le trigger word e lo user_instruction del modello. Questo user_instruction è la guida sempre applicata del modello: viene iniettato come direttiva obbligatoria (“MUST FOLLOW”) in ogni generazione di immagini e video che compone il modello — non sono metadati passivi. Si distingue dal default_prompt, una descrizione delle capacità generata dall’IA che viene anch’essa aggiunta alla generazione. Impostalo o modificalo tramite PATCH /models/{model_id}. Gli id sconosciuti, di un’altra organizzazione o eliminati restituiscono 404 not_found. Richiede lo scope models.read.

Autorizzazioni

Authorization
string
header
obbligatorio

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

Parametri del percorso

model_id
string<uuid>
obbligatorio

Risposta

Successful Response

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

id
string<uuid>
obbligatorio
name
string
obbligatorio
Esempio:

"Acme Brand Style"

status
enum<string>
obbligatorio

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

Opzioni disponibili:
pending,
processing,
completed,
failed
Esempio:

"completed"

is_ready
boolean
obbligatorio

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

Esempio:

true

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

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

Opzioni disponibili:
style,
object,
person,
setting
Esempio:

"style"

thumbnail_url
string | null

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

Esempio:

"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.

Esempio:
user_instruction
string | null

Free-text guidance for how to use the model.

Esempio:

"Use for hero banners and social posts."

default_prompt
string | null

The model's default prompt / capability description.

Esempio:

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

trigger_words
string[]

Trigger words associated with the model.

Esempio: