Skip to main content
POST
/
v1
/
intent
/
generate
Generate Intent
curl --request POST \
  --url https://api.aethercitadel.cloud/v1/intent/generate \
  --header 'Content-Type: application/json' \
  --header 'X-Citadel-Key: <x-citadel-key>' \
  --data '
{
  "user_token": "<string>",
  "ttl": 123
}
'
{
  "intent_hash": "<string>",
  "intent_class": "<string>",
  "expires_at": 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

Generates a User Intent Signature (UIS) — a SHA-256 hash that represents what a user intends to do, without including any PII. Call this before sending a user’s request to your AI service. Attach the returned intent_hash to the AI request via the X-Intent-Hash header.

​
Request

​
X-Citadel-Key
string
required
Your Aether Citadel API key (ack_live_...)
​
user_token
string
required
The user’s JWT from your authentication system. Used to fetch semantic context from AetherDB. The token itself is never stored by Citadel.
​
ttl
integer
default:"3600"
Time-to-live in seconds for this intent signature. After expiry, verify will return ExpiredIntent. Default: 3600 (1 hour). Max recommended: 86400 (24h).

​
Response

​
intent_hash
string
The zero-knowledge intent signature. Format: sha256:<64 hex chars>. Attach this to your AI request as X-Intent-Hash.
​
intent_class
string
Semantic classification of user intent. One of: commerce, infrastructure, wellness, finance, education, social, other.
​
expires_at
integer
Unix timestamp when this intent expires. After this time, verification will fail with ExpiredIntent.

​
Example

curl -X POST https://api.aethercitadel.cloud/v1/intent/generate \
  -H "X-Citadel-Key: ack_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "user_token": "eyJhbGciOiJIUzI1NiJ9...",
    "ttl": 3600
  }'
200 Response: 
{
  "intent_hash": "sha256:a3f8c2d1e5b9047263a1c4d7e8f2b3a9c6d5e4f1a2b3c4d5e6f7a8b9c0d1e2f3",
  "intent_class": "commerce",
  "expires_at": 1718003600
}

​
Error Responses

StatusErrorMeaning
400token too shortuser_token is less than 10 characters
400token contains invalid charactersNon-alphanumeric/JWT chars in token
401invalid or missing X-Citadel-KeyBad or missing API key
502AetherDB request failedCould not fetch semantic context

​
Notes

  • The user_token is sent to AetherDB (within your infrastructure) to extract semantic tags. It is never stored by Citadel.
  • Each call generates a new, unique intent hash — even for the same user.
  • Intent hashes are single-use — do not reuse them across different AI requests.