Skip to main content
POST
cURL
Create a full-access or restricted API key. Provide permissions to restrict access; the full key is returned only once. A restricted key with api_key: write may only create restricted keys with the same or fewer permissions, and they expire no later than the key that creates them.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
default:2026-08-27

API version used by this reference. Send this header to select this contract explicitly.

Body

application/json
name
string
required
Minimum string length: 1
expiresInDays
integer
default:365
Required range: x <= 9007199254740991
permissions
object

Response

Success

id
string
required
name
string
required
apiKey
string
required
prefix
string
required
expiresAt
string<date-time>
required
createdAt
string<date-time>
required
object
string
required
Allowed value: "api_key"
livemode
boolean
required