Sign in
Workspace LLM

Create a model on your AI provider

Changed on
post/workspaces/{workspaceSlug}/llm/connections/{connectionId}/models

Request

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

Path parameters

workspaceSlugstring required

Workspace slug

connectionIdinteger required

Request body

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

Model brand declared by an admin; display only

contextWindowinteger

Context window in tokens

dataHandlingNotestring

Admin-only note: region, agreement, renewal date

displayNamestring required

Human-readable name

enabledboolean

Whether the model is active (default false)

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); required when the model has a price

per1mOutputUsdnumber

Output rate per 1M tokens (USD); required when the model has a price

priceNotestring

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

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

Pricing mode (default UNPRICED)

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

Reasoning effort to request; null sends none, so the provider's own default applies

slugstring

Optional internal slug; generated from displayName when omitted

upstreamModelIdstring required

Upstream provider model id

Response

Model created; URL in the Location header

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

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$