BRbraiv
Credits

Reserve credits for a bundle

Atomically debits the full quoted bundle into escrow. Pass reservation and line-item IDs to supported product creation calls. Required scope: videos:write.

post/videos/{videoId}/reservations

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

durationSecondsnumber

Settled billing duration; otherwise resolved from the source video.

captionLanguageCodesLanguageCode[]

Caption translation languages to price.

transcriptOnlyboolean

Reserve source transcription as a standalone action.

Example request

{
  "dubs": [
    {
      "languages": [
        "en"
      ]
    }
  ],
  "captionLanguageCodes": [
    "en"
  ],
  "zeroPromptThumbnail": {
    "translateLanguageCodes": [
      "en"
    ]
  }
}

Response

Credits reserved and line items created.

reservationIdstring required

Escrow identifier supplied to product requests.

totalnumber required

Total credits moved into escrow.

durationSecondsnumber required

Settled duration used to reserve credits.

Example response

{
  "lineItems": [
    {
      "targetLanguageCode": "en"
    }
  ]
}

Changes

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