Credits

Quote a product bundle

Calculates the exact credits required without debiting the account. Duration is resolved from the video unless supplied. Required scope: videos:read.

post/videos/{videoId}/quote

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

Current pricing, balance, shortfall, and per-action breakdown.

totalnumber required

Total credits required by all line items.

durationSecondsnumber required

Settled duration used for pricing.

pricingVersionstring required

Pricing ruleset identifier.

balancenumber required

Current account credit balance.

usageBillingActiveboolean required

If true, wallet shortfall does not block the operation.

shortfallnumber required

Additional wallet credits required; zero with usage billing.

sufficientboolean required

Whether billing can cover the quoted total.

Example response

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

Changes

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