API Keys

Endpoints for managing API keys

Get Api Keys

get

Get all API keys for the authenticated creator.

This endpoint returns all API keys created by the authenticated creator. Note that the actual API key values are not included in the response for security reasons.

Authorizations
cookie
session_idany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
GET /creator/api-keys HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "key": "text",
    "name": "text",
    "description": "text",
    "created_at": "text",
    "creator": "text"
  }
]

Create Api Key

post

Create a new API key for the authenticated creator.

This endpoint allows creators to create API keys for programmatic access to the API. The API key is only shown once upon creation, so make sure to save it securely.

  • name: A name for the API key

  • description: A description for the API key

Authorizations
cookie
session_idany ofOptional
stringOptional
or
nullOptional
Body
namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
post
POST /creator/api-keys HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}
{
  "id": "text",
  "key": "text",
  "name": "text",
  "description": "text",
  "created_at": "text",
  "creator": "text"
}

Delete Api Key

delete

Delete an API key.

This endpoint allows creators to delete an API key that they no longer need.

  • api_key_id: The ID of the API key to delete

Authorizations
cookie
session_idany ofOptional
stringOptional
or
nullOptional
Path parameters
api_key_idstringRequired
Responses
200

Successful Response

application/json
Responseany
delete
DELETE /creator/api-keys/{api_key_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

No content
PreviousFoldersNextModels