Skip to main content
POST
Create an organization API key

Path Parameters

organizationId
string
required
Pattern: ^org_[0123456789abcdefghjkmnpqrstvwxyz]{26}$
Example:

"org_f6m39y94nh6fs513q03skj929c"

Body

application/json
name
string
required
Minimum string length: 1
Example:

"Acme Growth Workspace"

type
enum<string>
Available options:
publishable,
secret
Example:

"publishable"

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

"live"

allowed_origins
string<uri>[]
Example:
scopes
enum<string>[]

Required for secret keys. Provide at least one supported secret-key scope, or ["*"] for all current and future scopes. Omit for publishable keys.

Minimum array length: 1
Available options:
*,
sessions:list,
sessions:read,
sessions:update,
fingerprints:list,
fingerprints:read,
organizations:create,
organizations:read,
organizations:update,
api_keys:read,
api_keys:manage,
gate:agent_tokens:verify,
gate:agent_tokens:revoke,
gate:login_sessions:consume,
gate:services:read,
gate:services:manage,
webhooks:read,
webhooks:manage
Example:

Response

Issued API key response.

data
object
required
Example:
meta
object
required
Example: