Get usage and balance

Returns answers delivered, credits remaining and your current limits.

GEThttps://api.synquery.com/v0/usage

Authentication: send your API key in the x-api-key header.

Use it to show usage in your own tools, or to stop submitting before you reach a limit. It returns at once.

Returns

answers_deliveredobject#

Answers delivered today and this month.

credits_remainingnumber#

Prepaid credits left in the workspace.

limitsobject#

Your current limits: most answers per request, per day and per month.

Limits can be set per workspace or per key. See Usage and billing.

Webhooks →

Requestbash

curl https://api.synquery.com/v0/usage \
  -H "x-api-key: YOUR_KEY"

Responsejson

{
  "answers_delivered": {"today": 12, "this_month": 184},
  "credits_remaining": 316,
  "limits": {"per_request": 5, "per_day": 50, "per_month": 600}
}