rest api usage
the usage endpoint lets an integration check account limits before running expensive or repeated calls. agents should use it to avoid surprise failures.
quick answer
call usage before large batches, then explain any limit in normal product language.
use this for
- preflight checks for agents
- showing current quota in an integration
- debugging why a paid action stopped
steps
- send a key with `usage:read` scope.
- read the plan, usage, and limit fields.
- compare the planned work with available quota.
- run the work only when the account can handle it.
- send the user to billing if the plan blocks the intended workflow.
details to know
- usage data helps agents choose between doing work now, batching less, or asking the user to upgrade.
- usage is not a replacement for handling endpoint-level errors.
- the usage page in the app remains the human-readable source for plan explanations.
limits and edge cases
- do not keep calling usage in a tight loop.
- do not promise unlimited usage unless the plan docs say so.
ready to use the product instead of reading about it?
open app