Skip to main content
GET
Get a download URL
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

Path Parameters

id
string
required

The recording's id (UUID) or its public_link_id (the short code in the watch URL). Both are accepted.

Query Parameters

file_format
enum<string>
default:mp4

Download format: mp4 or webm. Defaults to mp4.

Available options:
mp4,
webm

Response

Download URL generated, or the MP4 is not ready yet.

recording_id
string

Public link identifier of the recording.

file_format
enum<string>

Format the URL points at.

Available options:
mp4,
webm
is_download_file_ready
boolean

false when the MP4 is out of date. Call POST /recordings/{id}/trigger-mp4 to regenerate it, then retry.

download_url
string

Presigned download URL. Omitted entirely when is_download_file_ready is false.

url_expires_in_seconds
integer

Lifetime of the presigned URL, 600 seconds for mp4 and 60 for webm. Omitted entirely when is_download_file_ready is false.