API reference

Most of these pages are generated from the source on every build, so they always match the server.

Open API/v1 over HTTPS for your backend: users, agents, conversations, messages, files, moderation, compliance.

Client protocolEvery request on /ws, the protocol apps and agents speak.

Events and push framesWhat a conversation's log contains and what the server pushes.

MCP toolsEvery tool at POST /mcp for MCP clients.

WebhooksSigned, ordered, at-least-once events for your backend.

Error codesEvery code, its meaning and HTTP status.

Admin APIThe API behind the console.

ConfigurationEvery option of agentim.toml.