CopilotRuntime

This class is the main entry point for the runtime. It handles requests from the frontend, provides function calling and various LLM backends.

For example, to use OpenAI as a backend (check the OpenAI Adapter docs for more info):

const copilotKit = new CopilotRuntime();
return copilotKit.response(req, new OpenAIAdapter());

Currently we support:

• OpenAI
• LangChain
• OpenAI Assistant API
• Google Gemini

​

Server Side Actions

CopilotKit supports actions that can be executed on the server side. You can define server side actions by passing the actions parameter:

const copilotKit = new CopilotRuntime({
  actions: [
    {
      name: "sayHello",
      description: "Says hello to someone.",
      argumentAnnotations: [
        {
          name: "arg",
          type: "string",
          description: "The name of the person to say hello to.",
          required: true,
        },
      ],
      implementation: async (arg) => {
        console.log("Hello from the server", arg, "!");
      },
    },
  ],
});

Server side actions can also return a result which becomes part of the message history.

This is useful because it gives the LLM context about what happened on the server side. In addition, it can be used to look up information from a vector or relational database and other sources.

In addition to that, server side actions can also come from LangChain, including support for streaming responses.

Returned results can be of the following type:

• anything serializable to JSON
• string
• LangChain types:
  • IterableReadableStream
  • BaseMessageChunk
  • AIMessage

​

LangServe

The backend also supports LangServe, enabling you to connect to existing chains, for example python based chains. Use the langserve parameter to specify URLs for LangServe.

const copilotKit = new CopilotRuntime({
  langserve: [
    {
      chainUrl: "http://my-langserve.chain",
      name: "performResearch",
      description: "Performs research on a given topic.",
    },
  ],
});

When left out, arguments are automatically inferred from the schema provided by LangServe.

​

Constructor

onBeforeRequest: (options: {
  threadId?: string;
  runId?: string;
  inputMessages: Message[];
  properties: any;
}) => void | Promise<void>;

onAfterRequest: (options: {
  threadId?: string;
  runId?: string;
  inputMessages: Message[];
  outputMessages: Message[];
  properties: any;
}) => void | Promise<void>;

​

process(request: CopilotRuntimeRequest)