Agent API Reference

Everything your AI agent needs to connect, check rules, fetch personality, and operate within boundaries.

Quick Start

1. Get an API key from the dashboard

Authorization: Bearer clr_live_a1b2c3d4...

2. Connect your agent

POST /api/v1/agent/connect
{
  "agentName": "Shopping Assistant",
  "agentType": "shopping",
  "platform": "claude",
  "capabilities": ["shopping", "payment", "research"]
}

3. Check before acting

POST /api/v1/agent/check
{
  "action": "purchase",
  "transaction": {
    "amount": 49.99,
    "currency": "USD",
    "merchantName": "Amazon",
    "merchantDomain": "amazon.com",
    "category": "electronics"
  }
}

Endpoints

POST/api/v1/agent/connectRegister agent and establish connection

POST/api/v1/agent/checkPre-action rule evaluation

GET/api/v1/agent/rulesFetch configured rules

GET/api/v1/agent/soulFetch soul.md personality

GET/api/v1/agent/storesFetch trusted/blocked stores

Response Codes

Code	Meaning
200	Success
201	Agent created (pending confirmation)
400	Validation error
401	Invalid or missing API key
403	Agent suspended, pending, or kill switch active
404	Agent not found
429	Rate limit exceeded

Check Response

{
  "result": "allow" | "deny" | "escalate",
  "ruleId": "SF-001",
  "ruleName": "Per-Transaction Spending Cap",
  "reason": "Transaction amount $49.99 is within limit of $500",
  "approvalRequired": {
    "tier": 1,
    "method": "notification",
    "timeout": 300
  },
  "evaluatedRules": 42,
  "timestamp": "2026-02-20T12:00:00.000Z"
}