API Keys

Create API key

Generate a new player, uploader, or share API key. Requires an API Access ('api') key; API Access keys themselves must be created in the dashboard.

post/v1/api_key

Request

  • Base URL: https://api.audiodelivery.net
  • URL: https://api.audiodelivery.net/v1/api_key
  • Auth: HTTP bearer

Request body

titlestring required

Name of the API key

api_key_type_id'player' | 'uploader' | 'share' required

Type of key to create

collection_idstring uuid

Limit the key to a specific collection

track_idstring uuid

Limit the key to a specific track (requires collection_id)

creator_idstring uuid

Limit the key to a specific creator

variantsstring[]

Allowed variants. Required (exactly one) for share keys; optional for player keys

expires_atstring date-time

Optional expiration for all types; ignored for share keys

Response

API key created. The full key is returned once and never stored in plaintext.

oktrue required
api_request_idstring uuid required
api_keystring

The full API key including org prefix (returned once)

Changes