home/docs

BlackRoad OS API

12 endpoints. REST + JSON. API key in header.

All endpoints except /api/health require an API key. Get one at app.blackroad.io/signup.

Returns service health, agent count, and version.

Returns all 69 registered agents with roles, groups, and status.

Send a message to any agent. Returns AI-generated response via local Ollama.

Execute any of 231 actions across 71 intents. Real scripts run on the Pi fleet.

Send natural language. Parses intent, executes matching script, and returns AI response.

Returns all 71 intents and 231 available actions.

Returns live fleet node status, agent counts, and RoundTrip health.

Returns product catalog for the current domain.

Returns message history for a channel. Query: ?channel=general&limit;=50

Returns all 8 chat channels: general, fleet, iot, security, creative, ops, research, ceo.

Returns agent groups: fleet, cloud, services, ai, ops, myth, lead, iot.

Free tier: /api/health, /api/agents, /api/actions, /api/products, /api/channels, /api/groups

Need a key?

Create an account and your first key is issued immediately.

Get started