get_usage
Read-onlyIdempotent
Check your current API usage quota and rate limits across phone, URL, text, email, and document verification channels to monitor consumption against billing period allocations.
Instructions
Check your current API usage quota and rate limits for the billing period. Shows per-channel usage (phone, URL, text, email, document) with limits and remaining counts. QR lookups consume URL quota.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:356-376 (handler)The tool 'get_usage' is registered directly in src/index.ts using the 'server.tool' method. It uses the 'apiGet' helper to fetch data from the '/api/v1/usage' endpoint and returns it via 'jsonResult'.
// 9. get_usage server.tool( 'get_usage', 'Check your current API usage quota and rate limits for the billing period. Shows per-channel usage (phone, URL, text, email, document) with limits and remaining counts. QR lookups consume URL quota.', {}, { title: 'Get Usage & Quota', readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false, }, async () => { try { const data = await apiGet('/api/v1/usage'); return jsonResult(data); } catch (err) { return errorResult(err instanceof Error ? err.message : 'Failed to get usage'); } }, );