Pixop

Pixop API

The Pixop API provides a comprehensive RESTful interface for interacting with the Pixop Platform. It allows users to manage API keys, projects, videos, and…

Media & content#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

The Pixop Platform offers video processing features such as upscaling, format conversion, and compression. It uses
AI-driven algorithms to optimize video quality, reduce file sizes, and improve playback performance.

Quick Start Guide

Required Headers
Include the following headers in all API requests:

  • Accept: application/json
  • Content-Type: application/json
  • X-API-Key: Your API key for authentication (e.g., X-API-Key: ).

Note: API key management endpoints that 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 details:

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

Endpoints 75

api key

  • GETRetrieve API keys/v1/api-keysRetrieves a paginated list of API keys associated with the authenticated user.
  • POSTCreate a new API key/v1/api-keysCreates a new API key associated with the authenticated user. API keys are used for authentication when accessing the Pixop API. Each user can have up to 2…
  • GETRetrieve API key details/v1/api-keys/:idRetrieves the details of a specific API key using its unique identifier.
  • DELETEDelete an inactive API key/v1/api-keys/:idDeletes an inactive API key. Active API keys must be deactivated before they can be deleted. A 409 Conflict response is returned, if the API key is active.
  • PATCHUpdate an API key/v1/api-keys/:idUpdates the name or description of an existing API key. To activate or deactivate an API key, use the respective endpoints.
  • POSTDeactivate an API key/v1/api-keys/:id/deactivateDeactivates an API key. If the API key is already inactive, the operation has no effect.
  • POSTActivate an API key/v1/api-keys/:id/activateActivates an API key. If the API key is already active, the operation has no effect. If the maximum number of active API keys allowed has been reached, a 409…

account

  • GETRetrieve account details/v1/accountRetrieves account details for the provided API key.

stripe-billing

  • GETRetrieve Stripe financial details/v2/stripe/financial-detailsRetrieves financial details for Stripe/wallet-billed teams, including the current balances and total processing amount spent for the selected team.
  • GETRetrieve paginated list of Stripe billing periods/v2/stripe/billing-periodsRetrieves a paginated list of Stripe billing periods associated with the provided API key.
  • GETRetrieve Stripe billing period details/v2/stripe/billing-periods/:idRetrieves the details of a specific Stripe billing period.
  • GETRetrieve transactions for a Stripe billing period/v2/stripe/billing-periods/:id/transactionsRetrieves a paginated list of transactions for a specific Stripe billing period. The fromDateTime param defaults to the creation date of the team.
  • GETRetrieve transactions for the latest Stripe billing period/v2/stripe/billing-periods/latest/transactionsRetrieves a paginated list of transactions for the selected team’s latest Stripe billing period, sorted by date. The fromDateTime param defaults to the…

aws-marketplace-billing

  • GETRetrieve paginated list of AWS Marketplace subscriptions/v2/aws-marketplace/subscriptionsRetrieve paginated AWS Marketplace agreement history rows associated with the provided API key. Each row contains durable subscription/license context plus…
  • GETRetrieve AWS Marketplace subscription details/v2/aws-marketplace/subscriptions/:agreementIdRetrieves durable subscription/license context plus the selected AWS agreement version identified by agreementId.
  • GETRetrieve current AWS Marketplace subscription/v2/aws-marketplace/subscriptions/currentRetrieves the current durable AWS Marketplace subscription/license linked to the selected team, including its current AWS agreement version.
  • GETRetrieve AWS Marketplace Pixop Credits usage/v2/aws-marketplace/credits-usageRetrieves a paginated list of Pixop Credits usage records for the selected team. The fromDateTime param defaults to the first date and time the team was…

team

  • GETRetrieve paginated list of teams/v1/teamsRetrieves a paginated list of teams associated with the provided API key.
  • GETRetrieve team details/v1/teams/:idRetrieves the details of a team by its unique identifier.

project

  • GETRetrieve paginated list of projects/v1/projectsRetrieves a paginated list of projects associated with the provided API key.
  • POSTCreate a new project/v1/projectsCreates a new project within the selected team.
  • GETRetrieve project details for the default project of the selected team/v1/projects/defaultRetrieves the details of the default project of the selected team. The default project of a team is the oldest project with the name 'Default Project'. If the…
  • GETRetrieve project details/v1/projects/:idRetrieves the details of a specific project by its unique identifier.
  • DELETEDelete a project/v1/projects/:idDeletes a project by its unique identifier. If the project has videos associated with it, a 409 Conflict response is returned. Videos must be deleted before…
  • PATCHUpdate an existing project/v1/projects/:idUpdates the details of an existing project by its unique identifier.

