Check Usage
curl --request GET \
--url https://api.aethercitadel.cloud/v1/tenant/usage \
--header 'X-Citadel-Key: <x-citadel-key>'import requests
url = "https://api.aethercitadel.cloud/v1/tenant/usage"
headers = {"X-Citadel-Key": "<x-citadel-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Citadel-Key': '<x-citadel-key>'}};
fetch('https://api.aethercitadel.cloud/v1/tenant/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aethercitadel.cloud/v1/tenant/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Citadel-Key: <x-citadel-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.aethercitadel.cloud/v1/tenant/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Citadel-Key", "<x-citadel-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aethercitadel.cloud/v1/tenant/usage")
.header("X-Citadel-Key", "<x-citadel-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aethercitadel.cloud/v1/tenant/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Citadel-Key"] = '<x-citadel-key>'
response = http.request(request)
puts response.read_body{
"email": "<string>",
"plan": "<string>",
"usage_count": 123,
"rate_limit": 123,
"remaining": 123
}Tenant API
Check Usage
Returns your current usage count, plan limit, and remaining verifications
GET
/
v1
/
tenant
/
usage
Check Usage
curl --request GET \
--url https://api.aethercitadel.cloud/v1/tenant/usage \
--header 'X-Citadel-Key: <x-citadel-key>'import requests
url = "https://api.aethercitadel.cloud/v1/tenant/usage"
headers = {"X-Citadel-Key": "<x-citadel-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Citadel-Key': '<x-citadel-key>'}};
fetch('https://api.aethercitadel.cloud/v1/tenant/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aethercitadel.cloud/v1/tenant/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Citadel-Key: <x-citadel-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.aethercitadel.cloud/v1/tenant/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Citadel-Key", "<x-citadel-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aethercitadel.cloud/v1/tenant/usage")
.header("X-Citadel-Key", "<x-citadel-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aethercitadel.cloud/v1/tenant/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Citadel-Key"] = '<x-citadel-key>'
response = http.request(request)
puts response.read_body{
"email": "<string>",
"plan": "<string>",
"usage_count": 123,
"rate_limit": 123,
"remaining": 123
}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 yourX-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
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
| Status | Error | Meaning |
|---|---|---|
401 | Missing X-Citadel-Key header | No key provided |
401 | Invalid or inactive API key | Key doesn’t exist or was deactivated |
503 | Multi-tenancy not configured | Contact support |