Quick Start Guide

1. Getting Started & Authentication

1. Overview & Auth Guide: Read the general overview and authentication instructions: Getting started

2. Create Your API Key: Generate a new API key to authenticate your requests: Create a new API key

2. Video “In” Endpoints

Upload source videos to Pixop by creating a master video object: Create master video from HTTPS

Tip: You can also create master videos from files already stored in AWS S3 using the corresponding S3 endpoints.

3. Processing Configurations

Before processing, obtain a processing configuration ID (confId):

• Built-in Configurations: Explore our predefined configurations: Retrieve video processing configurations

• Custom Configurations: Create a custom configuration and note the returned confId: Create a new video processing configuration

Tip: If you prefer, there are alternative video processing endpoints that allow you to pass a full configuration object inline instead of referencing a confId.

4. Video Processing & Cost Estimation

1. Create an Appraisal: Estimate processing costs and preview quality: Create video processing appraisal by confId

2. Accept the Appraisal: Start the processing job by accepting the appraisal: Accept video processing appraisal

3. Monitor Job Status:

   • Poll status: Retrieve video processing status
   • Webhook notifications: Create a new webhook

Tip: To control costs, experiment on small clips by setting startPosMs and endPosMs in your processing requests before scaling up.

5. Video “Out” Endpoints

Retrieve your processed video by generating a download URL: Generate video download URL

Tip: You can also configure the output to copy directly to AWS S3 using the corresponding S3 endpoints.

Next Steps & Support

• Explore additional endpoints and advanced use cases in our API reference.
• If you have any questions or encounter issues, contact us at [email protected].