S3 input location

  • GETRetrieve paginated list of S3 input locations/v1/input-locations/s3Retrieves a paginated list of S3 input locations associated with the provided API key.
  • POSTCreate a new S3 input location/v1/input-locations/s3Creates a new S3 input location for the selected team, which can be used with the POST /v1/videos/in/s3/{inputLocationId} endpoint to create a master video…
  • GETRetrieve S3 input location details/v1/input-locations/s3/:idRetrieves the details of an S3 input location by its unique identifier.
  • DELETEDelete an S3 input location/v1/input-locations/s3/:idDeletes an S3 input location by its unique identifier.
  • PATCHUpdate an S3 input location/v1/input-locations/s3/:idUpdates the details of an existing S3 input location by its unique identifier.

S3 output location

  • GETRetrieve paginated list of S3 output locations/v1/output-locations/s3Retrieves a paginated list of S3 output locations associated with the provided API key.
  • POSTCreate a new S3 output location/v1/output-locations/s3Creates a new S3 output location for the selected team. This location can be used with the POST /v1/videos/{videoId}/out/s3/{outputLocationId} endpoint to…
  • GETRetrieve S3 output location details/v1/output-locations/s3/:idRetrieves the details of an S3 output location by its unique identifier.
  • DELETEDelete an S3 output location/v1/output-locations/s3/:idDeletes an S3 output location by its unique identifier.
  • PATCHUpdate an S3 output location/v1/output-locations/s3/:idUpdates the details of an existing S3 output location by its unique identifier.

video processing configuration

  • GETRetrieve paginated list of video processing configurations/v1/processing-configurationsRetrieves a paginated list of video processing configurations associated with the provided API key.
  • POSTCreate a new video processing configuration/v1/processing-configurationsCreates a new video processing configuration for the selected team.
  • GETRetrieve video processing configuration details/v1/processing-configurations/:confIdRetrieves the details of a video processing configuration by its unique identifier.
  • DELETEDelete a video processing configuration/v1/processing-configurations/:confIdDeletes a video processing configuration by its unique identifier.

video

  • GETRetrieve paginated list of videos/v1/videosRetrieves a paginated list of videos associated with the provided API key.
  • GETRetrieve details about a video/v1/videos/:videoIdRetrieves details about a specific video by its unique identifier.
  • DELETEDelete a video/v1/videos/:videoIdDeletes a video by its unique identifier. When deleting a master video record, all derived videos will also be deleted. When deleting a clip, any processed…
  • PATCHUpdate an existing video/v1/videos/:videoIdUpdates the metadata of an existing video by its unique identifier.
  • GETRetrieve derived videos/v1/videos/:videoId/derivedRetrieves a paginated list of videos derived from the specified videoId. When the videoId refers to a master video record, all related videos and clips are…
  • GETGet a web comparison link for two videos/v1/videos/:videoId/compare-with/:targetVideoIdProvides a link to compare two videos in Pixop Studio, provided both videos have been fully ingested with complete frames and a web version, their durations…

video in

  • POSTCopy video data from an HTTPS URL into the Pixop Platform/v1/videos/in/httpsCopies video data from an HTTPS URL into the Pixop Platform, making it available for processing. A new master video record is created for the selected team,…
  • POSTCopy video data from an S3 bucket into the Pixop Platform/v1/videos/in/s3Copies video data from an S3 bucket into the Pixop Platform, making it available for processing. A new master video record is created for the selected team,…
  • POSTCopy video data from an S3 input location into the Pixop Platform/v1/videos/in/s3/:inputLocationIdCopies video data from a preconfigured S3 input location into the Pixop Platform, creating a new master video record for the selected team. This is similar to…
  • GETRetrieve "video in" status/v1/videos/:videoId/in/statusRetrieves the status of the asynchronous copy operation initiated by: POST /v1/videos/in/https POST /v1/videos/in/s3 POST /v1/videos/in/s3/{inputLocationId}…
  • POSTRestart a failed "video in" operation/v1/videos/:videoId/in/restartRestarts a failed "video in" operation. The operation resumes from where it previously failed. Note: This is only allowed when uploadStatus is FAILED.…
  • DELETEAbandon a failed "video in" operation/v1/videos/:videoId/in/abandonAbandons a failed "video in" operation. This operation permanently deletes the video record and all associated data. Note: This is only allowed when…

video processing

  • POSTCreate an appraisal using a configuration ID/v1/videos/:videoId/processing/appraisals/create/:confIdCreates an appraisal for processing a video with options specified in the query parameters and a predefined configuration identified by confId. The processed…
  • POSTCreate an appraisal for processing a video/v1/videos/:videoId/processing/appraisals/createCreates an appraisal for processing a video with options specified in the query parameters and request body. The processed video will be associated with the…
  • POSTAccept a video processing appraisal/v1/videos/:videoId/processing/appraisals/:appraisalId/acceptAccepts a video processing appraisal and initiates the processing of the specified video. A new video, identified by the videoId returned in the response, is…
  • POSTStart video processing using a configuration ID/v1/videos/:videoId/processing/start/:confIdInitiates the processing of the specified video with options specified in the query parameters and a predefined configuration identified by confId. A new…
  • POSTStart video processing/v1/videos/:videoId/processing/startInitiates the processing of the specified video with options specified in the query parameters and request body. A new video, identified by the videoId…
  • GETRetrieve video processing status/v1/videos/:videoId/processing/statusRetrieves the status of the asynchronous video processing task initiated by: POST /v1/videos/{videoId}/processing/appraisals/{appraisalId}/accept POST…

