- 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
Update video
Update a video’s details
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
ID of the video
The title of the video
Either a full URL we can fetch the video file from, or a reference to a previously completed upload
A short description for the video
If authenticated, the viewer will need to provide either a cookie or JWT when requesting a landing page, embed code or HLS manifest URL
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
Is the video in 360?
For 360 videos we currently support equirectangular
The audio language
An array of up to ten tags
curl --request PATCH \
--url https://api.vidbeo.com/v2/videos/{VIDEO_ID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Example",
"input": "vidbeo://uploads/abcde12345abcdee12345a",
"description": "Example description",
"privacy": "private",
"password": "Example123",
"spherical": true,
"projection": "equirectangular",
"language": "en-US",
"tags": [
"example"
]
}'
{
"success": true,
"result": {
"id": "abcde12345abcde12345a",
"type": "vod",
"name": "Example",
"description": "Example description",
"outputs": [
{
"label": "hls",
"url": "https://example.com/path/to/file.m3u8"
}
],
"thumbnail": "https://example.com/path/to/file.jpg",
"sprite": "https://example.com/path/to/file.jpg",
"duration": 30,
"privacy": "private",
"tracks": [
{
"id": "abcde12345abcde12345a",
"language": "en-US",
"label": "English",
"kind": "subtitles",
"url": "<string>"
}
],
"categories": [
"example"
],
"enabled": true,
"transcoder": "abcde12345abcde12345a",
"content_rating": "all",
"spherical": true,
"projection": "equirectangular",
"language": "en-US",
"cards": [
{
"id": "abcde12345abcde12345a",
"name": "Example",
"show_at": "00:00:05",
"hide_at": "00:00:05",
"skip": false,
"top_text": "Example text",
"bottom_text": "Example text",
"link": "https://example.com"
}
],
"gates": [
{
"id": "abcde12345abcde12345a",
"name": "Example",
"show_at": "00:00:05",
"skip": false,
"top_text": "Example text",
"bottom_text": "Example text",
"fields": [
{
"label": "Email",
"value": "email"
}
],
"connect_service_id": "abcde12345abcde12345a",
"connect_list_id": "abcde"
}
],
"hotspots": [
{
"id": "abcde12345abcde12345a",
"name": "Example",
"show_at": "00:00:05",
"hide_at": "00:00:05",
"x": 25,
"y": 25,
"action": "link",
"link": "https://example.com",
"target": "_parent",
"opacity": "translucent"
}
],
"chapters": [
{
"id": "abcde12345abcde12345a",
"name": "Example",
"start": "00:00:05"
}
],
"page_url": "https://example.com/page",
"progress": 100,
"status": "ready",
"tags": [
"example"
],
"scheduled_time": "2024-01-01T00:00:00.000Z",
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the video
Body
The title of the video
Either a full URL we can fetch the video file from, or a reference to a previously completed upload
A short description for the video
If authenticated, the viewer will need to provide either a cookie or JWT when requesting a landing page, embed code or HLS manifest URL
public
, private
, password
, authenticated
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
Is the video in 360?
For 360 videos we currently support equirectangular
equirectangular
The audio language
de-DE
, en-AU
, en-GB
, en-US
, es-ES
, fr-FR
, it-IT
An array of up to ten tags
Response
vod
, stream
, event
mp4
, mp4_1080p
, mp4_720p
, mp4_360p
, mp4_270p
, mp4_240p
, hls_fmp4
, hls_ts
, hls
, dash
public
, private
, password
, authenticated
de-DE
, en-AU
, en-GB
, en-US
, es-ES
, fr-FR
, it-IT
subtitles
, captions
all
, mature
equirectangular
de-DE
, en-AU
, en-GB
, en-US
, es-ES
, fr-FR
, it-IT
link
_parent
, _blank
opaque
, translucent
, invisible
uploading
, preparing
, processing
, ready
, error
, live
, offline
curl --request PATCH \
--url https://api.vidbeo.com/v2/videos/{VIDEO_ID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Example",
"input": "vidbeo://uploads/abcde12345abcdee12345a",
"description": "Example description",
"privacy": "private",
"password": "Example123",
"spherical": true,
"projection": "equirectangular",
"language": "en-US",
"tags": [
"example"
]
}'
{
"success": true,
"result": {
"id": "abcde12345abcde12345a",
"type": "vod",
"name": "Example",
"description": "Example description",
"outputs": [
{
"label": "hls",
"url": "https://example.com/path/to/file.m3u8"
}
],
"thumbnail": "https://example.com/path/to/file.jpg",
"sprite": "https://example.com/path/to/file.jpg",
"duration": 30,
"privacy": "private",
"tracks": [
{
"id": "abcde12345abcde12345a",
"language": "en-US",
"label": "English",
"kind": "subtitles",
"url": "<string>"
}
],
"categories": [
"example"
],
"enabled": true,
"transcoder": "abcde12345abcde12345a",
"content_rating": "all",
"spherical": true,
"projection": "equirectangular",
"language": "en-US",
"cards": [
{
"id": "abcde12345abcde12345a",
"name": "Example",
"show_at": "00:00:05",
"hide_at": "00:00:05",
"skip": false,
"top_text": "Example text",
"bottom_text": "Example text",
"link": "https://example.com"
}
],
"gates": [
{
"id": "abcde12345abcde12345a",
"name": "Example",
"show_at": "00:00:05",
"skip": false,
"top_text": "Example text",
"bottom_text": "Example text",
"fields": [
{
"label": "Email",
"value": "email"
}
],
"connect_service_id": "abcde12345abcde12345a",
"connect_list_id": "abcde"
}
],
"hotspots": [
{
"id": "abcde12345abcde12345a",
"name": "Example",
"show_at": "00:00:05",
"hide_at": "00:00:05",
"x": 25,
"y": 25,
"action": "link",
"link": "https://example.com",
"target": "_parent",
"opacity": "translucent"
}
],
"chapters": [
{
"id": "abcde12345abcde12345a",
"name": "Example",
"start": "00:00:05"
}
],
"page_url": "https://example.com/page",
"progress": 100,
"status": "ready",
"tags": [
"example"
],
"scheduled_time": "2024-01-01T00:00:00.000Z",
"created_by": "abcde12345abcde12345a",
"created_time": "2024-01-01T00:00:00.000Z",
"updated_by": "abcde12345abcde12345a",
"updated_time": "2024-01-01T00:00:00.000Z"
},
"links": {},
"errors": []
}