Skip to main content
GET
Retrieve one of your models
Gibt das vollständige Detail zu einem einzelnen Modell zurück, das deiner Organisation gehört, inklusive presigned Referenzbild-URLs, dem Default-Prompt, Trigger-Wörtern und dem user_instruction des Modells. Dieses user_instruction ist die stets angewandte Guidance des Modells: Es wird als verbindliche (“MUST FOLLOW”) Vorgabe in jede Bild- und Videogenerierung eingespeist, die das Modell komponiert — keine passiven Metadaten. Es steht im Gegensatz zum default_prompt, einer KI-generierten Fähigkeitsbeschreibung, die ebenfalls bei der Generierung angehängt wird. Setze oder ändere es über PATCH /models/{model_id}. Unbekannte, zu einer anderen Organisation gehörende oder gelöschte ids liefern 404 not_found. Erfordert den models.read Scope.

Autorisierungen

Authorization
string
header
erforderlich

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

Pfadparameter

model_id
string<uuid>
erforderlich

Antwort

Successful Response

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

id
string<uuid>
erforderlich
name
string
erforderlich
Beispiel:

"Acme Brand Style"

status
enum<string>
erforderlich

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

Verfügbare Optionen:
pending,
processing,
completed,
failed
Beispiel:

"completed"

is_ready
boolean
erforderlich

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

Beispiel:

true

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

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

Verfügbare Optionen:
style,
object,
person,
setting
Beispiel:

"style"

thumbnail_url
string | null

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

Beispiel:

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

Beispiel:
user_instruction
string | null

Free-text guidance for how to use the model.

Beispiel:

"Use for hero banners and social posts."

default_prompt
string | null

The model's default prompt / capability description.

Beispiel:

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

trigger_words
string[]

Trigger words associated with the model.

Beispiel: