Pular navegação
Base de conhecimento

Playlists

Playlists e seus conteúdos.

Playlists

Entities

Listar mídias

GET {{baseHost}}/v1/playlists/:playlist_id/entities

Retorna os itens que estão na playlist, na ordem.

Lista de mídias da playlist

Responses
{  "data": [    {      "id": "<UUID>",      "position": 1,      "status": "done",      "title": "4k_Limp+Bizkit+-+Rollin'+(Air+Raid+Vehicle)+[4K]-2160p (3)",      "description": "",      "duration": 243.87675,      "created_at": "2026-04-06T13:58:37.847191Z",      "updated_at": "2026-04-21T20:30:52.543151Z"    }  ]}

Adicionar mídias

POST {{baseHost}}/v1/playlists/:playlist_id/entities

Acrescenta um ou mais vídeos à playlist. Se replace for true, o conteúdo atual é apagado antes.

Request body (json)
{  "entity_ids": [    "<UUID>"  ]}
Responses
{  "data": {    "id": "<UUID>",    "workspace_id": "<UUID>",    "player_id": "<UUID>",    "parent_id": "<UUID>",    "name": "New playlist",    "description": "",    "privacy_type": "anywhere",    "privacy_domains": [],    "privacy_share": {},    "tags": [],    "settings": {      "sort_field": "custom",      "sort_order": "asc",      "ignore_interactive_tools": false    },    "play_link": "https://kinescope.io/pl/je7WZBZhdMFQKPHHHmMr2m",    "embed_link": "https://kinescope.io/embed/pl/je7WZBZhdMFQKPHHHmMr2m"  }}

Excluir mídias

DELETE {{baseHost}}/v1/playlists/:playlist_id/entities

Remove da playlist os itens indicados.

Request body (json)
{  "entity_ids": [    "<UUID>"  ]}
Responses
{  "data": {    "id": "<UUID>",    "workspace_id": "<UUID>",    "player_id": "<UUID>",    "parent_id": "<UUID>",    "name": "New playlist",    "description": "",    "privacy_type": "anywhere",    "privacy_domains": [],    "privacy_share": {},    "tags": [],    "settings": {      "sort_field": "custom",      "sort_order": "asc",      "ignore_interactive_tools": false    },    "play_link": "https://kinescope.io/pl/je7WZBZhdMFQKPHHHmMr2m",    "embed_link": "https://kinescope.io/embed/pl/je7WZBZhdMFQKPHHHmMr2m"  }}

Mover mídia

PUT {{baseHost}}/v1/playlists/:playlist_id/entities/:media_id/move

Altera a posição de um item na playlist.

Request body (json)
{  "position": 2}
Responses
{  "data": {    "id": "<UUID>",    "workspace_id": "<UUID>",    "player_id": "<UUID>",    "parent_id": "<UUID>",    "name": "Playlist updated",    "description": "Description updated",    "privacy_type": "anywhere",    "privacy_domains": [],    "privacy_share": {},    "tags": [],    "settings": {      "sort_field": "custom",      "sort_order": "asc",      "ignore_interactive_tools": false    },    "play_link": "https://kinescope.io/pl/je7WZBZhdMFQKPHHHmMr2m",    "embed_link": "https://kinescope.io/embed/pl/je7WZBZhdMFQKPHHHmMr2m"  }}

Obter playlist

GET {{baseHost}}/v1/playlists/:playlist_id

Retorna os dados de uma playlist pelo seu identificador único.

Responses
{  "data": {    "id": "<UUID>",    "workspace_id": "<UUID>",    "player_id": "<UUID>",    "parent_id": "<UUID>",    "name": "       ",    "description": "",    "privacy_type": "anywhere",    "privacy_domains": [],    "privacy_email_domains": [],    "privacy_share": {},    "unique_codes_enabled": false,    "tags": [],    "settings": {      "sort_field": "custom",      "sort_order": "asc",      "ignore_interactive_tools": false    },    "play_link": "https://kinescope.io/pl/mN2NQtiPtGDeeKMcnL9pFS",    "embed_link": "https://kinescope.io/embed/pl/mN2NQtiPtGDeeKMcnL9pFS"  }}
{  "error": {    "code": 400404,    "message": "not found"  }}

Listar playlists

GET {{baseHost}}/v1/playlists

Retorna a lista de playlists. Os resultados são paginados e podem ser filtrados por parâmetros de consulta.

