API

GET /v1/usage

Read the used, limit, and remaining word counts for the current billing period.

A single GET that returns where your account stands this billing period. Call it before large jobs, or poll it from a dashboard to keep an eye on consumption.

Request

cURLbash
curl https://www.deepreference.com/api/v1/usage \
  -H "Authorization: Bearer dr_your_key_here"

Response

200 OKjson
{
  "words_used": 412350,
  "words_limit": 1000000,
  "words_remaining": 587650,
  "plan": "business"
}

Budgeting a batch job? words_remaining divided by your average document size tells you how many documents fit in the current period before you start.

Check before submitting a batch

Call the endpoint before a large batch and compare words_remaining with the expected output size. An internal dashboard can also display the same figures without requiring users to open DeepReference.