BRbraiv
Downloads

Get a prepared download

Returns a URL when ready. Failed download preparation is a terminal 200 response with status: failed and an error object. Required scope: downloads:write.

get/downloads/{downloadRequestId}

Request

  • Base URL
    https://api.braiv.co/v1
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

downloadRequestIdstring required

Download request document ID returned by createDownload.

Response

Download is ready or terminally failed.

idstring required

Download request ID.

statusstring required

Normalized to ready or failed at terminal state; otherwise stored queue status.

tier'full' | 'sample'

Download entitlement applied.

truncatedboolean required

True for sample-tier artifacts.

maxDurationSecondsnumber nullable required

Sample duration cap or null for full downloads.

urlstring uri nullable required

Prepared artifact URL when ready.

errorobject nullable required

Terminal worker failure details.

jobIdstring required

Pollable download job ID.

Changes

No recorded changes to this operation across all 1 revision of this API.