ProxiedCopilotRuntimeAgentConfig
Configuration object for constructing a ProxiedCopilotRuntimeAgent.
Overview
ProxiedCopilotRuntimeAgentConfig is the constructor argument for ProxiedCopilotRuntimeAgent. It extends AG-UI's HttpAgentConfig (omitting url, which is derived from runtimeUrl) and adds the routing, transport, and runtime-mode fields the proxy needs to reach a CopilotRuntime.
Import
import type { ProxiedCopilotRuntimeAgentConfig } from "@copilotkit/core";Definition
interface ProxiedCopilotRuntimeAgentConfig
extends Omit<HttpAgentConfig, "url"> {
runtimeUrl?: string;
transport?: CopilotRuntimeTransport;
credentials?: RequestCredentials;
runtimeMode?: RuntimeMode | "pending";
intelligence?: IntelligenceRuntimeInfo;
capabilities?: AgentCapabilities;
debug?: ResolvedDebugConfig;
runtimeAgentId?: string;
}Properties
Prop
Type
Prop
Type
Prop
Type
Prop
Type
Prop
Type
Prop
Type
Prop
Type
Prop
Type
Usage
import { ProxiedCopilotRuntimeAgent } from "@copilotkit/core";
const agent = new ProxiedCopilotRuntimeAgent({
runtimeUrl: "/api/copilotkit",
agentId: "default",
transport: "auto",
credentials: "include",
});