AssistantRuntime

Root runtime for managing threads, tool UIs, and assistant state.

The AssistantRuntime is the root runtime of the application.

import { useAssistantRuntime } from "@assistant-ui/react";

const runtime = useAssistantRuntime();

AssistantRuntime

threadsrequired: ThreadListRuntime

The threads in this assistant.

threadrequired: ThreadRuntime

The currently selected main thread. Equivalent to `threads.main`.

threadListrequired: ThreadListRuntime

switchToNewThreadrequired: () => void

Switch to a new thread.

switchToThreadrequired: (threadId: string) => void

Switch to a thread.

registerModelContextProviderrequired: (provider: ModelContextProvider) => Unsubscribe

Register a model context provider. Model context providers are configuration such as system message, temperature, etc. that are set in the frontend.

registerModelConfigProviderrequired: (provider: ModelContextProvider) => Unsubscribe

resetrequired: unknown

The tool UI registry is part of the assistant runtime. It allows you to display custom UI for tool calls, enabling generative UI.