Players
Fetch player
- Get started
- GETFetch analytics
- GETFetch audit logs
- GETList categories
- POSTCreate category
- GETFetch category
- DELDelete category
- PATCHUpdate category
- GETList folders
- POSTCreate folder
- GETFetch folder
- DELDelete folder
- PATCHUpdate folder
- GETGet videos in folder
- POSTAdd video to folder
- DELRemove video from folder
- GETList identity providers
- POSTCreate identity provider
- GETFetch identity provider
- DELDelete identity provider
- PATCHUpdate identity provider
- POSTCreate transcribe
- GETList videos
- POSTCreate video
- GETFetch video
- DELDelete video
- PATCHUpdate video
- POSTCreate track
- DELDelete track
- POSTReplace thumbnail
- POSTCreate card
- DELDelete card
- PATCHUpdate card
- POSTCreate gate
- DELDelete gate
- PATCHUpdate gate
- POSTCreate hotspot
- DELDelete hotspot
- PATCHUpdate hotspot
- POSTCreate chapter
- DELDelete chapter
- PATCHUpdate chapter
Video API
Analytics
Audit logs
Categories
Folders
Identity providers
Transcribes
Videos
Players
Fetch player
Get a player’s details
GET
/
players
/
{PLAYER_ID}
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
PLAYER_ID
string
*
PLAYER_ID
Required
string
ID of the player
Add Example Value
curl --request GET \
--url https://api.vidbeo.com/v2/players/{PLAYER_ID} \
--header 'Authorization: Bearer <token>'
{
"success": true,
"result": {
"id": "abcde12345abcde12345a",
"aspectratio": "16:9",
"autoplay": true,
"colour": "#ff0000",
"controls": true,
"buttons": "play,progress,fullscreen",
"dnt": true,
"keyboard": true,
"loop": true,
"name": "Example",
"muted": true,
"playsinline": true,
"preload": true,
"quality": "highest",
"title": true,
"track": "en-US",
"created_by": "abcde12345abcde12345a",
"created_time": "2024-01-01T00:00:00.000Z",
"updated_by": "abcde12345abcde12345a",
"updated_time": "2024-01-01T00:00:00.000Z"
},
"links": {},
"errors": []
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
PLAYER_ID
string
requiredID of the player
Response
200 - application/json
success
boolean
requiredresult
object
requiredresult.id
string
requiredresult.aspectratio
enum<string>
requiredAvailable options:
16:9
result.autoplay
boolean
requiredresult.colour
string
requiredresult.controls
boolean
requiredresult.buttons
string
requiredresult.dnt
boolean
requiredresult.keyboard
boolean
requiredresult.loop
boolean
requiredresult.name
string
requiredresult.muted
boolean
requiredresult.playsinline
boolean
requiredresult.preload
boolean
requiredresult.quality
enum<string>
requiredAvailable options:
highest
, lowest
result.title
boolean
requiredresult.track
enum<string>
requiredAvailable options:
de-DE
, en-AU
, en-GB
, en-US
, es-ES
, fr-FR
, it-IT
result.created_by
string
requiredresult.created_time
string
requiredresult.updated_by
string
requiredresult.updated_time
string
requiredlinks
object
requirederrors
object[]
requiredcurl --request GET \
--url https://api.vidbeo.com/v2/players/{PLAYER_ID} \
--header 'Authorization: Bearer <token>'
{
"success": true,
"result": {
"id": "abcde12345abcde12345a",
"aspectratio": "16:9",
"autoplay": true,
"colour": "#ff0000",
"controls": true,
"buttons": "play,progress,fullscreen",
"dnt": true,
"keyboard": true,
"loop": true,
"name": "Example",
"muted": true,
"playsinline": true,
"preload": true,
"quality": "highest",
"title": true,
"track": "en-US",
"created_by": "abcde12345abcde12345a",
"created_time": "2024-01-01T00:00:00.000Z",
"updated_by": "abcde12345abcde12345a",
"updated_time": "2024-01-01T00:00:00.000Z"
},
"links": {},
"errors": []
}