downloads

List video exports

Changed on

Lists downloads, newest first, without files. Get a download by its id for its links. Use page and limit to paginate; has_more on the response signals more pages remain. Requires the read:* scope and the REGULAR role. Only downloads that the API key's creator made are listed, unless the creator is an admin.

Webhook deliveries can be lost, and a delivered webhook does not mean the earlier ones arrived. To catch up on missed download_finished events, sweep this endpoint on a schedule: set finished_after a few minutes before the time your previous sweep started, read every page, and skip download ids you have already handled. Do not use the finished_at of the latest webhook you received as the cutoff, because a download that finished earlier and whose webhook was lost would fall before it.

get/v1/downloads

Request

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

Query parameters

statusDownloadStatus[]

Repeat to match any of several statuses.

created_afterstring date-time

Only downloads created strictly after this RFC3339 time.

finished_afterstring date-time

Only downloads that finished strictly after this RFC3339 time. A download that is still processing has not finished.

pageinteger

1-indexed page number.

limitinteger

Maximum downloads per page (capped at 100).

Response

One page of downloads

has_moreboolean required

True if a further page beyond page exists.

Changes