Uploads
Create upload
- 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
Uploads
Create upload
Create a new upload
POST
/
uploads
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
object
*
name
string
name
string
The file name
Add Example Value
size
integer
size
integer
The file size, in bytes
Add Example Value
curl --request POST \
--url https://api.vidbeo.com/v2/uploads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Example",
"size": 12345
}'
{
"success": true,
"result": {
"id": "abcde12345abcde12345a",
"name": "Example",
"size": 12345,
"key": "path/to/file",
"url": "https://example.com/path/to/file",
"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
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
name
string
The file name
size
integer
The file size, in bytes
Response
200 - application/json
success
boolean
requiredresult
object
requiredresult.id
string
requiredresult.name
string
requiredresult.size
integer
requiredresult.key
string
requiredresult.url
string
requiredresult.created_by
string
requiredresult.created_time
string
requiredresult.updated_by
string
requiredresult.updated_time
string
requiredlinks
object
requirederrors
object[]
requiredcurl --request POST \
--url https://api.vidbeo.com/v2/uploads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Example",
"size": 12345
}'
{
"success": true,
"result": {
"id": "abcde12345abcde12345a",
"name": "Example",
"size": 12345,
"key": "path/to/file",
"url": "https://example.com/path/to/file",
"created_by": "abcde12345abcde12345a",
"created_time": "2024-01-01T00:00:00.000Z",
"updated_by": "abcde12345abcde12345a",
"updated_time": "2024-01-01T00:00:00.000Z"
},
"links": {},
"errors": []
}