Skip to main content
POST
Upload or import a video or audio file for the canvas timeline. Videos are processed in the background.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

canvasId
string
required

Body

application/json

A file URL to import (or send the file as multipart file)

Request body for importing a video or audio clip from a URL

companyId
string
required

Company ID

url
string
required

Public or signed http(s) URL of the video or audio file

name
string

File name with extension (e.g. reel.mp4); sets the file type when the URL has none

Response

Audio: the stored clip (200). Video: a processing item (202) to poll

An uploaded video or audio clip

kind
string

video or audio

id
string

Video or audio id

url
string

Permanent public URL to use as the clip src

name
string

File name

duration
number

Length in seconds

status
string

processing, ready or failed

public
boolean

False for a private video; placing it makes a public copy

fileSize
integer

Size in bytes, when known

error
string

Why processing failed