Skip to main content
POST
Start a video upload
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
required

API key. Refer to Authentication for more information.

Accept
enum<string>
default:application/json
required

Must be application/json.

Available options:
application/json

Body

application/json
file_size
integer
required

Size of the MP4 file in bytes. It must be between 1 and 2,147,483,648 bytes (2 GB).

Required range: 1 <= x <= 2147483648
Example:

52428800

title
string

Title of the recording. A default title is used when omitted.

Example:

"Quarterly product demo"

folder_id
string

Folder to put the recording in. Accepts the folder id from the folders API.

owner_email
string

Email of the active workspace member who owns the recording. Required with a workspace API key. With a signed-in CLI session it defaults to the signed-in member, and naming another member needs the permission to manage every recording.

Example:

"oliver@example.com"

Response

The recording was reserved. Send the file to upload_url next.

recording
object
required
upload_url
string
required

Presigned URL to PUT the file to. Valid for 15 minutes.

upload_headers
object
required

Headers the PUT request must send unchanged.