Skip to main content
GET
Check Usage

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

string
required
Your Aether Citadel API key (ack_live_...)

Response

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

Example


Error Responses