Introduction
The video API allows creation and management of the video entity in Indee.
As video objects are created and video files are uploaded, the Indee system begins processing of the videos. The following are the various states a video will flow through: Submitted > Downloading > Processing > Ready or Error.
API Endpoints | Description |
---|---|
Get all Videos | Fetches the list of videos and their metadata available for the logged-in user. |
Create Video | Creates a video entity on the Indee platform. |
Edit Video | Allows the user to edit the video created on Indee platform. |
Video Details | Returns all the details pertaining to the video. |
Video Deletion | Deletes a video. |
Assign Video Permissions | Allows you to assign video permissions based on your requirement. |
Get Video Permissions | Fetches a list of video permission provided to various individuals in your organization. |
Authorization
Video creation and management APIs require a valid session to be established before they can be used. Please refer to Admin Authorization API for authorization.
Headers
The JWT Access token should be passed in the authorization header for all APIs.
Header | Value |
---|---|
Authorization | JWT token. |
The API responses will contain the "status_code" which will describe the state of the video, the significance of each status code is described in this section of the API status codes document.
Common Error and Success Codes
The API response for video creation and management APIs follow the common status code format as outlined in the API Status codes.
Success Codes
Indee Status Code | HTTP Status Code |
---|---|
A0000 | 200 |
Error Codes
Indee Status Code | HTTP Status Code |
---|---|
A2003 | 401 |
A2000 | 401 |
A2100 | 401 |
Error Response
The error responses for all Video APIs will follow the model as outlined in Indee Error codes.
Field | Type | Description |
---|---|---|
status_code |
String | Indee provided status code. |
status_message |
String | The message associated with the status code. |
ext_video_id |
String | A customer provided unique ID for the video. |