Skip to main content
GET
/
v1
/
tenant
/
usage
Check Usage
curl --request GET \
  --url https://api.aethercitadel.cloud/v1/tenant/usage \
  --header 'X-Citadel-Key: <x-citadel-key>'
{
  "email": "<string>",
  "plan": "<string>",
  "usage_count": 123,
  "rate_limit": 123,
  "remaining": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.aethercitadel.cloud/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Returns real-time usage stats for your API key — how many intent verifications you’ve consumed this month, your plan limit, and how many remain. No request body needed — authentication is via your X-Citadel-Key.

​
Request

​
X-Citadel-Key
string
required
Your Aether Citadel API key (ack_live_...)

​
Response

​
email
string
The email address associated with your account.
​
plan
string
Your current plan name (e.g. Citadel Starter, Citadel Pro).
​
usage_count
integer
Total intent verifications consumed this billing period.
​
rate_limit
integer
Maximum verifications allowed per billing period.
​
remaining
integer
rate_limit - usage_count. How many verifications you have left.

​
Example

curl https://api.aethercitadel.cloud/v1/tenant/usage \
  -H "X-Citadel-Key: ack_live_YOUR_KEY"

{
  "email": "you@company.com",
  "plan": "Citadel Starter",
  "usage_count": 12456,
  "rate_limit": 50000,
  "remaining": 37544
}

​
Error Responses

StatusErrorMeaning
401Missing X-Citadel-Key headerNo key provided
401Invalid or inactive API keyKey doesn’t exist or was deactivated
503Multi-tenancy not configuredContact support