Developer guide / api
HTTP API and configuration
Each runtime mounts separate routes under a configurable base path. The shared driver uses /copilotkit.
Draft · The release review is in progress.
Runs and connections
GET /info returns capabilities. POST /agent/:agentId/run starts a run.
RunAgentInput contains threadId, runId, messages, tools, context, state, and forwardedProps. The response contains realtime connection credentials.
POST /agent/:agentId/connect does not create a thread. A blank connection request returns HTTP 204.
POST /agent/:agentId/stop/:threadId stops an authorized run. The optional runId prevents an old request from stopping a new run.
Threads
GET /threads lists threads. Thread-specific routes read messages, events, and state.
Thread changes include update, archive, delete, and subscription credentials. Each operation retains explicit user scope.
Private platform lock routes are not public runtime routes. An explicit runtime mount rejects extra internal path prefixes.
Memories and annotations
Memory routes support reads, creation, updates, retirement, recall, and subscriptions. A server-owned policy determines permitted access.
A denied policy must fail before a platform request. A policy exception must not grant access.
The annotation route sends user feedback to Intelligence. The SDK accepts an existing Learning Container ID when it creates a thread.
The Runtime can select that container from trusted server configuration before a run.
Host configuration
Each native library accepts a platform API URL, runner WebSocket URL, browser WebSocket URL, and project API key.
TypeScript derives runner and browser URLs from its WebSocket base URL. A runner URL excludes the final /websocket suffix.
The host configures agents, authentication, CORS, A2UI, MCP servers, telemetry, and shutdown. Package READMEs contain the language-specific names.