Skip to main content
POST
Create API key

Authorizations

Authorization
string
header
required

Prefix your API key with "Bearer ". Example: Authorization: Bearer sapi_key_...

Body

application/json

Key name and optional restrictions

brand_ids
string[]

BrandIDs restricts the key to specific brands. Empty means all brands.

name
string
Example:

"My App"

scopes
string[]

Scopes restricts the key to specific actions. Empty means full access.

Example:

Response

Key created (raw key shown once)

brand_ids
string[]
id
string
message
string
Example:

"Store this key securely. It will not be shown again."

name
string
raw_key
string
Example:

"sapi_key_..."

scopes
string[]
Example: