Skip to main content
PUT
Set a custom API

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.

name
string
required

Environment variable name of the custom API, for example STRIPE_KEY. Provider names (ANTHROPIC_*, OPENAI_*, and so on) and names that end in _BASE_URL are reserved.

Pattern: ^[A-Z_][A-Z0-9_]{0,63}$

Body

application/json
value
string
required

The secret. The sandbox gets it as the variable named in the path.

Maximum string length: 8192
baseUrl
string<uri>
required

Public HTTPS base URL of the API, on the default port, with a DNS name. The sandbox gets it as <NAME>_BASE_URL.

Example:

"https://api.stripe.com/v1"

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.