Loading...

API endpoint update

New integrations should use . Existing URLs remain supported.

Usage

Free account endpoint
GET /v1/usage

Check your remaining free monthly quota, metered usage and projected charge, billing status, request activity, and the active rate-limit bucket for your API key.

Try in Playground

Examples

Node.js / Express
const response = await fetch('https://api.animaldetect.com/v1/usage', {
  headers: {
    Authorization: 'Bearer ' + process.env.ANIMAL_DETECT_API_KEY,
  },
})

const data = await response.json()
Example Response
{
  "free_quota": {
    "limit_per_month": 250,
    "used": 112,
    "remaining": 138
  },
  "metered": {
    "images_this_month": 8400,
    "price_per_1000_images_cents": 150,
    "projected_charge_cents": 1260
  },
  "billing": {
    "card_on_file": true,
    "keys_paused": false,
    "keys_pause_reason": null
  },
  "requests": {
    "today": 84,
    "this_month": 1240
  },
  "rate_limit": {
    "limit": 120,
    "remaining": 96,
    "reset_at": "2026-02-10T11:04:00.000Z"
  },
  "user_id": "2b01e3ce-a8be-4ea8-9cd8-0c47859c6c87",
  "org_id": "6f5b7a1e-3d2c-4b8a-9e0f-1a2b3c4d5e6f"
}

Status Codes

200Usage payload returned.
401Invalid, missing, or revoked API key.
429Rate limit exceeded.

Notes

  • `rate_limit.limit` is the active per-minute bucket for this key.
  • Free quota and the meter are per organisation and reset monthly; metered usage is billed at month end.