Skip to main content
POST
Register or update a tool

Authorizations

Authorization
string
header
required

Your workspace API key, e.g. sk_sovereign_..., sent as Authorization: Bearer <key>.

Body

application/json

This body is camelCase (endpointUrl, authHeader), unlike the snake_case loop endpoints. Registering the same name again updates the tool.

name
string
required
endpointUrl
string
required

https-only.

authHeader
string

Full header value ("Bearer xyz"). Stored encrypted; never returned by any read.

readOnly
boolean
maxCallsPerEpisode
integer

Response

The registration (credential redacted).

id
string
name
string
endpoint_url
string
auth_prefix
string | null

A redacted prefix of the stored credential (e.g. "Bearer sk-ab…"), never the credential itself.

read_only
boolean

Read-only tools are callable during training without allowSideEffects.

max_calls_per_episode
integer
enabled
boolean
created_at
string