Skip to main content
POST
Create Api Key

Authorizations

Authorization
string
header
required

A floo_ API key.

Headers

X-Floo-Org-Id
string<uuid>

Organization to act in; defaults to the one joined most recently.

Body

application/json

Request body for creating an API key.

name
string
required
Required string length: 1 - 255
scope
enum<string> | null

Permission scope for an API key.

Privilege hierarchy: read < write < admin (enforced via scope_level(), not native comparison — StrEnum compares lexicographically).

Available options:
read,
write,
admin

Response

Successful Response

Response after creating an API key. Includes the raw key (shown once).

id
string<uuid>
required
name
string
required
key
string
required
key_prefix
string
required
key_suffix
string
required
scope
enum<string>
required

Permission scope for an API key.

Privilege hierarchy: read < write < admin (enforced via scope_level(), not native comparison — StrEnum compares lexicographically).

Available options:
read,
write,
admin
created_at
string<date-time>
required