CCerul

API Reference

Usage API Reference

Monitor your API consumption with the /v1/usage endpoint. Track credits, rate limits, and billing information.

4 min read3 sections← Back to docs

Guide

API Reference

Built to be operator-readable before you wire in automation.

Read time

4 min read

Quick enough for onboarding, specific enough for implementation.

Focus

Practical API use

Examples, request shape, and the minimum context needed to ship.

01

Check usage

The usage endpoint returns your current credit balance and consumption statistics. Use this to monitor your quota and prevent service interruption.

check_usage.shBASH
curl "https://api.cerul.ai/v1/usage" \
  -H "Authorization: Bearer YOUR_CERUL_API_KEY"

02

Response format

The usage response includes your current tier, billing period, and credit information.

usage_response.jsonJSON
{
  "tier": "free",           // free, builder, or enterprise
  "period_start": "2026-03-01",
  "period_end": "2026-03-31",
  "credits_limit": 1000,
  "credits_used": 128,
  "credits_remaining": 872,
  "rate_limit_per_sec": 1,
  "api_keys_active": 1
}

03

Rate limiting

API requests are rate-limited based on your tier. The rate_limit_per_sec field shows your current limit. Exceeding the limit returns HTTP 429.

  • Free tier: 1 request/second
  • Builder tier: 10 requests/second
  • Enterprise: Custom limits
  • Rate limit resets every second

Continue Reading

Explore more guides or try the API in the dashboard.

All GuidesOpen Dashboard