Skip to main content
POST
/
v1
/
videos
Create a new video
curl --request POST \
  --url https://api.videoaiditor.com/v1/videos \
  --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": [
    {
      "type": "video",
      "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
    }
  ],
  "renderOptionsInUI": [],
  "additional": {}
}
'
{
  "data": {
    "_id": "<string>",
    "version": "<string>",
    "metadata": {
      "name": "<string>",
      "backgroundColor": "#000000",
      "duration": 123,
      "fps": 30,
      "canvas": {
        "width": 1920,
        "height": 1080
      },
      "redirectUrl": "<string>"
    },
    "clips": [
      {
        "type": "video",
        "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
      }
    ],
    "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
metadata
object
required

Video project metadata

clips
object[]
required

Array of clips that make up the video

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 video has been successfully created.

data
object
required

Video data