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
input
string
required

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

Example:

"vidbeo://uploads/abcde12345abcdee12345a"

type
enum<string>

What kind of video is this?

Available options:
vod,
stream
Example:

"vod"

name
string

The title of the video

Required string length: 1 - 100
Example:

"Example"

description
string

A short description for the video

Maximum string length: 200
Example:

"Example description"

enabled
boolean

Should the video be immediately available to watch when ready?

Example:

false

player
string

If the video should be presented in a custom player, its ID

Example:

"abcde12345abcdee12345a"

transcoder
string

If the video should be transcoded using a custom profile, its ID

Example:

"abcde12345abcdee12345a"

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:
af-ZA,
ar-AE,
ar-SA,
cy-GB,
da-DK,
de-CH,
de-DE,
en-AU,
en-GB,
en-IE,
en-IN,
en-US,
es-ES,
es-US,
fa-IR,
fr-CA,
fr-FR,
ga-IE,
gd-GB,
he-IL,
hi-IN,
id-ID,
it-IT,
ja-JP,
ko-KR,
ms-MY,
nl-NL,
pt-BR,
pt-PT,
ru-RU,
ta-IN,
te-IN,
tr-TR,
zh-CN
Example:

"en-US"

tags
string[]

An array of up to ten tags

Maximum array length: 10
Example:
categories
string[]

An array of up to five categories

Maximum array length: 5
Example:
scheduled_time
string<date-time>

If the video should appear in a content feed at a later time, when should that be?

Example:

"2026-01-01T00:00:00.000Z"

clip
boolean

Is this video a clip from another video?

Example:

false

clip_from
string

If this video is a clip, which video was it taken from?

Example:

"abcde12345abcde12345a"

clip_start
string<time-code>

If this video is a clip, when in the parent video does it start?

Example:

"00:00:30"

clip_end
string<time-code>

If this video is a clip, when in the parent video does it end?

Example:

"00:02:30"

Response

Video

success
boolean
required
Example:

true

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