Skip to main content
POST
Create an API key

Authorizations

Authorization
string
header
required

A Firebase ID token, or a Kalligator API key (kal_…).

Body

application/json
name
string
required

A label for the key, 1 to 80 characters. For example, the name of your agent.

Required string length: 1 - 80
scope
enum<string>
default:write

write (default) or read. A read key can only use GET.

Available options:
read,
write
expires_in_days
integer | null
default:90

Days until the key expires, from 1 to 365. Default 90. Send null for no expiry.

Required range: 1 <= x <= 365

Response

Successful Response

id
string
required
name
string
required
scope
enum<string>
required
Available options:
read,
write
hint
string
required
created_at
string | null
required
last_used_at
string | null
required
expires_at
string | null
required
key
string
required

The secret key. It starts with kal_. This is the only time that the API shows it.