PATCH
/
videos
/
{VIDEO_ID}
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": false,
  "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": false,
    "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",
    "clip": false,
    "clip_from": "abcde12345abcde12345a",
    "clip_start": "00:00:30",
    "clip_end": "00:01:30",
    "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

​
Authorization
string
header
required

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

Path Parameters

​
VIDEO_ID
string
required

ID of the video

Example:

"abcde12345abcde12345a"

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 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

Example:
["example"]

Response

200
application/json
Video
​
success
boolean
required
Example:

true

​
result
object
required
​
links
object
required
Example:
{}
​
errors
object[]
required
Example:
[]