@threadplane/ag-uiInterfacev0.3.4

AgentConfig

Connection options for the AG-UI agent provider, passed to provideAgent. Mirrors the underlying HttpAgent config (@ag-ui/client) plus an optional telemetry sink.

View source View Markdown

import type { AgentConfig } from '@threadplane/ag-ui';

Declaration

export interface AgentConfig  {
  agentId?: string;
  headers?: Record<string, string>;
  interruptTransport?: ToAgentOptions['interruptTransport'];
  persistence?: ToAgentOptions['persistence'];
  replay?: ToAgentOptions['replay'];
  telemetry?: AgentRuntimeTelemetrySink | false;
  threadId?: string;
  url: string;
}

Members

agentId

Agent identifier, when the endpoint serves more than one agent.

agentId?: string;

headers

Extra HTTP headers sent with every request (e.g. auth tokens).

headers?: Record<string, string>;

interruptTransport

Explicit compatibility wire profile; auto prefers protocol-native outcomes.

interruptTransport?: ToAgentOptions['interruptTransport'];

persistence

Optional application-owned durable thread storage and reconciliation.

persistence?: ToAgentOptions['persistence'];

replay

Optional source of the thread's AG-UI events, replayed on hydration so a reopened thread comes back as the live view showed it. Called only when threadId is configured — a fresh conversation has nothing to replay. httpReplay() covers the common HTTP shape.

replay?: ToAgentOptions['replay'];

telemetry

Omit to enable automatic development-only collection. Set false to disable. An app-owned sink replaces the automatic destination and receives the existing runtime lifecycle callbacks.

telemetry?: AgentRuntimeTelemetrySink | false;

threadId

Thread to connect to on start; omit to begin a fresh conversation.

threadId?: string;

url

Endpoint URL of the AG-UI HTTP agent (e.g. 'http://localhost:8000/agent'). Required.

url: string;