Update a model
Update the editable fields (name, default prompt, instruction) of one of your models.
name, default_prompt, and instruction are editable; ownership
and privacy fields cannot be changed. instruction is the model’s always-applied
guidance (max 8000 characters), injected as mandatory (“MUST FOLLOW”) direction
into every image and video generation that composes the model — it maps to the
user_instruction returned when you read the model.
Omit a field to leave it unchanged — do not send it as an explicit null (send an
empty string to clear instruction). Unknown or other-organization ids return
404 not_found. Requires the models.write scope.Authorizations
Organization API key as a bearer token: Authorization: Bearer samsa_sk_....
Path Parameters
Body
PATCH /models/{id} body — the publicly editable fields only (ADR §10, ticket §3).
Ownership / privacy fields (owner_id, private, organization_id) are
intentionally NOT accepted. A field may be omitted (left unchanged) but must not
be sent as an explicit null — the runtime rejection lives in
_reject_explicit_null (mirroring ApiKeyUpdate), and
_string_only_patch_schema keeps the EXPORTED OpenAPI honest by advertising
each field as a plain string (no null branch) so generated clients and
the API playground cannot offer null as a value (SAM-639).
New model name.
1 - 100"Renamed Model"
New default prompt / capability description.
2000"A refined flat-design illustration in the Acme brand palette."
New always-applied model instruction (max 8000 chars) — injected into every generation that composes the model. Accepted on write under the name instruction (mirroring model creation); it maps to the user_instruction field returned on read (PublicModelDetail).
8000"Always render on a clean, seamless white background."
Response
Successful Response
A single model with full detail — the GET /models/{id} body (ADR §10).
"Acme Brand Style"
Creation status: pending, processing, completed, or failed.
pending, processing, completed, failed "completed"
True when the model is completed AND active — usable for generation.
true
Model category — one of style, object, person, setting.
style, object, person, setting "style"
Presigned, time-limited HTTPS thumbnail URL (null when the model has none).
"https://cdn.samsa.ai/models/…/thumbnail.webp?X-Amz-Signature=…"
Presigned, time-limited HTTPS URLs of the reference images used to create the model.
Free-text guidance for how to use the model.
"Use for hero banners and social posts."
The model's default prompt / capability description.
"A bold flat-design illustration in the Acme brand palette."
Trigger words associated with the model.

