Skip to main content

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.
curl -s -H "Authorization: Bearer $AGENT_SECRET" \
  "https://api.trysage.xyz/status?vault=VAULT_ADDRESS"
Query paramRequiredDescription
vaultYesVault address
Returns: screeningMode, lastCheck, telegramChatId, botConnected, patterns.

PATCH /status

Update screening mode, Telegram config, and policy limits — any combination of fields. Requires vault.
{
  "vault": "VAULT_ADDRESS",
  "screeningMode": true,
  "maxSingleTx": "5000",
  "maxDailyVolume": "20000",
  "maxHourlyVolume": "10000",
  "maxWeeklyVolume": "50000",
  "maxDailyTxCount": 20,
  "riskThresholdApprove": 40,
  "riskThresholdBlock": 70,
  "unknownRecipientAction": "review",
  "learningEnabled": true
}
FieldTypeDescription
vaultstringRequired. Vault address
screeningModebooleanToggle screening on/off
telegramChatIdstringLinked Telegram chat
botConnectedbooleanBot connection flag
maxSingleTxstringSingle-transfer cap
maxHourlyVolumestringHourly volume cap
maxDailyVolumestringDaily volume cap
maxWeeklyVolumestringWeekly volume cap
maxDailyTxCountnumberDaily transaction count cap
allowedHoursUTCnumber[]Allowed hours (0–23, UTC)
allowedDaysUTCnumber[]Allowed days (0–6, UTC)
unknownRecipientActionstringapprove, review, or block
riskThresholdApprovenumberAPPROVE below this (0–100)
riskThresholdBlocknumberBLOCK at or above this (0–100)
learningEnabledbooleanWhether patterns update after execution
Returns the updated screeningMode, telegramChatId, botConnected, and the full limits object.