Check Extract API Usage
averra_check_usageCheck current month's Extract API usage and remaining quota for authenticated accounts to monitor limits and plan requests effectively.
Instructions
Check the current month's Extract API usage and remaining quota for the authenticated account.
Usage is counted per user across all API keys (not per key). Cached requests also count against the quota. The counter resets at the start of each calendar month (UTC).
Args:
response_format ('markdown' | 'json', optional): Output format. Default 'markdown'.
Returns: For JSON format: { "plan": "free" | "starter" | "pro" | "scale", "monthly_limit": number, // Max requests allowed this month "used": number, // Requests made so far this month "remaining": number // max(0, monthly_limit - used) }
For Markdown format: a summary showing plan, limit, used, and remaining.
Examples:
Use when: "How many extracts do I have left this month?"
Use when: Before a batch of extracts, to confirm sufficient quota.
Use when: User asks "Am I on the free plan?" — the plan field answers this.
Error Handling:
401: Invalid API key — check AVERRA_EXTRACT_API_KEY
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| response_format | No | Output format: 'markdown' for human-readable output (default), 'json' for machine-readable structured data | markdown |