API Reference

Set Anthropic API key

PUT /api/server/ai-config

Validates the key with Anthropic, then stores it encrypted as a Settings override (takes precedence over yaml).

Operation IDputServerAiConfig

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Request body

This request body is required.

Content typeapplication/json

requestobject

1 property

api_keystringrequired

Success response body

200Key saved

Key saved

Content typeapplication/json

responseobject

3 properties

configuredboolean

sourcestring

Allowed values: settings, yaml

default_modelstring

Error responses

400Missing api_key (VALIDATION_ERROR) or key rejected by Anthropic (INVALID_KEY)

Missing api_key (VALIDATION_ERROR) or key rejected by Anthropic (INVALID_KEY)

No response content schema is documented.

403Requires admin or superadmin

Requires admin or superadmin

No response content schema is documented.

502Anthropic unreachable — key not validated or persisted (ANTHROPIC_UNREACHABLE)

Anthropic unreachable — key not validated or persisted (ANTHROPIC_UNREACHABLE)

No response content schema is documented.

Code examples

curl --request PUT \
  --url 'https://your-envoy.example.com/api/server/ai-config' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "api_key": "string"
}'

const response = await fetch("https://your-envoy.example.com/api/server/ai-config", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "api_key": "string"
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);