ThreadListRuntime

ThreadListRuntime state and actions for managing remote assistant-ui conversations, active thread selection, and new thread creation.

API Reference

ThreadListRuntime

ThreadListRuntime

getState : () => ThreadListState

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

main : ThreadRuntime

path : ThreadRuntimePath

The selector for the thread runtime.

ref : string

threadSelector : ThreadRuntimePath["threadSelector"]

type : "main"

composer : ThreadComposerRuntime

The thread composer runtime.

path : ComposerRuntimePath

ref : string
threadSelector : { readonly type: "main" } | { readonly type: "threadId"; readonly threadId: string; }
composerSource : "thread"

type : "edit" | "thread"

addAttachment : (fileOrAttachment: File | CreateAttachment) => Promise<void>

Add an attachment to the composer. Accepts either a standard File object (processed through the AttachmentAdapter) or a CreateAttachment descriptor for external-source attachments (URLs, API data, CMS references). External descriptors bypass the adapter's `add()` step but still respect `adapter.accept` when an adapter is configured; without an adapter they are added as-is.

setText : (text: string) => void

Set the text of the composer.

setRole : (role: MessageRole) => void

Set the role of the composer. For instance, if you'd like a specific message to have the 'assistant' role, you can do so here.

setRunConfig : (runConfig: RunConfig) => void

Set the run config of the composer. This is used to send custom configuration data to the model. Within your backend, you can use the `runConfig` object. Example: ```ts composerRuntime.setRunConfig({ custom: { customField: "customValue" } }); ```

reset : () => Promise<void>

Reset the composer. This will clear the entire state of the composer, including all text and attachments.

clearAttachments : () => Promise<void>

Clear all attachments from the composer.

send : (options?: SendOptions) => void

Send a message. This will send whatever text or attachments are in the composer.

cancel : () => void

Cancel the current run. In edit mode, this will exit edit mode.

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

Listens for changes to the composer state.

startDictation : () => void

Start dictation to convert voice to text input. Requires a DictationAdapter to be configured.

stopDictation : () => void

Stop the current dictation session.

setQuote : (quote: QuoteInfo | undefined) => void

Set a quote for the next message. Pass undefined to clear.

unstable_ondeprecatedunstable : <E extends ComposerRuntimeEventType>(event: E, callback: ComposerRuntimeEventCallback<E>) => Unsubscribe

Deprecated: This API is still under active development and might change without notice.

getState : () => ThreadComposerState

getAttachmentByIndex : (idx: number) => AttachmentRuntime & { source: "thread-composer"; }

getState : () => ThreadState

Gets a snapshot of the thread state.

append : (message: CreateAppendMessage) => void

Append a new message to the thread.

startRun : (config: CreateStartRunConfig) => void

Start a new run with the given configuration.

resumeRun : (config: CreateResumeRunConfig) => void

Resume a run with the given configuration.

exportExternalState : () => any

Export the thread state in the external store format. For AI SDK runtimes, this returns the AI SDK message format. For other runtimes, this may return different formats or throw an error.

importExternalState : (state: any) => void

Import thread state from the external store format. For AI SDK runtimes, this accepts AI SDK messages. For other runtimes, this may accept different formats or throw an error.

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

cancelRun : () => void

getModelContext : () => ModelContext

export : () => ExportedMessageRepository

import : (repository: ExportedMessageRepository) => void

reset : (initialMessages?: readonly ThreadMessageLike[]) => void

Reset the thread with optional initial messages.

getMessageByIndex : (idx: number) => MessageRuntime

getMessageById : (messageId: string) => MessageRuntime

stopSpeakingdeprecated : () => void

Deprecated: This API is still under active development and might change without notice.

connectVoice : () => void

disconnectVoice : () => void

getVoiceVolume : () => number

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

muteVoice : () => void

unmuteVoice : () => void

unstable_onunstable : <E extends ThreadRuntimeEventType>(event: E, callback: ThreadRuntimeEventCallback<E>) => Unsubscribe

getById : (threadId: string) => ThreadRuntime

mainItem : ThreadListItemRuntime

path : ThreadListItemRuntimePath

ref : string

threadSelector : ThreadListItemRuntimePath["threadSelector"]

type : "main"

getState : () => ThreadListItemState

initialize : () => Promise<{ remoteId: string; externalId: string | undefined; }>

generateTitle : () => Promise<void>

switchTo : (options?: { unarchive?: boolean; }) => Promise<void>

rename : (newTitle: string) => Promise<void>

archive : () => Promise<void>

unarchive : () => Promise<void>

delete : () => Promise<void>

detach : () => void

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

unstable_onunstable : <E extends ThreadListItemEventType>(event: E, callback: ThreadListItemEventCallback<E>) => Unsubscribe

getItemById : (threadId: string) => ThreadListItemRuntime

getItemByIndex : (idx: number) => ThreadListItemRuntime

getArchivedItemByIndex : (idx: number) => ThreadListItemRuntime

switchToThread : (threadId: string, options?: { unarchive?: boolean; }) => Promise<void>

switchToNewThread : () => Promise<void>

getLoadThreadsPromise : () => Promise<void>

reload : () => Promise<void>

loadMore : () => Promise<void>

ThreadListState

ThreadListState

mainThreadId : string
newThreadId ?: string
threadIds : readonly string[]
archivedThreadIds : readonly string[]
isLoading : boolean
isLoadingMore : boolean
hasMore : boolean
threadItems : Readonly< Record<string, Omit<ThreadListItemState, "isMain" | "threadId">> >