Sign in
Workspace LLM

Update a model on your AI provider

patch/workspaces/{workspaceSlug}/llm/models/{id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/llm/models/{id}
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

idinteger required

Request body

brand'OPENAI' | 'ANTHROPIC' | 'GEMINI' | 'GEMMA' | 'META' | 'MISTRAL' | 'QWEN' | 'DEEPSEEK' | 'XAI' | 'COHERE' | 'Z_AI' | 'MOONSHOT'

Model brand declared by an admin; null keeps current

clearBrandboolean

Clear the declared model brand

clearReasoningEffortboolean

True clears the reasoning effort, so the provider's own default applies

contextWindowinteger

Context window in tokens

dataHandlingNotestring

Admin-only note: region, agreement, renewal date

displayNamestring

Human-readable name

enabledboolean

Active toggle

maxOutputTokensinteger

Maximum output tokens

operatedBy'OWN_ORGANISATION' | 'PROVIDER'

Who operates the systems the work is sent to; omit to leave the model undeclared

per1mCacheReadUsdnumber

Cache-read rate per 1M tokens (USD), if applicable

per1mCacheWriteUsdnumber

Cache-write rate per 1M tokens (USD), if applicable

per1mInputUsdnumber

Input rate per 1M tokens (USD)

per1mOutputUsdnumber

Output rate per 1M tokens (USD)

priceNotestring

Note; required when the model is free (e.g. self-hosted, no cost)

pricingMode'PRICED' | 'NO_CHARGE' | 'UNPRICED'

Pricing mode; when given, replaces the price wholesale (see class docs)

reasoningEffort'NONE' | 'MINIMAL' | 'LOW' | 'MEDIUM' | 'HIGH' | 'XHIGH' | 'MAX'

Reasoning effort to request; null keeps the current one (see clearReasoningEffort)

Response

OK

brand'OPENAI' | 'ANTHROPIC' | 'GEMINI' | 'GEMMA' | 'META' | 'MISTRAL' | 'QWEN' | 'DEEPSEEK' | 'XAI' | 'COHERE' | 'Z_AI' | 'MOONSHOT'

Model brand declared by an admin; display only

connectionDisplayNamestring required

Owning connection's display name

connectionIdinteger required

Owning connection id

contextWindowinteger

Context window in tokens

createdAtstring date-time required

Creation timestamp

currencystring required

Currency code

dataHandlingNotestring

Admin-only note: region, agreement, renewal date

dataHandlingTier'IN_HOUSE' | 'CLOUD' | 'UNDECLARED' required

Data-handling tier derived from the operator; UNDECLARED until it is set

displayNamestring required

Human-readable name

enabledboolean required

Active toggle

idinteger required

Model id

maxOutputTokensinteger

Maximum output tokens

operatedBy'OWN_ORGANISATION' | 'PROVIDER'

Who operates the systems the work is sent to; null until declared

per1mCacheReadUsdnumber

Cache-read rate per 1M tokens (USD)

per1mCacheWriteUsdnumber

Cache-write rate per 1M tokens (USD)

per1mInputUsdnumber

Input rate per 1M tokens (USD)

per1mOutputUsdnumber

Output rate per 1M tokens (USD)

priceNotestring

Price note

pricingMode'PRICED' | 'NO_CHARGE' | 'UNPRICED' required

Pricing mode

reasoningEffort'NONE' | 'MINIMAL' | 'LOW' | 'MEDIUM' | 'HIGH' | 'XHIGH' | 'MAX'

Reasoning effort requested of the model; null sends none, the provider's default applies

slugstring required

Unique slug within the workspace

updatedAtstring date-time

Last update timestamp

upstreamModelIdstring required

Upstream provider model id

Changes

No recorded changes to this operation across all 1 revision of this API.