Create a render job from a template

post/v1/videos/templates/{identifier}/render

Create a render job from a template

Request

Parameters

Name	In	Type	Description
identifier*	path	string	No description

Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "callback_url": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri"
          },
          "callback_secret": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 255
          },
          "team_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "settings": {
            "type": "object",
            "properties": {
              "resolution": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  "4k",
                  "1080p",
                  "720p",
                  "480p"
                ]
              },
              "fps": {
                "type": [
                  "number",
                  "null"
                ],
                "minimum": 1,
                "maximum": 120
              }
            }
          },
          "assets": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "video",
                    "image",
                    "audio"
                  ]
                },
                "url": {
                  "type": "string",
                  "format": "uri"
                }
              },
              "required": [
                "type",
                "url"
              ]
            }
          },
          "merge": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "properties": {
                "find": {
                  "type": "string",
                  "maxLength": 255
                },
                "replace": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Responses

202No description

Schema

Schema Structure

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "template_id": {
          "type": "integer"
        },
        "status": {
          "type": [
            "string",
            "null"
          ]
        },
        "job_type": {
          "type": "string"
        },
        "credits_used": {
          "type": "string"
        },
        "position_in_queue": {
          "type": "integer"
        },
        "estimated_time_seconds": {
          "type": "integer"
        }
      },
      "required": [
        "id",
        "template_id",
        "status",
        "job_type",
        "credits_used",
        "position_in_queue",
        "estimated_time_seconds"
      ]
    }
  },
  "required": [
    "success",
    "data"
  ]
}

402No description

Schema

Schema Structure

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "INSUFFICIENT_CREDITS"
          ]
        },
        "message": {
          "type": "string",
          "enum": [
            "Not enough credits to render this template."
          ]
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  },
  "required": [
    "success",
    "error"
  ]
}

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