API Usage Endpoint Reference

Account-level monitoring - track credit consumption, monthly allocation, and per-API usage breakdowns.

The Account APIs report on your own API account rather than on people or companies. They are synchronous reads - no queue, no request_id - and they never consume credits.

The Usage endpoint returns the current month's credit and request statistics in a single synchronous call.

1. Submit - GET /usage

curl https://api.nyne.ai/usage \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

The call returns 202 Accepted immediately:

{
  "request_id": "a1b2c3d4e5f6_1717000000_4271",
  "status": "queued"
}

2. Poll until completed

curl "https://api.nyne.ai/usage?request_id=<request_id>" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

When status is completed, the same response carries the result:

{
  "month": 12,
  "year": 2024,
  "period": "2024-12",
  "credits_used": {
    "total": 68,
    "search": 45,
    "enrichment": 23
  },
  "requests_count": {
    "total": 25,
    "search": 15,
    "enrichment": 10
  },
  "limits": {
    "monthly_allocation": 10000,
    "available_credits": 9932,
    "is_unlimited": false
  },
  "breakdown": {
    "search_results_returned": 45,
    "enrichments_performed": 23,
    "total_credits_consumed": 68
  }
}

Every endpoint here authenticates with an API key + secret sent as HTTP headers (X-API-Key · X-API-Secret) - create them from your dashboard and see the Authentication guide for rate limits and IP locking. Each endpoint page lists its exact credit costs.