How do I check my key, limits and balance in one call?

GET /agent-config describes the API. It works without a key, and with one it also describes your key and account.

curl https://api.agent.clatterlabs.xyz/agent-config \
  -H "Authorization: Bearer $CLATTER_API_KEY" \
  -H "X-Clatter-Account: $CLATTER_ACCOUNT_ID"

What you get back#

• version: the API version date.
• agent: the agent's name, model, tiers (auto, flash, max, heavy; default auto) and limits: max_steps_per_run 150, max_input_chars 20000, max_metadata_bytes 2048, max_runs_in_progress 5.
• endpoints: every endpoint and the permission it needs.
• key (with a key): id, name, scopes and rate_limit_rpm.
• account (with a key): cloud_id, balance_usd, unlimited and can_run.

Good uses#

• A start-up health check for your integration.
• Confirming a new key has the permissions you expect before using it.

Without a key, the response is cacheable for 5 minutes.

Learn more#

• Cosmos Agent overview
• Quickstart