Videos
List videos
- 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
Videos
List videos
Fetch all videos
GET
/
videos
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
limit
integer
limit
integer
The maximum number of results to return
Add Example Value
cursor
string
cursor
string
A cursor to fetch the next page of results
Add Example Value
curl --request GET \
--url https://api.vidbeo.com/v2/videos \
--header 'Authorization: Bearer <token>'
{
"success": true,
"result": [],
"links": {
"next": "https://api.vidbeo.com/v2/videos?limit=10&cursor=AbCdEfGhIJkLMnOpQrStUvWxYz"
},
"errors": []
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
limit
integer
default: 25The maximum number of results to return
cursor
string
A cursor to fetch the next page of results
Response
200 - application/json
success
boolean
requiredresult
object[]
requiredresult.id
string
requiredresult.type
enum<string>
requiredAvailable options:
vod
, stream
, event
result.name
string
requiredresult.description
string
requiredresult.outputs
object[]
requiredresult.outputs.label
enum<string>
Available options:
mp4
, mp4_1080p
, mp4_720p
, mp4_360p
, mp4_270p
, mp4_240p
, hls_fmp4
, hls_ts
, hls
, dash
result.outputs.url
string
result.thumbnail
string
requiredresult.sprite
string
requiredresult.duration
integer
requiredresult.privacy
enum<string>
requiredAvailable options:
public
, private
, password
, authenticated
result.tracks
object[]
requiredresult.tracks.id
string
result.tracks.language
enum<string>
Available options:
de-DE
, en-AU
, en-GB
, en-US
, es-ES
, fr-FR
, it-IT
result.tracks.label
string
result.tracks.kind
enum<string>
Available options:
subtitles
, captions
result.tracks.url
string
result.categories
string[]
requiredresult.enabled
boolean
requiredresult.transcoder
string
requiredresult.content_rating
enum<string>
requiredAvailable options:
all
, mature
result.spherical
boolean
requiredresult.projection
enum<string>
requiredAvailable options:
equirectangular
result.language
enum<string>
requiredAvailable options:
de-DE
, en-AU
, en-GB
, en-US
, es-ES
, fr-FR
, it-IT
result.cards
object[]
requiredresult.cards.id
string
result.cards.name
string
result.cards.show_at
string
result.cards.hide_at
string
result.cards.skip
boolean
result.cards.top_text
string
result.cards.bottom_text
string
result.cards.link
string
result.gates
object[]
requiredresult.gates.id
string
result.gates.name
string
result.gates.show_at
string
result.gates.skip
boolean
result.gates.top_text
string
result.gates.bottom_text
string
result.gates.fields
object[]
result.gates.fields.label
string
result.gates.fields.value
string
result.gates.connect_service_id
string
result.gates.connect_list_id
string
result.hotspots
object[]
requiredresult.hotspots.id
string
result.hotspots.name
string
result.hotspots.show_at
string
result.hotspots.hide_at
string
result.hotspots.x
integer
result.hotspots.y
integer
result.hotspots.action
enum<string>
Available options:
link
result.hotspots.link
string
result.hotspots.target
enum<string>
Available options:
_parent
, _blank
result.hotspots.opacity
enum<string>
Available options:
opaque
, translucent
, invisible
result.chapters
object[]
requiredresult.chapters.id
string
result.chapters.name
string
result.chapters.start
string
result.page_url
string
requiredresult.progress
integer
requiredresult.status
enum<string>
requiredAvailable options:
uploading
, preparing
, processing
, ready
, error
, live
, offline
result.tags
string[]
requiredresult.scheduled_time
string
requiredresult.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/videos \
--header 'Authorization: Bearer <token>'
{
"success": true,
"result": [],
"links": {
"next": "https://api.vidbeo.com/v2/videos?limit=10&cursor=AbCdEfGhIJkLMnOpQrStUvWxYz"
},
"errors": []
}