BRbraiv
Downloads

Prepare a download

Queues preparation of a language video, source asset, or bundle. Account policy determines full, sample, or unavailable download tier. Required scope: downloads:write.

post/videos/{videoId}/downloads

Request

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

Path parameters

videoIdstring required

Braiv library video document ID.

Headers

Idempotency-Keystring

Caller-generated key for safe POST retries. The API retains the first JSON response for 24 hours. Reusing a key with another path or body returns 409 IDEMPOTENCY_REPLAY.

Request body

artifact'language_video' | 'source' | 'bundle' required

Download to prepare: language_video renders a video in the requested language; source returns the original source media; and bundle packages the video's available deliverables together.

languagestring

ISO-style language or locale code accepted by the underlying product.

Example request

{
  "language": "en"
}

Response

Download preparation queued.

downloadRequestIdstring required

Created download request ID.

jobIdstring required

Pollable download job ID.

artifact'language_video' | 'source' | 'bundle' required

Requested download package.

languagestring required

ISO-style language or locale code accepted by the underlying product.

tier'full' | 'sample' required

Download entitlement selected for this request.

status'queued' | 'processing' | 'ready' | 'failed' required

Normalized lifecycle shared by jobs and video projections: queued is waiting to start, processing is running, ready completed successfully, and failed reached a terminal error.

Example response

{
  "language": "en"
}

Changes

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