Skip to main content
POST
Create an API key

Authorizations

segmnt_session
string
cookie
required

Dashboard session cookie, set after SSO sign-in.

Path Parameters

projectId
string
required
Pattern: ^prj_[A-Za-z0-9]+$

Body

application/json
name
string
required
Required string length: 1 - 100
Example:

"Course site backend"

Response

Key created. secret is shown only in this response. We store only a hash.

id
string
required
Example:

"key_3hT9aZ"

name
string
required
prefix
string
required

First characters of the key, to recognise it.

Example:

"Abcd1234"

createdAt
string<date-time>
required
lastUsedAt
string<date-time> | null
required

When the key was last used. Updated at most once a minute, so it can lag real use by up to 60 seconds; null means the key has never been used.

secret
string
required

The full key: sk_{prefix}_{secret} (docs/architecture.md section 9). Shown only in this response; we store only the SHA-256 of the secret.