Skip to main content
PATCH
Update Model Configuration

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

model_configuration_id
string<uuid>
required

Body

application/json

Update a model configuration (organization-owned only).

name
string | null
Required string length: 1 - 255
description
string | null
provider
string | null
Required string length: 1 - 50
model
string | null
Required string length: 1 - 255
api_key
string | null

Raw API key; if provided, replaces the stored alias.

clear_api_key
boolean | null

If true, clears any stored api_key_alias (reverts to Cyberdesk-provided key if supported).

temperature
number | null
max_tokens
integer | null
timeout_seconds
number | null
max_retries
integer | null
additional_params
Additional Params · object | null
agent_harness_version_string
string | null
is_computer_use_model
boolean | null
is_archived
boolean | null

Response

Successful Response

API response schema for model configurations.

name
string
required
Required string length: 1 - 255
provider
string
required

LangChain provider name (e.g. 'anthropic', 'openai').

Required string length: 1 - 50
model
string
required

Provider model identifier (e.g. 'claude-sonnet-4-5-20250929').

Required string length: 1 - 255
id
string<uuid>
required
is_system_default
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
temperature
number | null
max_tokens
integer | null
timeout_seconds
number | null
max_retries
integer | null
additional_params
Additional Params · object | null

Provider-specific kwargs passed through to LangChain.

agent_harness_version_string
string | null

Agent harness version string used by Cyberdesk workers for prompt/tool selection.

is_computer_use_model
boolean
default:false

True if this model has native computer use capabilities. If True, can be used for main agent, focused actions, and fallbacks for those agents.

is_archived
boolean
default:false

Whether this model configuration is archived and should generally be hidden behind archived-model UI affordances.

organization_id
string | null
api_key_alias
string | null

Basis Theory token id (alias) used to resolve api_key at runtime.