Getting started

📘 Pixop API Overview

The Pixop 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 offers advanced video processing features such as upscaling, format conversion, and compression. It leverages AI-driven algorithms to enhance video quality, reduce file sizes, and improve playback performance.

🔐 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"