Skip to main content
PATCH
Update BYOK preferences

Path Parameters

project_id
string
required

Body

application/json

PATCH /v1/projects/{project_id}/byok

An omitted field is left unchanged (it used to be reset: omitting allow_platform_fallback re-enabled platform fallback); an explicit null clears model_preference and is a 422 on allow_platform_fallback.

model_preference
string | null

Optional specific model the tenant prefers from their provider. Null clears it; omit to keep it.

allow_platform_fallback
boolean | null

When False, requests that cannot be satisfied by the tenant's BYOK key fail with an explicit error instead of silently falling back to the platform's shared key. Omit to keep the stored value; null is rejected (422).

Response

BYOK preferences updated

BYOK key status (never exposes the actual key).

project_id
string
required
has_key
boolean
required
source
string
required
provider
string | null
key_preview
string | null
model_preference
string | null
allow_platform_fallback
boolean
default:true
probe_status
string | null
model_warning
string | null