Read session state
none, expired, revoked, budget_exhausted, missing_budget_state, and invalid_key.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Budget state for first-party Compose clients and session-purpose keys.
budgetLimit - budgetUsed - budgetReserved
GET /api/session
x-session-user-address: 0x...
x-network-id: 43113
{
"hasSession": true,
"keyId": "f65a...",
"budgetLimit": "1000000",
"budgetUsed": "12000",
"budgetLocked": "0",
"budgetRemaining": "988000",
"expiresAt": 1790000000000,
"chainId": 43113,
"status": {
"isActive": true,
"isExpired": false,
"expiresInSeconds": 3600,
"budgetPercentRemaining": 98.8
}
}
{
"hasSession": false,
"reason": "expired"
}
none, expired, revoked, budget_exhausted, missing_budget_state, and invalid_key.
GET /api/session/events?userAddress=0x...&chainId=43113
event: session-expired
data: {"reason":"expired","userAddress":"0x...","chainId":43113}
| Header | Meaning |
|---|---|
x-payment-method | session for active session requests. |
x-session-budget-limit | Total budget. |
x-session-budget-used | Settled usage. |
x-session-budget-locked | Reserved amount. |
x-session-budget-remaining | Spendable amount left. |
x-session-status | Warning such as budget-low, budget-depleted, or expiring-soon. |
x-session-invalid | Why a session key no longer works. |