Documentation Index
Fetch the complete documentation index at: https://docs.heysage.me/llms.txt
Use this file to discover all available pages before exploring further.
GET /status
Returns the vault’s screening mode, Telegram connection, and learned behavioral patterns.| Query param | Required | Description |
|---|---|---|
vault | Yes | Vault address |
screeningMode, lastCheck, telegramChatId, botConnected, patterns.
PATCH /status
Update screening mode, Telegram config, and policy limits — any combination of fields. Requiresvault.
| Field | Type | Description |
|---|---|---|
vault | string | Required. Vault address |
screeningMode | boolean | Toggle screening on/off |
telegramChatId | string | Linked Telegram chat |
botConnected | boolean | Bot connection flag |
maxSingleTx | string | Single-transfer cap |
maxHourlyVolume | string | Hourly volume cap |
maxDailyVolume | string | Daily volume cap |
maxWeeklyVolume | string | Weekly volume cap |
maxDailyTxCount | number | Daily transaction count cap |
allowedHoursUTC | number[] | Allowed hours (0–23, UTC) |
allowedDaysUTC | number[] | Allowed days (0–6, UTC) |
unknownRecipientAction | string | approve, review, or block |
riskThresholdApprove | number | APPROVE below this (0–100) |
riskThresholdBlock | number | BLOCK at or above this (0–100) |
learningEnabled | boolean | Whether patterns update after execution |
screeningMode, telegramChatId, botConnected, and the full limits object.
