Skip to main content
PUT
Set a credential profile API key

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Path Parameters

profile
string
required

Profile id or name.

credential
enum<string>
required

One AI credential in a credential profile. The *-api-key ids are API keys you can set with PUT /credential-profiles/{profile}/keys/{credential}. The sign-ins (*-subscription) and Bedrock (*-bedrock) are connected on the dashboard Agents & Proxying page, with the profile picked at the top; you can remove them here.

Available options:
anthropic-api-key,
openai-api-key,
openrouter-api-key,
llmgateway-api-key,
deepseek-api-key,
moonshot-api-key,
mistral-api-key,
xai-api-key,
opencode-api-key,
claude-subscription,
chatgpt-subscription,
kimi-subscription,
mistral-vibe-subscription,
grok-subscription,
claude-bedrock,
codex-bedrock

Body

application/json
value
string
required

The API key. Boat encrypts it at rest.

keepCurrent
boolean

Keep the key this one replaces as another account of the credential, ready to switch back to.

Response

The updated profile.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

success
boolean
required
profile
object
required

A named set of AI credentials. Secret values are never returned.