Skip to main content

Introduction

Welcome to the VP Player API documentation page. This guide provides comprehensive information on how to use the VP API and VP Player to create and deliver high-quality media content. The VP API offers a range of methods for uploading, encoding, and managing content, while the VP Player provides a clean and dynamic video playback experience that is easy to use.

Authorization​

To gain access to VP API, you need to sign up for an account and request authorization. Once authorized, you will receive an API key that you can use to access the API. Our API key management system allows you to easily revoke or regenerate keys as needed.

Setting up the VP Player API​

After gaining authorization, you can set up the VP API by following our clear and easy-to-understand instructions. We provide detailed information on how to set up the API and endpoints to ensure that you can start using it quickly and effectively.

Uploading and Encoding content​

The VP API offers a variety of methods for uploading and encoding video and audio files. We provide detailed instructions on how to use these methods to create high-quality media content. You can upload content directly from your device, or you can use our API to connect to your cloud storage provider.

Managing content​

VP API allows you to manage your content easily and efficiently. We provide detailed instructions on how to delete, update, or retrieve content using the API.

Response format​

Every response carries the same envelope: success, errors, messages, result, resultInfo, errorCode and statusCode. errorCode is a fixed, machine-readable code for the rejections that define one (for example UPLOAD_AUTHOR_MISMATCH, UPLOAD_REFERENCE_REQUIRED and UPLOAD_AUTHOR_REQUIRED on the upload and encode endpoints) and null on success and on every other response. For those rejections errors[0] also carries the code and resultInfo the message; clients should branch on errorCode. Response samples in this documentation that predate the field omit it.

Conclusion​

Thank you for choosing VP Player API. We are committed to providing you with the best possible experience, and we hope this documentation helps you create and deliver high-quality video content with ease. If you have any questions or concerns, please do not hesitate to contact us.