Skip to main content
PUT
Configure a provider credential

Authorizations

Authorization
string
header
required

Your ara_ API key from Settings > Ara API. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, knowledge:read, memory:read, memory:write, skills:read, skills:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, automations:read, automations:write, agent_auth:read. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:debug is privileged: it expands diagnostic session events only for organization owners/admins.

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

providerId
string
required

The provider identifier (e.g. openai, anthropic, google, deepseek).

Body

application/json
key
string
required

The provider API key. Write-only; never returned.

Required string length: 1 - 8192
config
object

Optional non-secret provider configuration settings (e.g. AWS_REGION, CLOUDFLARE_ACCOUNT_ID, CUSTOM_ENDPOINT_BASE_URL).

Response

Provider credential configured.

ok
boolean
required
provider_id
string
required

Provider identifier.

account_key
string
required

Account slot identifier.

account_label
string | null
required

Account slot label.

type
string
required
Allowed value: "api_key"
config_names
string[]
required

Names of configured settings.

connected
boolean
required