Skip to main content
POST
Create API key

Authorizations

Authorization
string
header
required

Pass an API key or JWT token. API keys can be sent as Authorization: Bearer <key> or Authorization: <key>.

Body

application/json
name
string
required

A human-readable name for the key.

Required string length: 1 - 255
scopes
enum<string>[]

Permissions granted to this key.

Permission scope for an API key. admin grants all permissions.

Available options:
upload,
download,
metadata,
delete,
admin
expires_in_days
integer | null

Days until the key expires. Omit or pass null for no expiry.

Required range: 1 <= x <= 365
metadata
object | null

Arbitrary key-value metadata.

Response

API key created. The api_key field contains the full key — it will not be shown again.

status
enum<string>
Available options:
SUCCESS
message
string
data
object
timestamp
string<date-time>