Skip to main content

Introduction

The BlendVision platform APIs enable you to automate interactions and seamlessly integrate BlendVision's solutions into your system and applications using RESTful APIs, which are independent of any specific programming language, offering:

  • HTTP Request which can be made using various methods, such as GET, POST, PATCH, PUT, and DELETE.
  • JSON Response which can be easily parsed into native data types.

Prerequisites


API Overview

API GroupUse
VODManage VOD assets, perform encoding jobs, and handle content features, such as DRM, subtitles, chapter settings, etc.
LiveManage the event assets, host the lifecycle for live events, and handle content features, such as broadcast mode, DRM, live-to-VOD, etc.
AODManage AOD assets, perform encoding jobs, and handle content features, such as subtitles.
LibraryUpload and manage source files such as videos, images, subtitles, etc.
ConfigurationManage general configuration, including encoding profiles and cloud storage for source uploading.
PlaybackCreate and obtain the tokens for content publishing and playback.
ChatroomCreate, embed and utilize the chatroom.
AnalyticsRetrieve the player engagement and billing usage.
AccountManage your account.
OrganizationManage your organizations.
BillingDownload the billing information of your organizations.
AiSKCreate and manage your source data, knowledge bases, and chatbots.
note

For more comprehensive information about the APIs' use cases and dependencies, refer to the individual guides for each function.


Documentation Features

Request

Necessary details for making requests to interact with the API.

  1. Endpoint: The URL path for making HTTP requests.
  2. Request Schema: Parameters that can be passed with the endpoint to influence the response, including neccessary Authorization , x-bv-org-id (refer to Authentication), and other query parameters.
  3. Request Example: Sample request body in various programming languages.

Request


Responses

Essential information about possible responses for integration and interaction with the API.

  1. Reponse Codes: Possible result codes that that may be returned by the response. Clicking on the code buttons provides access to the associated schema and example below.
  2. Reponse Schema: Possible values that may be present in the response.
  3. Reponse Example: Sample response body will be provided when you click the Example (from schema) button.

Response-1-2 Response-3


Sandbox

The API sandbox serves as an interactive environment for directly testing the API with specific request parameters and generating simulated responses, eliminating the need for external testing tool installation.

  1. Request: Field where you can enter the request parameters. After completing your input, click on the SEND API REQUEST button to generate the simulated response below.
  2. Response: Simulated response body based on the request sent above.

Sandbox

tip

To test the API, you can also make use of the request example and external tools such as cURL or Postman, according to your preferences.