The Pixop REST API provides programmatic access to Pixop's video enhancement platform.
This reference contains detailed documentation for individual API endpoints, including request parameters, response formats, and schemas.
New to the Pixop REST API?
If you are getting started, we recommend beginning with the REST API guides in Documentation:
- Getting started – prerequisites, authentication, and an overview of the API
- Quick Start Guide – follow the basic Pixop workflow from upload to download
- Webhooks – receive notifications when events occur
- Video Enhancement Recipes – examples for common processing workflows
Once you are familiar with the workflow, use the endpoint reference below when implementing your integration.
Typical API workflow
A typical Pixop workflow consists of:
- Ingesting a source video
- Creating an appraisal for the desired processing configuration
- Accepting the appraisal
- Monitoring processing
- Requesting and downloading the processed result
The exact endpoints and available options are documented in the sections below.
Authentication
Pixop REST API requests are authenticated using an API key.
See Getting started for instructions on creating and using an API key, or see the api key endpoints below for API key management.
OpenAPI specification
Pixop publishes an OpenAPI specification for the REST API.
See OpenAPI Specification for the live specification, versioning information, and GitHub repository.
Need help?
If you have questions about the Pixop REST API, contact [email protected].