Skip to main content
POST
/
v1
/
renders
Create a render directly from a video json
curl --request POST \
  --url https://api.videoaiditor.com/v1/renders \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "metadata": {
    "name": "<string>",
    "backgroundColor": "#000000",
    "duration": 123,
    "fps": 30,
    "canvas": {
      "width": 1920,
      "height": 1080
    }
  },
  "clips": [
    {
      "source": "<string>",
      "timeFrame": {
        "start": 0,
        "end": 123,
        "offset": 123
      },
      "position": {
        "x": 0,
        "y": 0,
        "z": 0
      },
      "transform": {
        "scale": {
          "x": 1,
          "y": 1
        },
        "rotation": 123
      },
      "size": {
        "width": 100,
        "height": 100
      },
      "name": "<string>",
      "volume": 1
    }
  ],
  "autoGenerateCaptionWords": false,
  "captionLanguageCode": "en-US",
  "renderOptionsInUI": [],
  "additional": {}
}
'
{
  "data": {
    "_id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "outputUrl": "<string>",
    "videoId": "<string>",
    "error": "<string>",
    "videoData": {
      "_id": "<string>",
      "version": "<string>",
      "metadata": {
        "name": "<string>",
        "backgroundColor": "#000000",
        "duration": 123,
        "fps": 30,
        "canvas": {
          "width": 1920,
          "height": 1080
        },
        "redirectUrl": "<string>"
      },
      "clips": [
        {
          "source": "<string>",
          "timeFrame": {
            "start": 0,
            "end": 123,
            "offset": 123
          },
          "position": {
            "x": 0,
            "y": 0,
            "z": 0
          },
          "transform": {
            "scale": {
              "x": 1,
              "y": 1
            },
            "rotation": 123
          },
          "size": {
            "width": 100,
            "height": 100
          },
          "id": "<string>",
          "name": "<string>",
          "volume": 1,
          "textProperties": {
            "content": "<string>",
            "fontSize": 16,
            "fontWeight": 400,
            "fontFamily": "Arial",
            "color": "#000000",
            "backgroundColor": "transparent",
            "textAlign": "left",
            "fontStyle": "normal",
            "padding": 0,
            "strokeWidth": 0,
            "strokeColor": "#000000",
            "borderWidth": 0,
            "borderColor": "#FFFFFF",
            "underline": false
          },
          "captionProperties": {
            "words": [
              {
                "start": 123,
                "end": 123,
                "word": "<string>"
              }
            ],
            "highlightTextProperties": {
              "fontSize": 24,
              "color": "#000000",
              "fontFamily": "Montserrat",
              "fontWeight": 400,
              "fontStyle": "normal",
              "underline": false,
              "padding": 0,
              "strokeWidth": 0,
              "strokeColor": "#000000",
              "borderWidth": 0,
              "borderColor": "#FFFFFF",
              "backgroundColor": "<string>"
            },
            "nonHighlightTextProperties": {
              "fontSize": 24,
              "color": "#000000",
              "fontFamily": "Montserrat",
              "fontWeight": 400,
              "fontStyle": "normal",
              "underline": false,
              "padding": 0,
              "strokeWidth": 0,
              "strokeColor": "#000000",
              "borderWidth": 0,
              "borderColor": "#FFFFFF",
              "backgroundColor": "<string>"
            },
            "textAlign": "center",
            "maxWidth": 500,
            "maxWordsInFrame": 5
          }
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "additional": {}
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Enter your API key here

Body

application/json

Video data to render

​
metadata
object
required

Video project metadata

​
clips
object[]
required

Array of clips that make up the video

​
autoGenerateCaptionWords
boolean
default:false
required

Enable auto caption generation

​
captionLanguageCode
enum<string>
default:en-US
required

Caption language code

Available options:
en,
en-US
​
renderOptionsInUI
enum<string>
default:[]

Render options to display in UI. Leave empty to restrict renderer access

Available options:
json,
client,
server
​
additional
object

Additional custom properties

Response

The render has been successfully created.

​
data
object
required

Render data