OpenVibe.MediaHub API

Generated at from openvibe-contracts v0.177.0 and openvibe-sdk v0.44.0.

Server https://openvibe.video. 8 routes performing 2 capabilities. OpenAPI 3.1 document.

GET /api/v1/video/playlists

Read playlists on openvibe.video: the ones the caller owns (a person, or an app, agent or service under its own requester) and any public or unlisted playlist by id, with its ordered items (vod or cli

Capabilities
video.playlist.read
Visibility
public
Parameters
  • limit (query)
  • cursor (query)
Input
video.playlist-read-request@1
Response
application/json video.playlist-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>video.playlist.read</strong> (public): Read playlists on openvibe.video: the ones the caller owns (a person, or an app, agent or service under its own requester) and any public or unlisted playlist by id, with its ordered items (vod or clip ids from OpenVibe.Live). A private playlist answers 404 to anyone but its owner. A person acting for themself needs no capability; an app, agent or service token (audience openvibe.download, the media hub&#39;s) needs this one.</p>

POST /api/v1/video/playlists

Create, rename, describe, change the visibility of, reorder, add items to, remove items from and delete playlists on openvibe.video that the caller owns.

Capabilities
video.playlist.manage
Visibility
public
Request body
application/json video.playlist-manage-request@1
Response
application/json video.playlist-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>video.playlist.manage</strong> (public): Create, rename, describe, change the visibility of, reorder, add items to, remove items from and delete playlists on openvibe.video that the caller owns. An app, agent or service owns a playlist under its own requester (app:app_..., agent:agt_..., service:&lt;slug&gt;) and the playlist records its project; it can never touch a person&#39;s playlist. A person acting for themself needs no capability; an app, agent or service token (audience openvibe.download) needs this one.</p>

GET /api/v1/video/playlists/{id}

Read playlists on openvibe.video: the ones the caller owns (a person, or an app, agent or service under its own requester) and any public or unlisted playlist by id, with its ordered items (vod or cli

Capabilities
video.playlist.read
Visibility
public
Parameters
  • id (path, required)
  • limit (query)
  • cursor (query)
Input
video.playlist-read-request@1
Response
application/json video.playlist-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>video.playlist.read</strong> (public): Read playlists on openvibe.video: the ones the caller owns (a person, or an app, agent or service under its own requester) and any public or unlisted playlist by id, with its ordered items (vod or clip ids from OpenVibe.Live). A private playlist answers 404 to anyone but its owner. A person acting for themself needs no capability; an app, agent or service token (audience openvibe.download, the media hub&#39;s) needs this one.</p>

PATCH /api/v1/video/playlists/{id}

Create, rename, describe, change the visibility of, reorder, add items to, remove items from and delete playlists on openvibe.video that the caller owns.

Capabilities
video.playlist.manage
Visibility
public
Parameters
  • id (path, required)
Request body
application/json video.playlist-manage-request@1
Response
application/json video.playlist-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>video.playlist.manage</strong> (public): Create, rename, describe, change the visibility of, reorder, add items to, remove items from and delete playlists on openvibe.video that the caller owns. An app, agent or service owns a playlist under its own requester (app:app_..., agent:agt_..., service:&lt;slug&gt;) and the playlist records its project; it can never touch a person&#39;s playlist. A person acting for themself needs no capability; an app, agent or service token (audience openvibe.download) needs this one.</p>

DELETE /api/v1/video/playlists/{id}

Create, rename, describe, change the visibility of, reorder, add items to, remove items from and delete playlists on openvibe.video that the caller owns.

Capabilities
video.playlist.manage
Visibility
public
Parameters
  • id (path, required)
Input
video.playlist-manage-request@1
Response
application/json video.playlist-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>video.playlist.manage</strong> (public): Create, rename, describe, change the visibility of, reorder, add items to, remove items from and delete playlists on openvibe.video that the caller owns. An app, agent or service owns a playlist under its own requester (app:app_..., agent:agt_..., service:&lt;slug&gt;) and the playlist records its project; it can never touch a person&#39;s playlist. A person acting for themself needs no capability; an app, agent or service token (audience openvibe.download) needs this one.</p>

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

Create, rename, describe, change the visibility of, reorder, add items to, remove items from and delete playlists on openvibe.video that the caller owns.

Capabilities
video.playlist.manage
Visibility
public
Parameters
  • id (path, required)
Request body
application/json video.playlist-manage-request@1
Response
application/json video.playlist-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>video.playlist.manage</strong> (public): Create, rename, describe, change the visibility of, reorder, add items to, remove items from and delete playlists on openvibe.video that the caller owns. An app, agent or service owns a playlist under its own requester (app:app_..., agent:agt_..., service:&lt;slug&gt;) and the playlist records its project; it can never touch a person&#39;s playlist. A person acting for themself needs no capability; an app, agent or service token (audience openvibe.download) needs this one.</p>

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

Create, rename, describe, change the visibility of, reorder, add items to, remove items from and delete playlists on openvibe.video that the caller owns.

Capabilities
video.playlist.manage
Visibility
public
Parameters
  • id (path, required)
Request body
application/json video.playlist-manage-request@1
Response
application/json video.playlist-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>video.playlist.manage</strong> (public): Create, rename, describe, change the visibility of, reorder, add items to, remove items from and delete playlists on openvibe.video that the caller owns. An app, agent or service owns a playlist under its own requester (app:app_..., agent:agt_..., service:&lt;slug&gt;) and the playlist records its project; it can never touch a person&#39;s playlist. A person acting for themself needs no capability; an app, agent or service token (audience openvibe.download) needs this one.</p>

DELETE /api/v1/video/playlists/{id}/items/{kind}/{itemId}

Create, rename, describe, change the visibility of, reorder, add items to, remove items from and delete playlists on openvibe.video that the caller owns.

Capabilities
video.playlist.manage
Visibility
public
Parameters
  • id (path, required)
  • kind (path, required)
  • itemId (path, required)
Input
video.playlist-manage-request@1
Response
application/json video.playlist-manage-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>video.playlist.manage</strong> (public): Create, rename, describe, change the visibility of, reorder, add items to, remove items from and delete playlists on openvibe.video that the caller owns. An app, agent or service owns a playlist under its own requester (app:app_..., agent:agt_..., service:&lt;slug&gt;) and the playlist records its project; it can never touch a person&#39;s playlist. A person acting for themself needs no capability; an app, agent or service token (audience openvibe.download) needs this one.</p>