Skip to main content
POST
Create an API key

Authorizations

Authorization
string
header
required

API key as Authorization: Bearer sk-social-...

Body

application/json
name
string
required

Human-readable label for the key.

Example:

"CI/CD Pipeline Key"

scopes
enum<string>[]
required

Permission scopes granted to this key.

Available options:
posts:read,
posts:write,
brands:read,
brands:write,
clips:read,
clips:write,
carousels:read,
carousels:write,
agents:read,
agents:write,
kbs:read,
kbs:write,
usage:read
Example:
expiresAt
string<date-time> | null

ISO 8601 expiry datetime. If omitted, the key does not expire.

Response

API key created.

success
boolean
Example:

true

data
object

An API key and its metadata. The full key field is present only in the create response; list responses include keyHint instead.