API reference
Markdown ↗

Credits

Use the paid-key usage endpoints to inspect account totals and the requests made with your key.

Read your balance

bash
curl -sS https://api.zrelay.net/v1/usage \
  -H "x-api-key: $ZRELAY_API_KEY"

The response includes name, quota_usd, balance_usd, spent_usd and remaining_usd. In Wallet mode, prepaid balance reflects confirmed charges and never goes below zero. An in-progress request can finish using the remaining balance; excess is covered by Zrelay.

Account totals

spent_last_24h_usd and requests_last_24h cover a rolling 24-hour window. by_model reports requests, token usage and cost; by_day reports daily spend. These are account totals, not the individual key’s spending cap.

Request history

bash
curl -sS https://api.zrelay.net/v1/requests \
  -H "x-api-key: $ZRELAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":25}'

The response contains data and, if more results exist, next_cursor. Pass that value as cursor in the next POST. The maximum page size is 100.

Interpret billing status

Keep the x-zrelay-request-id response header. cost_udollars is a confirmed charge in millionths of a USD when billing is settled. A null charge is not a confirmed zero. Entries with shared and canonical_request_id identify the entry carrying a shared charge.

Account portal

The portal’s Usage section shows activity across your keys. The public usage checker remains available.

Questions about your integration? support@zrelay.net