API Reference
Start typing to search…

Getting started

Pixop API Overview

The Pixop REST API provides a comprehensive RESTful interface for interacting with the Pixop Platform. It enables you to manage API keys, projects, videos, and more.

The Pixop Platform provides professional-grade video enhancement and format conversion for post-production workflows. It leverages advanced AI-driven algorithms to upscale resolution (up to 8K), convert frame rates, restore detail, reduce compression and interlacing artifacts, and perform color space transformations (e.g., SDR to HDR).

Prerequisites

A valid Pixop Platform user on an enterprise team plan is a prerequisite to use our REST API:

  1. Sign up via Pixop Studio. We suggest you create a unique API user as a practical means of keeping machine and human identities and credentials separate. One way of achieving this is to first sign up for a personal Pixop account and then invite the API machine user to your team.
  2. An enterprise Pixop team plan is required to authenticate with the API. Reach out to us via Intercom or at [email protected] and we'll be happy to help you get set up.

You are now ready to integrate the API into your own systems using your programming language of choice.

Authentication

All standard requests require an API key, which must be included in the X-API-Key header:

X-API-Key: YOUR_API_KEY

You can create and manage your API keys via the /v1/api-keys endpoints. These endpoints use Basic Authentication, which requires encoding your email and password as a base64 string:

Authorization: Basic base64(email:password)

Required Headers

All requests to the Pixop API must include the following headers:

  • Accept: application/json
  • Content-Type: application/json
  • X-API-Key: YOUR_API_KEY

Note: Endpoints related to API key management (which use Basic Authentication) do not require the X-API-Key header.

Rate Limits

All endpoints—except those related to API key management—enforce rate limits. Response headers provide the following rate limit information:

  • X-RateLimit-Limit: Maximum number of requests allowed per minute
  • X-RateLimit-Remaining: Number of requests remaining in the current window
  • X-RateLimit-Reset: Number of seconds until the rate limit window resets

Example Request

curl -X GET https://api.pixop.com/api/v1/videos \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"