Usage reporting

Open Dashboard → API Keys → New key, select the live environment, and grant only the read:usage scope. The usage endpoint is available on Starter and higher plans; sandbox keys are intentionally rejected.

Call the endpoint no more than once every six hours. Each successful request consumes 0.1 weighted API units. The response includes base, active add-on, effective, reserved, used, remaining, percentage, and period-end forecast values for all four meters.

curl -H "Authorization: Bearer $CLEARIE_KEY" \
     https://getway.clearie.ai/v1/usage

Store keys only in a server-side secret manager. Alert from the returned effective limit and percentage fields so purchased add-ons are included. Treat 401 and 403 as configuration errors, 429 as a signal to back off, and retry transient 5xx responses with bounded exponential backoff.

Weighted API units measure successful API and Copilot traffic. AI credits measure completed model or extraction work. Monitoring credits measure completed customer-funded scout runs. Cloud document pages measure pages processed by the managed document parser. These meters are independent and appear separately in Usage & Quotas.

Getway reserves capacity before expensive work begins, then reconciles it to completed work. Failed API responses and unused reservations are released. If managed document parsing completes before a Copilot request is refused or its reasoning provider fails, only the completed parser AI credits and cloud pages remain; unused Copilot API units and model credits are released.

Product records, trade profiles, saved decisions, compliance cases, portal search, and ordinary workspace navigation do not consume these meters.