API Documentation Home

This is the main entry page of the Xvid MediaHub API documentation. It gives a brief of the available APIs and simple examples on how to use them.

The MediaHub API is a RESTful API and uses OAuth 2.0 bearer tokens for authorization and access control. Most popular scripting languages provide HTTP clients that can be used to launch queries to the API and will make interfacing with our API an easy task.

The main API endpoint is:

https://api.xvid.com/v1/

Due to the use of OAuth 2.0 for authorization, the bearer token must be kept secret and therefore all requests to the API must always be made via HTTPS/SSL. Therefore, unsecured requests via HTTP are generally rejected.

Documentation Structure

The documentation is structured as follows:

• General API conventions
   
• REST Resources
  • Authorization
  • Codecs
  • Presets
  • Pipelines
  • Jobs
  • Backtraces
  • Files
  • Users
     
• Tutorials and Examples