Skip to content
Guide Reference Download app

API overview

Claxedo is a set of composable packages for building coding-agent products. The HTTP surfaces below are owned by different packages in the stack — each one is a distinct trust boundary. This page indexes the surfaces and points at the per-surface reference pages.

SurfaceOwning packageReference
/api/wr/* — per-workspace host routes (health, capabilities, config, events, files, diff/git, PTY, process, hooks, session-env)@claxedo/workspace-runtimeWorkspace runtime API
Relay tunnel edge + /metrics + /health@claxedo/workspace-relayRelay API
MCP runtime tools (stdio)@claxedo/mcpMCP tools
/api/claxedo/integrations/* — connections framework@claxedo/connections (mounted by the host)Connections API
/api/workgraph/* — personal WorkGraph commands, snapshots, opaque tenant-bound cursors, ordered changes, Work Sources, Source Views, and candidate admission@claxedo/workgraph (mounted by claxedo-server)WorkGraph package source
Channel ingress webhooks (github / slack / telegram / discord / whatsapp)@claxedo/channelsChannels API
PackageUse it for
@claxedo/workspace-runtimeRun or embed a per-workspace host next to the project directory the agent should work on.
@claxedo/agent-extensionsDiscover, install, lock, materialize, and replay reusable Agent Extension packages for OpenCode, Claude, Codex, and Cursor.
@claxedo/agent-sdk-runtimeEmbed one AgentRuntime facade over OpenCode, ACP harnesses, native SDK harnesses, or Pi.
@claxedo/agent-event-runtimeNormalize raw harness events into a canonical AgentRuntimeEvent stream and project them into compatibility formats.
@claxedo/workspace-relay-protocolUse tunnel wire types and token verifier contracts without pulling in Hono or server code.
@claxedo/workspace-relayRun the relay process that connects browsers/gateways to workspace-runtime hosts.
@claxedo/mcpExpose Claxedo runtime tools to any MCP client.
@claxedo/sandbox-managerManage sandbox placement and epoch-based leases for running workspace runtimes inside provider sandboxes (Cloudflare, Daytona, Docker, Modal, Vercel).
@claxedo/channelsRoute GitHub / Slack / Telegram / Discord / WhatsApp messages into Claxedo sessions with dedup, session resolution, and approval bridging.
@claxedo/connectionsLink external accounts (Notion, Atlassian, GitHub, Google) once and consume them by capability.
@claxedo/workgraphEmbed the personal AI-work graph, runtime-neutral contracts, SQLite adapter, HTTP router, and core adapter conformance v5. The host supplies trusted organization and user scope; Claxedo Cloud supplies the Convex adapter through its control plane.
control-plane (claxedo-server)Study the gateway/host composition Claxedo itself runs. Private and unpublished; a @claxedo/control-plane split is planned. See control-plane.

The runtime and relay packages ship code-supported surfaces. Some concerns are deliberately product / control-plane owned and are not part of any package API surface:

Product-owned surfaceStatus
Agent Extension catalog policyCurated catalog data and marketplace UX live in the product/control plane, not in @claxedo/agent-extensions.
Agent Extension auth and org UXWorkspace/user/org authorization and team-wide activation UX live in the control plane. The package exposes desired state and policy primitives.
Agent Extension fan-outServer/supervisor code decides which connected workspace runtimes receive snapshots. The package materializes the snapshot it is given.
SurfaceSupported todaySource
Standalone workspace runtimestartServer(port, options)packages/workspace-runtime/src/server.ts
Embedded runtime Hono appcreateWorkspaceRuntimeApp(options)packages/workspace-runtime/src/server.ts
Low-level Workspace HostcreateWorkspaceHost(options)packages/workspace-runtime/src/workspace/runtime.ts
Core route mountingmountWorkspaceCore(app, upgradeWebSocket, { eventHub, exposure })packages/workspace-runtime/src/workspace/core.ts
Relay-attached runtime optionsworkspaceRelayRuntimeOptionsFromEnvpackages/workspace-runtime/src/workspace-relay-env.ts
MCP runtime tools@claxedo/mcp CLI packagepackages/claxedo-mcp/package.json, packages/claxedo-mcp/src/server.ts

For per-package install instructions and architecture, start at the workspace-runtime package page and follow the sidebar; each API page above also links back to its owning package.