Skip to main content
POST
Create API key

Authorizations

Authorization
string
header
required

Workspace API key. Create one via the dashboard or POST /v1/auth/keys.

Body

application/json
name
string
default:Untitled Key
account_kit_id
string

Seal the key to an account kit.

active_tenant_user_id
string

Default tenant user for the key.

active_project_id
string

Pin the key to a project. Omitted leaves the key un-pinned: it acts inside whichever project the request names, falling back to the organization's default. A pinned key that is handed a different project id answers 403 key_project_mismatch.

Response

Created.

api_key
string
key_id
string
name
string
account_kit_id
string | null
active_tenant_user_id
string | null
created_at
string<date-time>
active_project_id
string | null

The pinned project, or null when the key is un-pinned.