Skip to main content
POST
Create API Key
Every body field is optional:No key can hold a scope its creator lacks. Keys created here never expire; revoke one to end it. An account can hold 10 active keys. The eleventh returns 409 with reason api_key_limit.

Authorizations

Authorization
string
header
required

Privy JWT issued to the web dashboard. Sent as Authorization: Bearer <jwt>. The Privy session signer underpins all wallet-signed actions.

Body

application/json
name
string

Optional display name for the key.

preset
enum<string>

A scope bundle. With neither preset nor scopes, the key gets trading.

Available options:
read_only,
trading,
full
scopes
string[]

An explicit scope list. Overrides preset. A key can never hold a scope its creator lacks.

confirm_withdraw
boolean

Required as true when the resulting key would hold funds:withdraw.

Response

API key created (full key visible once)

data
object
required

Returned only on creation; the full key is visible exactly once.