Interface StreamOpenUIOptions

examples/langchain-chat/src/lib/stream-openui.ts:6–33

* Options for streamOpenUI.

 * Options for {@link streamOpenUI}.
 */
interface StreamOpenUIOptions {
  /**
   * Base URL of the LangGraph server (agent protocol v2), e.g.
   * `http://localhost:2024`. Trailing slashes are stripped before use.
   */
  apiUrl: string;
  /**
   * The id of the graph/assistant to run (the `graph_id` registered with the
   * LangGraph server, e.g. `"agent"`).
   */
  assistantId: string;
  /**
   * Optional API key forwarded as the `x-api-key` header (required by
   * LangSmith deployments, omitted for local `langgraphjs dev`).
   */
  apiKey?: string;
  /**
   * The run input handed to the graph — typically `{ messages: [...] }` in
   * LangChain message format. Kept as `unknown` since this helper does not
   * interpret it.
   */
  input: unknown;
  /**
   * Caller's abort signal (Next.js aborts this when the browser disconnects).
   * Aborting tears down the upstream LangGraph fetches and closes the stream.
   */
  signal?: AbortSignal;
}

/**
 * A single Server-Sent Events frame parsed out of the LangGraph response body,