Play Sessions

Create play session

post/v1/play_session/{scope}

Request

  • Base URL: https://api.audiodelivery.net
  • URL: https://api.audiodelivery.net/v1/play_session/{scope}
  • Auth: HTTP bearer

Path parameters

scope'collection' | 'track' required

"collection" or "track". "playlist" is reserved for a future release and currently returns 400.

Request body

variantsstring[] required

Non-empty list of variant indexes for the play session.

collection_idstring uuid

Required when scope is 'collection', unless the API key is scoped to a collection.

track_idstring uuid

Required when scope is 'track', unless the API key is scoped to a track.

is_downloadableboolean

Requests downloadable tracks. Only honored when the API key also allows downloads; the stored value is api_key.is_downloadable AND this request.

expires_ininteger

Session duration in seconds (default 3600, min 60, max 86400).

Response

Play session created.

oktrue required
api_request_idstring uuid required
play_session_idstring uuid
first_trackobject

Full playback data for the first track, including signed variant URLs, so a player can render without a second call.

expires_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.