Create a new video processing configuration

post https://api.pixop.com/api/v1/processing-configurations

Creates a new video processing configuration for the selected team.

Responses

Response body

object

uuid

required

Unique identifier for the object.

createdAt

date-time

required

Date and time when the object was created.

updatedAt

date-time

required

Date and time when the object was last updated.

teamId

uuid

The unique identifier of the team associated with this video processing configuration.

name

string

length between 1 and 47

The name of the video processing configuration. This provides a clear reference for applying specific processing settings to videos.
The name must be between 1 and 47 characters long.

options

object

The options and settings defined for this video processing configuration.

encodingProfile

string

The encoding profile used in the video encoding process, controlling the media container, codec, chroma subsampling, and bitrate.

If encodingProfile is set, encodingConfiguration should not be specified.

Available profiles:

Apple ProRes

PRORES_422_LT: Apple ProRes 422 (LT)
PRORES_422_STANDARD: Apple ProRes 422 (Standard)
PRORES_422_PROXY: Apple ProRes 422 (Proxy)
PRORES_422_HQ: Apple ProRes 422 (HQ)
PRORES_4444_STANDARD: Apple ProRes 4444 (Standard)
PRORES_4444_XQ: Apple ProRes 4444 (XQ)

Avid DNxHD

DNXHD_36_LB: Avid DNxHD 36 (Low Bandwidth)
DNXHD_45_LB: Avid DNxHD 45 (Low Bandwidth)
DNXHD_75_LB: Avid DNxHD 75 (Low Bandwidth)
DNXHD_90_LB: Avid DNxHD 90 (Low Bandwidth)
DNXHD_115_SQ: Avid DNxHD 115 (Standard Quality)
DNXHD_120_SQ: Avid DNxHD 120 (Standard Quality)
DNXHD_145_SQ: Avid DNxHD 145 (Standard Quality)
DNXHD_240_SQ: Avid DNxHD 240 (Standard Quality)
DNXHD_290_SQ: Avid DNxHD 290 (Standard Quality)
DNXHD_175_HQ: Avid DNxHD 175 (High Quality)
DNXHD_185_HQ: Avid DNxHD 185 (High Quality)
DNXHD_220_HQ: Avid DNxHD 220 (High Quality)
DNXHD_365_HQ: Avid DNxHD 365 (High Quality)
DNXHD_440_HQ: Avid DNxHD 440 (High Quality)
DNXHD_175X_HQX: Avid DNxHD 175X (High Quality Extended)
DNXHD_185X_HQX: Avid DNxHD 185X (High Quality Extended)
DNXHD_220X_HQX: Avid DNxHD 220X (High Quality Extended)
DNXHD_365X_HQX: Avid DNxHD 365X (High Quality Extended)
DNXHD_440X_HQX: Avid DNxHD 440X (High Quality Extended)
DNXHD_350X_444: Avid DNxHD 350X (4:4:4)
DNXHD_390X_444: Avid DNxHD 390X (4:4:4)
DNXHD_440X_444: Avid DNxHD 440X (4:4:4)
DNXHD_730X_444: Avid DNxHD 730X (4:4:4)
DNXHD_880X_444: Avid DNxHD 880X (4:4:4)

Avid DNxHR

DNXHR_LB: Avid DNxHR LB (Low Bandwidth)
DNXHR_SQ: Avid DNxHR SQ (Standard Quality)
DNXHR_HQ: Avid DNxHR HQ (High Quality)
DNXHR_HQX: Avid DNxHR HQX (High Quality Extended)
DNXHR_444: Avid DNxHR 444 (4:4:4)

PRORES_422_LT PRORES_422_STANDARD PRORES_422_PROXY PRORES_422_HQ PRORES_4444_STANDARD PRORES_4444_XQ DNXHD_36_LB DNXHD_45_LB DNXHD_75_LB DNXHD_90_LB DNXHD_115_SQ DNXHD_120_SQ DNXHD_145_SQ DNXHD_240_SQ DNXHD_290_SQ DNXHD_175_HQ DNXHD_185_HQ DNXHD_220_HQ DNXHD_365_HQ DNXHD_440_HQ DNXHD_175X_HQX DNXHD_185X_HQX DNXHD_220X_HQX DNXHD_365X_HQX DNXHD_440X_HQX DNXHD_350X_444 DNXHD_390X_444 DNXHD_440X_444 DNXHD_730X_444 DNXHD_880X_444 DNXHR_LB DNXHR_SQ DNXHR_HQ DNXHR_HQX DNXHR_444

encodingConfiguration

object

Configuration options for encoding a video, allowing detailed control over the encoding process.
Should not be used in conjunction with encodingProfile.

container

string

The media container format for the video. Some containers only support specific codecs. Specifying an unsupported codec for a container will result in a 400 Bad Request response.

Supported codecs by container:

MOV: H264, PRORES, DNXHD, HEVC, MPEG2, FFV1
MXF: H264, XDCAM, MPEG2, DNXHD
MP4: H264, HEVC
MPEGTS: H264, HEVC, MPEG2

MOV MXF MP4 MPEGTS

filters

object

Specifies the filters to apply to the video. To disable a specific filter, set its value to null or remove the corresponding field.

filterSettings

object

Additional settings for video filters. These settings allow customization of specific filter behaviors, such as cropping coordinates, deinterlacing modes, and resolution adjustments.

processingSettings

object

Additional processing settings for input and output color space conversions, tone mapping, and fixed output resolutions.
These settings ensure precise control over colorimetry and dynamic range transformations during video processing.

builtin

boolean

Indicates whether this configuration is built-in. Built-in configurations cannot be modified.

description

string

length between 1 and 255

A description of the video processing configuration. This provides additional context or details about the
processing settings, such as the purpose for the configuration.

Headers

object

X-RateLimit-Limit

integer

The maximum number of requests allowed per minute.

X-RateLimit-Remaining

integer

The number of requests remaining in the current rate limit window.

X-RateLimit-Reset

integer

The number of seconds until the current rate limit window resets.

`X-API-Key` or basic authentication credentials.

403

Access denied. You do not have the necessary permissions to access this resource.

429

Too Many Requests. The rate limit for this resource has been exceeded.

500

An unexpected error occurred on the server.

xxxxxxxxxx
curl --request POST \
     --url https://api.pixop.com/api/v1/processing-configurations \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "options": {
    "filterSettings": {
      "faceForward": {
        "autoWhiteBalance": true
      },
      "filmGrain": {
        "grainSize": "SUPER_FINE"
      }
    },
    "processingSettings": {
      "inputColorSpaceConversion": {
        "mappingMode": "STRICT_USER",
        "toneMapper": {
          "algorithm": "LINEAR"
        }
      },
      "outputColorSpaceConversion": {
        "mappingMode": "STRICT_USER",
        "inverseToneMapper": {
          "algorithm": "INFINITEHDR"
        }
      }
    }

201Video processing configuration successfully created.

400Invalid request. Inspect the details of the error for more information.

401Authorization failed. Missing or invalid X-API-Key or basic authentication credentials.

403Access denied. You do not have the necessary permissions to access this resource.

429Too Many Requests. The rate limit for this resource has been exceeded.

500An unexpected error occurred on the server.

`X-API-Key` or basic authentication credentials.