Creating an API key
1
Sign in
Get a session token from The token is at
POST /api/auth/signin:result.token.2
Create the key
name is optional and capped at 60 characters; omit it and the key is
called Untitled key.3
Store the secret
The response contains
result.secret. This is the only time it is
returned. Later calls to GET /api/auth/keys show just last_four.An account may hold up to 25 live keys. Revoke keys you no longer use with
DELETE /api/auth/keys/{id}.Public endpoints
These need noAuthorization header:
POST /api/auth/signupPOST /api/auth/signinPOST /api/auth/forgot-passwordPOST /api/auth/reset-passwordGET /health,/healthz,/readyz
POST /api/billing/webhook is also unauthenticated in the bearer sense. It is
verified instead by the webhook-id, webhook-timestamp, and
webhook-signature HMAC headers, and is meant only for the payment provider.
Handling a 401
A missing, malformed, revoked, or expired token returns401 with the standard
error envelope: