Skip to main content
POST
/
players
Create player
curl --request POST \
  --url https://api.vidbeo.com/v2/players \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "aspectratio": "16:9",
  "autoplay": false,
  "colour": "#ff0000",
  "controls": false,
  "buttons": "play,progress,fullscreen",
  "dnt": false,
  "keyboard": false,
  "loop": false,
  "name": "Example",
  "muted": false,
  "playsinline": false,
  "preload": false,
  "quality": "highest",
  "title": false,
  "track": "en-US"
}'
{
  "success": true,
  "result": {
    "id": "abcde12345abcde12345a",
    "aspectratio": "16:9",
    "autoplay": false,
    "colour": "#ff0000",
    "controls": false,
    "buttons": "play,progress,fullscreen",
    "dnt": false,
    "keyboard": false,
    "loop": false,
    "name": "Example",
    "muted": false,
    "playsinline": false,
    "preload": false,
    "quality": "highest",
    "title": false,
    "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
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
aspectratio
enum<string>

Its aspect ratio. Currently we only support the most common 16:9 ratio

Available options:
16:9
Example:

"16:9"

​
autoplay
boolean

Should the player try to play on-load (many browsers block this, though setting muted as true can help)?

Example:

false

​
colour
string

Its accent colour, used for the main play button

Example:

"#ff0000"

​
controls
boolean

Whether controls should be shown

Example:

false

​
buttons
string

If you only want a subset of the controls shown, provide a comma-separated string of the ones to include

Example:

"play,progress,fullscreen"

​
dnt
boolean

Should the player send analytics events?

Example:

false

​
keyboard
boolean

Support keyboard controls

Example:

false

​
loop
boolean

Should the video automatically loop and restart when it ends?

Example:

false

​
name
string

A short name for the player

Required string length: 1 - 40
Example:

"Example"

​
muted
boolean

Should the video be muted on-load?

Example:

false

​
playsinline
boolean

If supported, should the video play inline (as opposed to immediately going fullscreen)

Example:

false

​
preload
boolean

If supported, should we buffer a small amount of video on-load to improve performance?

Example:

false

​
quality
enum<string>

We try and pick the best quality (based on the connection speed) but you can force it

Available options:
highest,
lowest
Example:

"highest"

​
title
boolean

Should the video title be shown on-load?

Example:

false

​
track
enum<string>

If subtitles are available, this sets the language of the one to show on-load

Available options:
de-DE,
en-AU,
en-GB,
en-US,
es-ES,
fr-FR,
it-IT
Example:

"en-US"

Response

Player

​
success
boolean
required
Example:

true

​
result
object
required
​
links
object
required
Example:
{}
​
errors
object[]
required
Example:
[]