video out

  • POSTGenerates a pre-signed URL for downloading video data./v1/videos/:videoId/out/httpsGenerates a pre-signed HTTPS URL for downloading the video from the Pixop platform. Resumable downloads are supported via HTTP Range requests. The URL remains…
  • POSTCopy video data to an S3 bucket/v1/videos/:videoId/out/s3Initiates an asynchronous multipart copy operation to transfer video data from the Pixop Platform to the specified S3 bucket. The video data is not ready for…
  • POSTCopy video data to an S3 bucket using an output location ID/v1/videos/:videoId/out/s3/:outputLocationIdInitiates an asynchronous copy operation to transfer video data to an S3 bucket defined by the specified outputLocationId. The behavior is identical to POST…
  • GETRetrieve the status of a "video out" operation/v1/videos/:videoId/out/statusRetrieves the status of the asynchronous copy operation initiated by: POST /v1/videos/{videoId}/out/s3 POST /v1/videos/{videoId}/out/s3/{outputLocationId} The…
  • POSTRestart a failed "video out" operation/v1/videos/:videoId/out/restartRestarts a failed "video out" operation, resuming from the point where it previously failed. Note: This operation is only allowed when the status is FAILED.…
  • DELETEAbandon a failed "video out" operation/v1/videos/:videoId/out/abandonAbandons a failed "video out" operation and releases resources allocated for the multipart upload process. Note: This operation is only allowed when the…

webhook public key

  • GETList all webhook public keys/v1/webhooks/public-keysReturns a list of webhook public keys used to verify webhook signatures. Typically, only one key is active at a time. During key rotation — which occurs at…
  • GETRetrieve a specific webhook public key/v1/webhooks/public-keys/:idRetrieves the details of a specific webhook public key using its unique identifier.

webhook

  • GETRetrieve webhooks/v1/webhooksRetrieves a paginated list of webhooks associated with the provided API key.
  • POSTCreate a new webhook/v1/webhooksCreates a new webhook for the selected team. Webhooks are used to receive notifications about events on the Pixop Platform. Each team can have up to 10 active…
  • GETRetrieve webhook details/v1/webhooks/:idRetrieves the details of a specific webhook using its unique identifier.
  • DELETEDelete a webhook/v1/webhooks/:idDeletes a webhook by its unique identifier.
  • PATCHUpdate a webhook/v1/webhooks/:idUpdates the details of an existing webhook. To activate or deactivate a webhook, use the respective endpoints.
  • POSTTest a video webhook/v1/webhooks/:id/testSends a test event to the specified video webhook. You may optionally provide a videoId and/or eventType. If videoId is omitted, a random UUID will be…
  • POSTDeactivate a webhook/v1/webhooks/:id/deactivateDeactivates the specified webhook. If the webhook is already inactive, the operation has no effect.
  • POSTActivate a webhook/v1/webhooks/:id/activateActivates the specified webhook. If the webhook is already active, the operation has no effect. If the team has reached the maximum number of allowed active…

webhook event

  • GETRetrieve webhook events/v1/webhooks/eventsRetrieves a paginated list of webhook events associated with the provided API key. Each event represents delivery attempts for a configured webhook, including…
  • GETRetrieve webhook event details/v1/webhooks/events/:idRetrieves the details of a specific webhook event using its unique identifier. This includes metadata such as timestamps, status code, and payload sent.

API details

Base URL
https://api.pixop.com/api
https://staging-api.pixop.com/api
Authentication
HTTP Basic authentication (username and password)
An API key in the X-API-Key header
Operations
75 operations on 56 pathsGET 36POST 24DELETE 9PATCH 6
Main resources
webhook 8api key 7project 6video 6video in 6video out 6video processing 6S3 input location 5S3 output location 5stripe-billing 5
Description format
OpenAPI 3.1.0, API version 2.1.0

How to test the Pixop API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Pixop API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieve API keys” (GET /v1/api-keys), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Pixop API?

The Pixop API provides a comprehensive RESTful interface for interacting with the Pixop Platform. It allows users to manage API keys, projects, videos, and… It is listed under Media & content and has 75 endpoints.

Who publishes the Pixop API?

It is listed from Pixop's public API description (an OpenAPI document), not published by Pixop on Swastik Codes. Anyone who controls pixop.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Pixop API?

Its description lists 2 base URLs: https://api.pixop.com/api, https://staging-api.pixop.com/api. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Pixop API?

It accepts 2 methods: HTTP Basic authentication (username and password); an API key in the X-API-Key header.

How many endpoints does the Pixop API have?

75 operations on 56 paths (36 GET, 24 POST, 9 DELETE, 6 PATCH). The largest groups are webhook, api key, project, video.

Is forking the Pixop API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.