/run endpoint. You need endpoints to:
- Run agents in streaming mode and as background jobs
- Manage the sessions, memory, and learnings your agents accumulate
- Inspect runs, traces, and metrics
- Schedule recurring work
- Gate sensitive tool calls on human approval
- Resume paused runs once that approval comes back
The surface area
Browse the live OpenAPI spec at the
/docs endpoint of your AgentOS.
How a request looks
Every run endpoint returns the same shape, whether it’s an agent, a team, or a workflow:stream=true for Server-Sent Events. Pass background=true to run async and poll for completion. The contract doesn’t change across surfaces.
Adding your own routes
Under the hood, AgentOS is a FastAPI app. Register additional routes for webhooks, custom dashboards, integrations:agent.run(...) or await agent.arun(...) from anywhere.
Auth
Whenauthorization=True, every endpoint except /health and /openapi.json requires a valid JWT in the Authorization: Bearer ... header. AgentOS validates the token, extracts claims, and applies RBAC scopes per request before any agent code runs. See Security & Auth for the full model.