Skip to main content
POST
Request a download

Authorizations

X-Api-Key
string
header
required

Include your API key in the X-Api-Key header of every request.

Path Parameters

recording_id
integer
required

The ID of the meeting recording to generate a download for.

Example:

123456789

Body

application/json
destination_url
string<uri>

URL Fathom POSTs the completed download payload to when it is ready. If omitted, poll the status endpoint.

Example:

"https://example.com/destination"

Response

The download request was accepted. Poll the download status endpoint until it completes.

download_id
string
required
Example:

"dl_CJAj1YPuruCgWHaKgEBv6Mb1UsNj8x"

recording_id
integer
required
Example:

123456789

status
enum<string>
required
Available options:
processing,
completed,
failed,
expired
Example:

"processing"

video
object

Present when a video recording's download is completed.

audio
object

Present when an audio-only recording's download is completed.

failure_reason
enum<string>

Present when the download failed.

Available options:
generation_failed,
generation_timeout