REST API

The agent server's REST API is the only interface to the agent server. The bundled UI is built on it, and your own scripts, schedulers and applications use the same calls.

• OverviewEvery call under /api/ on the agent server is an HTTP POST with a JSON body. The UI uses nothing else, so everything the UI does is available to your own code.
• AuthenticationA browser signs in with login and receives a session cookie. A program sends a service account's key as a bearer token. Every call carries one or the other.
• Running agentsPOST /api/exec/execAgent runs a named agent. The call returns when the agent finishes, or streams the run as it happens.
• StreamingWith stream: true, execAgent answers with newline-delimited JSON: one object per line, written as the run produces it.
• SearchPOST /api/exec/search is the search box as an API call. It returns the agents that match a query, best first, and leaves the running to the caller.
• ConversationsA conversation is identified by its convid. The /api/user/ group lists, reads, renames, pins and deletes the caller's conversations.
• WorkflowsNothing in an agent runs on its own; every run starts with a request. A call to execAgent from your systems is how agents run without anyone typing.
• Automating tasks with an LLMThe OpenAPI schema at /openapi.json describes every endpoint of the agent server precisely enough for an LLM to call the API. Give the schema to a model or t…
• Creating your own clientThe agent server publishes an OpenAPI schema, so a client in any language can be generated with standard tools.