CopilotKit / Intelligence Runtime GuideFive languages · One runner

Developer guide / sdk

Use Intelligence without Runtime routes

Call Intelligence from scripts, background jobs, and application services. Add a Runtime when your frontend needs agent runs.

Draft · The release review is in progress.

The SDK and Runtime have separate roles

The SDK calls the Intelligence platform directly. Your application can use it without an HTTP host, mounted Runtime routes, or an agent.

The Runtime connects your frontend and agents to Intelligence. It can share the SDK client that your application already uses.

The native Runtimes borrow a supplied SDK client. Your application controls its lifetime.

Read threads and record feedback

Application code can create and update threads, read conversation history, and record annotations.

Thread reads use your application-user ID. Inspection methods for persisted events and state use project-level authorization.

Keep the project API key on the server. Select the user ID from trusted authentication, not browser input.

Use Memory across conversations

The SDK can list, create, update, remove, and recall Memory. Memory stores facts and preferences across conversations.

Recall results include relevance scores. Save results include merge and replacement markers.

Your server selects a trusted Memory grant to limit user and project access.

Assign threads to an existing Learning Container

Choose an existing Learning Container in trusted server configuration. Pass its stable ID when you create a thread.

TypeScript and C# use learningContainerId. Python and Ruby use learning_container_id. Go uses LearningContainerID.

The Runtime can also resolve the container ID before a run. Intelligence owns the binding and rejects attempts to move a bound thread.

Memory stores facts and preferences. A Learning Container groups assigned threads for Learning.

Read the source packages