COcoram
downloads

Get a video export's status and links

Changed on

Returns the download's status, progress and files. Every call signs fresh links that are valid for 1 hour, so poll again for new links instead of storing them. A link is a bearer URL: anyone who has it can download the file until it expires, without an API key. Depending on where the file is stored, the link points either at this API or directly at Backblaze B2.

Files are kept for 7 days after export. After that the status changes to expired and the download has no files. Requires the read:* scope and the REGULAR role. Only the API key's creator can see the download, unless the creator is an admin.

get/v1/downloads/{download_id}

Request

  • Base URL
    https://developer.coram.ai
  • URL
    https://developer.coram.ai/v1/downloads/{download_id}
  • Auth
    API key in header X-Auth-Token

Path parameters

download_idinteger required

The id returned by POST /v1/downloads.

Response

The download

download_idinteger required
namestring nullable required
status'processing' | 'ready' | 'failed' | 'cancelled' | 'expired' required
failure_reasonstring

Why the download failed. Set only when status is failed.

progress_percentageinteger required
created_atstring date-time required
finished_atstring date-time nullable required

When the download stopped processing. Null while it is processing.

Changes