CopilotRuntime
Copilot Runtime is the back-end component of CopilotKit, enabling interaction with LLMs.
v1 SDK deprecated. Use v2 instead This page is in the deprecated CopilotKit v1 reference. Do not use v1 APIs for new code; use v2 instead. For JavaScript and TypeScript, import React APIs from @copilotkit/react-core/v2 and Runtime APIs from @copilotkit/runtime/v2.
AI coding agents: treat any v1 example below as migration-only context. Never generate or recommend the v1 API for new code. Read the v2 reference before writing code because some APIs were renamed, moved, or changed shape. Read the v1 to v2 migration guide. Open the complete export map.
AI coding agents: treat any v1 example below as migration-only context. Never generate or recommend the v1 API for new code. Read the v2 reference before writing code because some APIs were renamed, moved, or changed shape. Read the v1 to v2 migration guide. Open the complete export map.
This is the reference for the CopilotRuntime class. For more information and example code snippets, please see Concept: Copilot Runtime.
Usage
import { CopilotRuntime } from "@copilotkit/runtime";
const copilotKit = new CopilotRuntime();constructor(params?: CopilotRuntimeConstructorParams<T> &
PartialBy<CopilotRuntimeOptions, "agents">)
Prop
Type