addPlaylistItem

POST

/api/v1/playlists/{id}/items

const url = 'https://example.com/api/v1/playlists/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/items';
const options = {
  method: 'POST',
  headers: {'X-CSRF-Token': 'example', 'Content-Type': 'application/json'},
  body: '{"assetId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","layoutId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","durationMs":1,"fitMode":"contain","transition":"none","audioEnabled":true,"volume":1,"videoStartOffsetMs":1,"videoEndOffsetMs":1,"deliveryPolicy":"download","usePlayerDefaults":false}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/playlists/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/items \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: example' \
  --data '{ "assetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "layoutId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "durationMs": 1, "fitMode": "contain", "transition": "none", "audioEnabled": true, "volume": 1, "videoStartOffsetMs": 1, "videoEndOffsetMs": 1, "deliveryPolicy": "download", "usePlayerDefaults": false }'

Parameters

Path Parameters

required

string format: uuid

Header Parameters

X-CSRF-Token

required

string

Request Body^required

application/json

One of:

object
object

object

assetId

required

string format: uuid

layoutId

Published Layout to play fullscreen for durationMs

string format: uuid

durationMs

integer

>= 1

fitMode

string

default: contain

Allowed values: contain cover stretch

transition

string

default: none

Allowed values: none fade crossfade

audioEnabled

boolean

default: true

volume

number

default: 1 <= 1

videoStartOffsetMs

integer

videoEndOffsetMs

integer

>= 1

deliveryPolicy

string

default: download

Allowed values: download stream automatic

usePlayerDefaults

Resolve playback defaults from the effective Player configuration on Android and Linux at runtime.

boolean

Responses

201

Ready asset added transactionally

422

Invalid or unavailable asset

addPlaylistItem

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Responses

201

422

Request Body^required