Skip to main content
POST
Create video

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string

The title of the video

Required string length: 1 - 100
Example:

"Example"

input
string

Either a full URL we can fetch the video file from, or a reference to a previously completed upload

Example:

"vidbeo://uploads/abcde12345abcdee12345a"

description
string

A short description for the video

Maximum string length: 200
Example:

"Example description"

privacy
enum<string>

If authenticated, the viewer will need to provide either a cookie or JWT when requesting a landing page, embed code or HLS manifest URL

Available options:
public,
private,
password,
authenticated
Example:

"private"

password
string

If you set the value of privacy as password you will need to send that password. This value should be at least 8 characters. It should contain at least one letter and at least one number

Required string length: 8 - 20
Example:

"Example123"

spherical
boolean

Is the video in 360?

Example:

false

projection
enum<string>

For 360 videos we currently support equirectangular

Available options:
equirectangular
Example:

"equirectangular"

language
enum<string>

The audio language

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

"en-US"

tags
string[]

An array of up to ten tags

Maximum array length: 10
Example:

Response

Video

success
boolean
required
Example:

true

result
object
required
Example:
errors
object[]
required
Example: