Skip to content

REST API

The hosted runtime exposes most operational APIs through the portal layer.

Current controllers verify route groups for:

  • /api/about
  • /api/auth/config
  • /api/agents
  • /api/providers
  • /api/users
  • /api/groups
  • /api/channels
  • /api/channels/conversations
  • /api/cli-tools
  • /api/mcp-servers
  • /api/remote-agents
  • /api/tools
  • /api/metrics
  • /api/export* and /api/import*
  • /api/tasks

Session and execution routes are implemented under /api/sessions, including:

  • list, search, get, delete, admin list
  • events, audit, pending ops
  • execute
  • execute-with-content
  • cancel and detach-subagent
  • members, feedback, workspace files
  • pending inputs and session surfaces

The current execution model is asynchronous. REST starts the execution and SignalR carries the live event stream back to connected clients.

The upstream docs/reference/rest-api.md file still contains proposed synchronous execution endpoints. Those sync endpoints are explicitly marked proposed there and do not exist in the current controller tree.

The same upstream file also says POST /api/sessions/execute returns 202 with an empty body. Current code returns an accepted response payload containing at least the SessionId and optionally the ClientMessageId.

For a broader summary, see API Reference.