Video API
Analytics
Audit logs
Categories
Folders
Identity providers
Transcribes
Videos
- 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
Videos
Create hotspot
Create a new hotspot
POST
/
videos
/
{VIDEO_ID}
/
hotspots
Copy
curl --request POST \
--url https://api.vidbeo.com/v2/videos/{VIDEO_ID}/hotspots \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"show_at": "<string>",
"hide_at": "<string>",
"x": 123,
"y": 123,
"action": "link",
"link": "<string>",
"target": "_blank",
"opacity": "invisible"
}'
Copy
{
"success": true,
"result": {
"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"
},
"links": {},
"errors": []
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the video
Example:
"abcde12345abcde12345a"
Body
application/json
Response
200
application/json
Hotspot
The response is of type object
.
Copy
curl --request POST \
--url https://api.vidbeo.com/v2/videos/{VIDEO_ID}/hotspots \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"show_at": "<string>",
"hide_at": "<string>",
"x": 123,
"y": 123,
"action": "link",
"link": "<string>",
"target": "_blank",
"opacity": "invisible"
}'
Copy
{
"success": true,
"result": {
"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"
},
"links": {},
"errors": []
}
Assistant
Responses are generated using AI and may contain mistakes.