Documentation/API reference

API reference

Usage

2 minPublic integration guide·

Monitor your credit balance, daily free allowance, wallet breakdown, and rate limits with GET /v1/usage.

Section 01

Check usage

Returns your current billing period, wallet balance, daily free allowance, active key count, and rate limit. No request body needed.

usage.sh

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

Section 02

Response

The response includes your plan tier, billing window, spendable wallet balance, credit breakdown, daily free allowance, and active API key count.

usage-response.json

json
{
  "tier": "free",
  "plan_code": "free",
  "period_start": "2026-03-01",
  "period_end": "2026-03-31",
  "credits_limit": 0,
  "credits_used": 18,
  "credits_remaining": 82,
  "wallet_balance": 82,
  "credit_breakdown": {
    "included_remaining": 0,
    "bonus_remaining": 82,
    "paid_remaining": 0
  },
  "expiring_credits": [],
  "billing_hold": false,
  "daily_free_remaining": 7,
  "daily_free_limit": 10,
  "rate_limit_per_sec": 1,
  "api_keys_active": 1
}

Section 03

Rate limits

Requests exceeding your rate limit return HTTP 429. The limit resets every second.

  • All users: 10 free searches per UTC day before wallet credits are consumed
  • Free: 1 request/second, 100 credits on signup
  • Pay as you go: $8/1K credits, standard rate limits
  • Pro: higher limits, 5,000 included credits/month, top up at $8/1K
  • Enterprise: custom limits