api.video API Documentation
This is the complete API documentation for connecting to the api.video API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet api.video: api.video provides APIs for video hosting, streaming, delivery, and analytics workflows. Keep reading to get started.
Quickstart
Before you run your first api.video request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one api.video connection — create or choose one in Connections. Note its
connectionId.
Every api.video action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/apivideo/actions/{actionSlug}/runYou need a MindCloud API Key and a api.video connection. Then call an action such as List all video objects:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/apivideo/actions/list-videos/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your api.video account. See api.video API Authentication for the full flow and how to get your connection credentials.
api.video actions
All 36 published actions for this api.video version. Each page documents the endpoint, arguments, and response controls.
- PUTComplete a live stream
- POSTCreate a player
- POSTCreate a video object
- POSTCreate live stream
- POSTCreate Webhook
- DELETEDelete a live stream
- DELETEDelete a player
- DELETEDelete a video object
- DELETEDelete a Webhook
- DELETEDelete an upload token
- DELETEDelete video summary
- POSTGenerate an upload token
- POSTGenerate video summary
- POSTGet Bearer Token
- GETGet summary details
- GETList all active upload tokens
- GETList all live streams
- GETList all player themes
- GETList all video objects
- GETList all video tags
- GETList all webhooks
- GETList summaries
- POSTRefresh Bearer Token
- GETRetrieve a player
- GETRetrieve a video object
- GETRetrieve aggregated metrics
- GETRetrieve live stream
- GETRetrieve metrics in a breakdown of dimensions
- GETRetrieve metrics over time
- GETRetrieve upload token
- GETRetrieve video status and details
- GETRetrieve Webhook details
- PUTUpdate a live stream
- PUTUpdate a player
- PUTUpdate a video object
- PUTUpdate summary details
Related apps
More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.