Skip to main content
PATCH
Update a model

Authorizations

Authorization
string
header
required

User-bound credential carrying an identity: either a session JWT or a user access token (at:*) generated from the user settings UI. Send as Authorization: Bearer <token>. Org API keys (iak_*) are not accepted here - they carry no user identity. Use the x-prismeai-api-key header instead (see OrgApiKeyAuth).

Path Parameters

modelId
string
required

Identifier of the model document. Model IDs may contain forward slashes (e.g. bedrock/anthropic.claude-3-haiku, eu.anthropic.claude-sonnet-4-20250514-v1:0); the workspace router declares this parameter as a catch-all so consumers SHOULD send the slashes unencoded in the path.

Body

application/json

Partial-update shape for PATCH /v1/models/{modelId}. Only fields present in the body are applied. model_id is taken from the path, not the body.

type
enum<string>
Available options:
completion,
embeddings,
image_generation
Maximum string length: 64
display
object
capabilities
object
limits
object
failover
string
Maximum string length: 128
region
string
Maximum string length: 64
dimensions
any
supported_dimensions
any
metrics
any
provider_config
any
pricing
any
tags
any
org_slugs
any
enabled
any

Response

Updated model document.

Model catalogue document. The catalogue is the source of truth for provider routing, capabilities, pricing, and per-org availability.

model_id
string
required

Stable identifier (matches the value sent in request.model).

Maximum string length: 128
type
enum<string>
required

Model family.

Available options:
completion,
embeddings,
image_generation
Maximum string length: 64
display
object

Display metadata (label, brand, hidden flag).

capabilities
object

Flags advertising what the model supports.

limits
object

Provider-side limits (e.g. context window, max tokens).

failover
string

Optional model_id to route to when the primary fails.

Maximum string length: 128
region
string

Hosting region (free-text).

Maximum string length: 64
dimensions
any

Default embedding dimensionality (embeddings models only).

supported_dimensions
number[]

Allowed values for the request dimensions parameter.

metrics
any

Free-form metrics block (latency, throughput hints, …).

provider_config
object

Provider-specific configuration (batch size, parallelism, …).

pricing
object

Cost configuration used to compute usage.cost.

tags
string[]

Free-form tags used by the search/filter UI.

org_slugs
string[]

When set and non-empty, restricts the model to the listed organizations. Empty / missing means the model is available to all orgs (subject to governance overlays).

enabled
boolean

When false, the model is hidden from routing.