Skip to main content

video.process

post/v1/videos/render/{id}/process

video.process

Request​

Parameters

NameInTypeDescription
id*pathstringNo description

Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "codec": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "h264",
              "hevc",
              "prores",
              "vp9",
              "av1"
            ]
          },
          "bitrate_mode": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "target",
              "crf"
            ]
          },
          "target_bitrate": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1
          },
          "max_bitrate": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1
          },
          "two_pass": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "resolution": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "4320p",
              "2160p",
              "1440p",
              "1080p",
              "720p",
              "480p"
            ]
          },
          "fps": {
            "type": [
              "number",
              "null"
            ],
            "minimum": 1,
            "maximum": 120
          },
          "audio_codec": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "aac",
              "opus",
              "pcm_s16le",
              "copy"
            ]
          },
          "audio_bitrate": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 32,
            "maximum": 640
          },
          "profile": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "baseline",
              "main",
              "high"
            ]
          },
          "preset": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "ultrafast",
              "veryfast",
              "faster",
              "fast",
              "medium",
              "slow"
            ]
          },
          "tune": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "film",
              "animation",
              "fastdecode",
              "zerolatency"
            ]
          },
          "colour_space": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "bt709",
              "bt601",
              "bt2020"
            ]
          },
          "expiry_hours": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 1,
            "maximum": 168
          },
          "callback_url": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri"
          },
          "callback_secret": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 255
          }
        }
      }
    }
  }
}

Responses

200No description
Schema Structure
{
  "type": "object"
}
422Validation error
Schema Structure
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Errors overview."
    },
    "errors": {
      "type": "object",
      "description": "A detailed description of each field that failed validation.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "message",
    "errors"
  ]
}