Sign in
v1
protected
provider-configs

Create Provider Config

Create a new provider configuration.

post/v1/workspaces/{workspace}/provider-configs/

Path parameters

workspacestring required

Slug of the workspace the request acts in

Slug of the workspace the request acts in

Request body

api_keystring nullable

Secret API key for the provider. Stored encrypted in the secret manager; never returned in responses. May be empty for proxies that accept keyless traffic — the backend suppresses the Authorization header when this is empty.

api_key_secret_idstring uuid nullable

Use an existing workspace secret as the API key instead of supplying one here. Mutually exclusive with api_key. The secret keeps its own lifecycle: several configurations may share it, and it cannot be deleted while any of them still points at it.

descriptionstring nullable

Optional human-readable description of this configuration.

endpoint_urlstring nullable

Optional custom endpoint URL (e.g. for self-hosted or proxied providers). Leave unset to use the provider's default.

is_publicboolean

If True, the configuration is visible to all workspace members; otherwise it is scoped to the creator.

namestring required

Human-readable label for this provider configuration.

provider_spec_idstring uuid required

UUID of the provider specification (e.g. OpenAI, Anthropic) this configuration targets. Look up via list_specs.

Response

Successful Response

created_atstring required
created_bystring required
endpoint_urlstring nullable required
idstring required
is_activeboolean required
is_publicboolean required
managed_bystring nullable
model_instance_idsstring[]
namestring required
provider_spec_idstring required
provider_spec_keystring nullable
provider_spec_namestring nullable
requires_api_keyboolean
updated_atstring required
workspace_idstring required

Changes