API REFERENCE · PLATFORM
Usage
One read for the balance and the cycle; credits are the unit, the rates live in your contract.
01.Read your usage
GET
/v1/usagecurl https://api.thefamiliarlab.com/v1/usage \
-H "Authorization: Bearer $FAMILIAR_API_KEY"
{
"cycle_start": "2026-08-01T00:00:00Z",
"cycle_end": "2026-09-01T00:00:00Z",
"included_credits": 1000000,
"used_credits": 412500,
"overage_credits": 0
}| FIELD | TYPE | DESCRIPTION |
|---|---|---|
cycle_start | string | The UTC calendar month the meter is counting. |
cycle_end | string | When included credits reset. |
included_credits | integer | Your contract's monthly allotment. |
used_credits | integer | Spent this cycle, across dubs and live. |
overage_credits | integer | Credits past the allotment; billed on your monthly invoice. |
02.How credits meter
Dubs meter per finished minute per language at render (a review=manual dub at in_review has spent nothing; Transcript & review); live sessions (experimental) meter per language while live; subtitles are not metered. Studio jobs never block on balance: past the allotment, overage rides the monthly invoice, and nothing charges a card automatically.
03.Access
The API is enterprise-only: private access under a Studio contract, with volume pricing, raised limits, ProRes masters on request, and a named point of contact. Book a call and your key is issued with the contract.