Responses
{ "meta": {  "pagination": {   "page": 1,   "per_page": 100,   "total": 32  },  "order": {"name":"desc"} }, "data": [  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "teste",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/jYTf2LiKf9EjSVdYrQqG7G",   "embed_link": "https://kinescope.io/embed/pl/jYTf2LiKf9EjSVdYrQqG7G"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "teste",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/an74We1dQy1zDXQhj5gi9t",   "embed_link": "https://kinescope.io/embed/pl/an74We1dQy1zDXQhj5gi9t"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "playlist_2videos",   "description": "playlist de teste",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/ntkKeCY2h2C7sAjUoUJFDw",   "embed_link": "https://kinescope.io/embed/pl/ntkKeCY2h2C7sAjUoUJFDw"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "Playlist de exemplo",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": true,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/niGucFE5xEkSGV95r2tazX",   "embed_link": "https://kinescope.io/embed/pl/niGucFE5xEkSGV95r2tazX"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "Nova playlist de teste",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "created_at",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/mJU9b4AUj6NFzcDnWA1LZv",   "embed_link": "https://kinescope.io/embed/pl/mJU9b4AUj6NFzcDnWA1LZv"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "Playlist longa",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/oxZ8RtEB1bGWYv9H8G66k8",   "embed_link": "https://kinescope.io/embed/pl/oxZ8RtEB1bGWYv9H8G66k8"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "test_pl_drm",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/qZnbjQisWyCfFpjascyM9X",   "embed_link": "https://kinescope.io/embed/pl/qZnbjQisWyCfFpjascyM9X"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "test",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    "password": "123"   },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/qdGu6BhoetX8U9xy4QtwqZ",   "embed_link": "https://kinescope.io/embed/pl/qdGu6BhoetX8U9xy4QtwqZ"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "test",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/hWzGMKMAYQqcDtcqQgfmsX",   "embed_link": "https://kinescope.io/embed/pl/hWzGMKMAYQqcDtcqQgfmsX"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "test",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/39C5nUf9k3K285RdqUCTbc",   "embed_link": "https://kinescope.io/embed/pl/39C5nUf9k3K285RdqUCTbc"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "Vitrine de recursos de IA",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/fDcMfTJvZ3KoPUrzZT17Tu",   "embed_link": "https://kinescope.io/embed/pl/fDcMfTJvZ3KoPUrzZT17Tu"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "playlist",   "description": "234324234",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/hXt9v7zHioVbNWVmaX7mX5",   "embed_link": "https://kinescope.io/embed/pl/hXt9v7zHioVbNWVmaX7mX5"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "playlisst",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [    "gmail.com"   ],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/2uTTZ5sjDTPYMXzALDcTwM",   "embed_link": "https://kinescope.io/embed/pl/2uTTZ5sjDTPYMXzALDcTwM"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "New playlist 2",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "created_at",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/6WhqRL5RkLUQUAWUS9xv3x",   "embed_link": "https://kinescope.io/embed/pl/6WhqRL5RkLUQUAWUS9xv3x"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "new playlist 1",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "created_at",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/db26iDXs5QRGAfJX1CMrub",   "embed_link": "https://kinescope.io/embed/pl/db26iDXs5QRGAfJX1CMrub"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "New playlist",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/n89ZCES9ak6FmzL8UpqxcX",   "embed_link": "https://kinescope.io/embed/pl/n89ZCES9ak6FmzL8UpqxcX"  },  {   "id": "<UUID>",   "workspace_id": "<UUID>",   "player_id": "<UUID>",   "parent_id": "<UUID>",   "name": "New playlist",   "description": "",   "privacy_type": "anywhere",   "privacy_domains": [],   "privacy_email_domains": [],   "privacy_share": {    },   "unique_codes_enabled": false,   "tags": [],   "settings": {    "sort_field": "custom",    "sort_order": "asc",    "ignore_interactive_tools": false   },   "play_link": "https://kinescope.io/pl/gXaFFFd// … truncated

Criar playlist

POST {{baseHost}}/v1/playlists

Cria uma playlist. Em caso de sucesso, retorna o objeto criado.

CampoTipoDescrição
namestringNome da playlist
parent_iduuidfolder_id ou project_id
entity_ids[]uuidArray de video_id
Request body (json)
{  "name": "Playlist 1",  "parent_id": "<UUID>",  "entity_ids": [    "<UUID>"  ]}
Responses
{  "data": {    "id": "<UUID>",    "workspace_id": "<UUID>",    "player_id": "<UUID>",    "parent_id": "<UUID>",    "name": "Playlist 1",    "description": "",    "privacy_type": "anywhere",    "privacy_domains": [],    "privacy_share": {},    "tags": [],    "settings": {      "sort_field": "created_at",      "sort_order": "asc",      "ignore_interactive_tools": false    },    "play_link": "https://kinescope.io/pl/vUJJ5W5wmgKBLwVEnHf9uN",    "embed_link": "https://kinescope.io/embed/pl/vUJJ5W5wmgKBLwVEnHf9uN"  }}

Atualizar playlist

PATCH {{baseHost}}/v1/playlists/:playlist_id

Atualiza a playlist indicada. Só os campos enviados no corpo da requisição são alterados; os demais ficam como estão.

CampoTipoDescrição
namestringNome da playlist
descriptionstringDescrição da playlist
parent_iduuidfolder_id ou project_id
settingsobjectDefine o campo e a ordem de classificação da lista de vídeos
Request body (json)
{  "name": "Playlist updated",  "description": "Description updated",  "parent_id": "<UUID>",  "privacy_type": "anywhere",  "privacy_domains": [    "dddd.com"  ],  "settings": {    "sort_field": "duration",    "sort_order": "asc"  }}
Responses
{  "data": {    "id": "<UUID>",    "workspace_id": "<UUID>",    "player_id": "<UUID>",    "parent_id": "<UUID>",    "name": "Playlist updated",    "description": "Description updated",    "privacy_type": "anywhere",    "privacy_domains": [      "dddd.com"    ],    "privacy_share": {},    "tags": [],    "settings": {      "sort_field": "duration",      "sort_order": "asc",      "ignore_interactive_tools": false    },    "play_link": "https://kinescope.io/pl/je7WZBZhdMFQKPHHHmMr2m",    "embed_link": "https://kinescope.io/embed/pl/je7WZBZhdMFQKPHHHmMr2m"  }}

Excluir playlist

DELETE {{baseHost}}/v1/playlists/:playlist_id

Exclui a playlist permanentemente. A ação não pode ser desfeita.

Responses
{  "data": {    "success": true  }}