CopilotRuntime

{ /*

• ATTENTION! DO NOT MODIFY THIS FILE!
• This page is auto-generated. If you want to make any changes to this page, changes must be made at:
• packages/runtime/src/lib/runtime/copilot-runtime.ts */ } <Callout type="info">

This is the reference for the CopilotRuntime class. For more information and example code snippets, please see Copilot Runtime. </Callout>

Usage

import { CopilotRuntime } from "@copilotkit/runtime";
 
const copilotKit = new CopilotRuntime();

constructor(params?: CopilotRuntimeConstructorParams<T> & PartialBy<CopilotRuntimeOptions, "agents">)

A2UI (Agent-to-UI)

Enable the A2UI middleware to let agents generate rich, interactive UI components at runtime.

a2ui

boolean | object (optional)

Pass true to enable with defaults, false or omit to disable, or an object to customise behaviour.

// Enable with defaults
const runtime = new CopilotRuntime({
  agents,
  a2ui: true,
});

// Customise
const runtime = new CopilotRuntime({
  agents,
  a2ui: {
    agents: ["my-agent"],
    schema: [
      {
        name: "TodoCard",
        description: "A card displaying a todo item",
        props: { title: { type: "string" }, done: { type: "boolean" } },
      },
    ],
    injectA2UITool: true,
  },
});

When a2ui is configured the runtime reports a2uiEnabled: true from the /info endpoint, which tells the frontend to activate the built-in A2UI renderer automatically.

A2UI Options (object form)