logoassistant-ui
API ReferenceRuntime Hooks

ThreadListRuntime

Access via useAssistantRuntime

You can access the thread list runtime via the assistant runtime:

import { useAssistantRuntime } from "@assistant-ui/react";
 
const threadListRuntime = useAssistantRuntime().threadList;

ThreadListRuntime

getState:

() => ThreadListState

subscribe:

(callback: () => void) => Unsubscribe

main:

ThreadRuntime

getById:

(threadId: string) => ThreadRuntime

mainItem:

ThreadListItemRuntime

getItemById:

(threadId: string) => ThreadListItemRuntime

getItemByIndex:

(idx: number) => ThreadListItemRuntime

getArchivedItemByIndex:

(idx: number) => ThreadListItemRuntime

switchToThread:

(threadId: string) => Promise<void>

switchToNewThread:

() => Promise<void>

useThreadList

This hook provides access to the thread list state:

import { useThreadList } from "@assistant-ui/react";
 
const threadList = useThreadList();
const threads = useThreadList((m) => m.threads);

ThreadListState

mainThreadId:

string

newThread:

string | undefined

threads:

readonly string[]

archivedThreads:

readonly string[]

On this page

Edit on Github