Skip to content

Register an Agent

POST /v1/agents/register

No authentication required. This is the entry point to the platform.

Terminal window
curl -X POST https://agents.systemr.ai/v1/agents/register \
-H "Content-Type: application/json" \
-d '{
"owner_id": "your-unique-owner-id",
"agent_name": "RiskBot",
"agent_type": "trading",
"description": "Equity momentum strategy with strict risk controls",
"authorized_instruments": ["AAPL", "MSFT", "GOOGL", "AMZN"],
"authorized_actions": ["size", "risk_check", "analyze"],
"max_position_size_pct": "5.0",
"max_daily_loss_pct": "2.0"
}'
ParameterTypeRequiredDescription
owner_idstringYesYour unique owner identifier. Used to group agents.
agent_namestringYesDisplay name for the agent (1 to 100 characters).
agent_typestringYesOne of: trading, analysis, risk, composite.
descriptionstringNoShort description (up to 500 characters).
authorized_instrumentsstring[]NoInstrument whitelist. If set, the agent can only trade these symbols.
authorized_actionsstring[]NoAction whitelist. Restricts which tools the agent can call.
max_position_size_pctstringNoMaximum position size as percentage of equity.
max_daily_loss_pctstringNoMaximum daily loss as percentage of equity.
TypeUse case
tradingFull execution agents. Can connect brokers, place orders, and use all tools.
analysisAnalysis-only agents. Can call analysis and intelligence tools. No broker access.
riskRisk monitoring agents. Focused on risk checks, compliance, and audit trails.
compositeMulti-purpose agents. Combines capabilities of multiple types.
{
"agent_id": "agt_a1b2c3d4",
"agent_name": "RiskBot",
"agent_type": "trading",
"mode": "sandbox",
"api_key": "sr_agent_abc123def456ghi789jkl012mno345pqr678",
"created_at": "2026-03-25T12:00:00Z"
}

API keys follow the format sr_agent_ followed by 40 random alphanumeric characters.

  • The key is shown once in the registration response.
  • Store it securely. It cannot be retrieved after registration.
  • Pass it in every request via the X-API-Key header.

New agents start in sandbox mode. You can change the mode later.

ModeDescription
sandboxPaper trading only. Can connect to the demo broker. No real orders.
liveReal trading. Can connect to any supported broker.
suspendedTemporarily disabled. No API calls permitted.
terminatedPermanently deactivated. Cannot be reactivated.

Change mode with:

Terminal window
curl -X PUT https://agents.systemr.ai/v1/agents/mode \
-H "X-API-Key: sr_agent_..." \
-H "Content-Type: application/json" \
-d '{"mode": "live"}'
import httpx
resp = httpx.post(
"https://agents.systemr.ai/v1/agents/register",
json={
"owner_id": "your-owner-id",
"agent_name": "MyBot",
"agent_type": "trading",
},
)
data = resp.json()
api_key = data["api_key"] # Store this securely

One owner can register multiple agents. Each agent has its own:

  • API key
  • Compute credit balance
  • Broker connection
  • Audit trail
  • Encryption keys

List all agents under your owner:

Terminal window
curl https://agents.systemr.ai/v1/agents/list \
-H "X-API-Key: sr_agent_..."