Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange.

Headers

X-Organization-Id
string

The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing. Absent, the session's default organization answers.

Body

application/json
name
string
required

How the key is labelled in the panel.

environment
enum<string>
required
Available options:
live,
test

Response

Created. key is shown once.

id
string<uuid>
name
string
prefix
string
environment
enum<string>
Available options:
live,
test
key
string

The plaintext key. Store it now; it is never shown again.