Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Complete Vaultak SDK and REST API documentation, v0.5.0
pip install vaultak
from vaultak import Vaultak, ActionType, KillSwitchMode vt = Vaultak( api_key="vtk_your_api_key_here", allowed_action_types=[ActionType.FILE_READ, ActionType.API_CALL], allowed_resources=["/tmp/*", "/data/readonly/*"], blocked_resources=["prod.*", "*.env"], max_actions_per_minute=20, max_risk_score=0.7, mode=KillSwitchMode.PAUSE )
KillSwitchMode.ALERT # Log and notify only (default) KillSwitchMode.PAUSE # Halt agent, await approval KillSwitchMode.ROLLBACK # Reverse last N actions and pause
with vt.monitor("my-agent"): pass
vt.log_action( agent_id="my-agent", action_type="file_delete", resource="/data/sensitive.csv", payload={"reason": "cleanup"} )
x-api-key: vtk_your_api_key_here
curl -X POST https://vaultak.com/api/check -H "x-api-key: vtk_your_api_key_here" -H "Content-Type: application/json" -d '{"agent_id": "my-agent", "action_type": "file_delete", "resource": "/data/sensitive.csv"}'
{ "decision": "block", "reason": "Resource '/data/sensitive.csv' is blocked for this agent", "risk_score": 0.91, "risk_breakdown": {...} }
curl -X PATCH https://vaultak.com/api/agents/my-agent/profile -H "x-api-key: vtk_your_api_key_here" -H "Content-Type: application/json" -d '{ "allowed_action_types": ["file_read", "api_call"], "allowed_resources": ["/tmp/*"], "blocked_resources": ["prod.*", "*.env"], "max_actions_per_minute": 20, "max_risk_score": 0.7 }'
curl -X POST https://vaultak.com/api/actions -H "x-api-key: vtk_your_api_key_here" -H "Content-Type: application/json" -d '{"agent_id": "my-agent", "action_type": "file_write", "resource": "/tmp/output.txt"}'
curl https://vaultak.com/api/agents -H "x-api-key: vtk_your_api_key_here"
curl https://vaultak.com/api/alerts -H "x-api-key: vtk_your_api_key_here"
curl -X POST https://vaultak.com/api/policies -H "x-api-key: vtk_your_api_key_here" -H "Content-Type: application/json" -d '{ "name": "no-prod-deletes", "action_type": "file_delete", "resource_pattern": "prod.*", "effect": "block", "max_risk_score": 0.5, "priority": 10 }'