video.upload

post/v1/videos/uploads

video.upload

Request

Body

{
  "required": true,
  "content": {
    "multipart/form-data": {
      "schema": {
        "type": "object",
        "properties": {
          "video": {
            "type": "string",
            "format": "binary",
            "contentMediaType": "application/octet-stream",
            "maxLength": 2097152
          },
          "callback_url": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri"
          },
          "callback_secret": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 255
          },
          "metadata": {
            "type": "object",
            "properties": {
              "codec": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  "h264",
                  "hevc",
                  "prores",
                  "vp9",
                  "av1"
                ]
              },
              "generate_proxy": {
                "type": [
                  "boolean",
                  "null"
                ]
              },
              "notes": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 500
              },
              "project_tag": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 120
              }
            }
          }
        },
        "required": [
          "video"
        ]
      }
    }
  }
}

Responses

201No description

Schema

Schema Structure

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "status": {
          "type": [
            "string",
            "null"
          ]
        },
        "job_type": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "status",
        "job_type",
        "created_at"
      ]
    }
  },
  "required": [
    "success",
    "data"
  ]
}

422Validation error

Schema

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"
  ]
}