Usage

Get usage

Words and requests by day, endpoint and API key, plus what is left of this month's allowance and any pay-as-you-go use.

GET

curl https://api.intactvoice.com/v1/usage?start=2026-10-01&end=2026-10-05&group_by=day \
  -H "Authorization: Bearer $API_KEY"

Response

{
  "object": "list",
  "data": [
    {
      "bucket": "2026-10-01",
      "requests": 1840,
      "words": 412650,
      "allowance_words": 286310
    }
  ],
  "balance": {
    "plan_words_remaining": 313690,
    "overage_words": 0,
    "overage_usd": 0
  }
}

200 OK · 400 Bad Request

Query parameters

startdaterequired

Inclusive, YYYY-MM-DD (UTC).

enddaterequired

Exclusive, YYYY-MM-DD (UTC).

group_byenumdefault: day

Bucket for the series.

Available options:dayendpointkey

key_idstring

Filter to one API key.

Response

200 · application/json

dataarray

Buckets with requests, words processed and allowance used.

balanceobject

Words left this month and pay-as-you-go use.

Errors

400invalid_request
401invalid_api_key
429rate_limited