Requests
- Send your API key in the
X-Api-Keyheader. - Send JSON request bodies with
Content-Type: application/json. - Use
multipart/form-datafor thumbnail and subtitle file uploads. - The API returns JSON for both successful requests and application errors.
Identifiers
Video IDs are 12-character word strings. Folder IDs are positive integers. Remote-upload IDs use the same 12-character format as video IDs.Pagination
List operations use one-based pages. Responses include:object
required
Pagination metadata for the returned collection.
per_page, while other paginated operations accept perPage.
Upload flow
GET /v1/upload selects an available file server and returns its base URL plus an opaque upload session. File transfer runs on the selected file server, not on api.videobase.com.
Treat the returned session as a secret. It contains upload authorization and is intended only for the selected upload service.
Remote uploads are separate. Use POST /v1/upload/url to queue a publicly reachable HTTP or HTTPS URL, then poll GET /v1/upload/url/status.
Dates and sizes
- Timestamps use
YYYY-MM-DD HH:mm:ssin server time unless a field says otherwise. - Account storage values are in KB.
- Video and remote-upload byte counts are bytes.