List videos

GET

videos

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

header

required

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

Query Parameters

limit

integer

default:25

The maximum number of results to return

Required range: 1 <= x <= 25

Example:

10

cursor

string

A cursor to fetch the next page of results

Example:

"AbCdEfGhIJkLMnOpQrStUvWxYz"

Response

200 - application/json

Videos

success

boolean

required

Example:

true

result

object[]

required

result.id

string

required

Required string length: 21

Example:

"abcde12345abcde12345a"

result.type

enum<string>

required

Available options:

vod,

stream,

event

Example:

"vod"

result.name

string

required

Required string length: 1 - 100

Example:

"Example"

result.description

string

required

Maximum length: 200

Example:

"Example description"

result.outputs

object[]

required

Example:

[
  {
    "label": "hls",
    "url": "https://example.com/path/to/file.m3u8"
  }
]

result.thumbnail

string

required

Example:

"https://example.com/path/to/file.jpg"

result.sprite

string

required

Example:

"https://example.com/path/to/file.jpg"

result.duration

integer

required

Example:

30

result.privacy

enum<string>

required

Available options:

public,

private,

password,

authenticated

Example:

"private"

result.tracks

object[]

required

result.categories

string[]

required

Example:

["example"]

result.enabled

boolean

required

Example:

true

result.transcoder

string

required

Required string length: 21

Example:

"abcde12345abcde12345a"

result.content_rating

enum<string>

required

Available options:

all,

mature

Example:

"all"

result.spherical

boolean

required

Example:

false

result.projection

enum<string>

required

Available options:

equirectangular

Example:

"equirectangular"

result.language

enum<string>

required

Available options:

de-DE,

en-AU,

en-GB,

en-US,

es-ES,

fr-FR,

it-IT

Example:

"en-US"

result.cards

object[]

required

Example:

[
  {
    "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"
  }
]

result.gates

object[]

required

result.gates.id

string

Required string length: 21

Example:

"abcde12345abcde12345a"

result.gates.name

string

Required string length: 1 - 200

Example:

"Example"

result.gates.show_at

string

Example:

"00:00:05"

result.gates.skip

boolean

Example:

false

result.gates.top_text

string

Example:

"Example text"

result.gates.bottom_text

string

Example:

"Bottom text"

result.gates.fields

object[]

Example:

[{ "label": "Email", "value": "email" }]

result.gates.connect_service_id

string

Required string length: 21

Example:

"abcde12345abcde12345a"

result.gates.connect_list_id

string

Required string length: 1 - 100

Example:

"abcde"

Example:

[
  {
    "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"
  }
]

result.hotspots

object[]

required

Example:

[
  {
    "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"
  }
]

result.chapters

object[]

required

Example:

[
  {
    "id": "abcde12345abcde12345a",
    "name": "Example",
    "start": "00:00:05"
  }
]

result.page_url

string

required

Example:

"https://example.com/page"

result.progress

integer

required

Example:

100

result.status

enum<string>

required

Available options:

uploading,

preparing,

processing,

ready,

error,

live,

offline

Example:

"ready"

result.tags

string[]

required

Example:

["example"]

result.scheduled_time

string

required

Example:

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

result.clip

boolean

required

Example:

false

result.clip_from

string

required

Required string length: 21

Example:

"abcde12345abcde12345a"

result.clip_start

string

required

Example:

"00:00:30"

result.clip_end

string

required

Example:

"00:01:30"

result.created_by

string

required

Required string length: 21

Example:

"abcde12345abcde12345a"

result.created_time

string

required

Example:

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

result.updated_by

string

required

Required string length: 21

Example:

"abcde12345abcde12345a"

result.updated_time

string

required

Example:

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

links

object

required

Example:

{}

errors

object[]

required

Example:

[]

Update user Create video

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": []
}

Video API

Analytics

API keys

Audit logs

Categories

Folders

Identity providers

Invites

JWT keys

Players

Services

Stream keys

Tokens

Transcribes

Uploads

Users

Videos

Authorizations

Query Parameters

Response