@assistant-ui/eve

Eve runtime hook and message conversion utilities for assistant-ui React applications.

API Reference

convertEveMessage

Converts a single Eve message into an assistant-ui thread message.

const convertEveMessage: (message: EveMessage, index: number, messages: readonly EveMessage[], options?: ConvertEveMessagesOptions) => ThreadMessage;

convertEveMessages

Converts the full Eve message data object into assistant-ui thread messages.

const convertEveMessages: (data: EveMessageData, options?: ConvertEveMessagesOptions) => ThreadMessage[];

getEveMessageContent

Converts an assistant-ui append message into the message payload accepted by Eve's send API.

const getEveMessageContent: (message: AppendMessage) => NonNullable<SendTurnPayload["message"]>;

useEveAgentRuntime

Connects Eve's useEveAgent hook to assistant-ui's runtime contract.

The runtime renders Eve messages, forwards new user messages to the Eve session, supports cancellation, and maps Eve input requests to assistant-ui tool approval UI.

useEveAgentRuntime

options ?: UseEveAgentRuntimeOptions

onError ?: (error: Error) => void

onFinish ?: (snapshot: EveAgentStoreSnapshot<TData>) => void

auth ?: ClientAuth

basic : ClientAuth["basic"]

username : string
password : TokenValue

bearer : TokenValue

headers ?: HeadersValue

host : string = ""

Base URL for eve client requests. Defaults to same-origin eve routes such as `/eve/v1/...`. Pass a same-origin prefix such as `/api` for an app-owned proxy, or an absolute origin to talk to an eve server directly.

initialEvents ?: readonly HandleMessageStreamEvent[]

initialSession ?: SessionState

continuationToken ?: string
sessionId ?: string
streamIndex : number

maxReconnectAttempts ?: number

optimistic : boolean = true

Project submitted user messages before eve confirms them with a `message.received` stream event. Optimistic events are reducer-facing projection events only. They are not exposed through `events`, which remains the authoritative eve stream.

session ?: ClientSession

#private : any

state : SessionState

Current session cursor. Always reflects the latest state after each completed turn. Serialize this to persist and resume later.

continuationToken ?: string
sessionId ?: string
streamIndex : number

send : <TOutput = unknown>(input: SendTurnInput<TOutput>) => Promise<MessageResponse<TOutput>>

Sends one turn payload to the agent. Pass a string as shorthand for `{ message }`, or pass an object to submit follow-up text, HITL results, client context, output schema, signal, and headers in a single request.

stream : (options?: StreamOptions) => AsyncIterable<HandleMessageStreamEvent>

Opens this session's event stream for the current session ID. Resumes from the session's stored stream cursor unless `options.startIndex` overrides it. The returned iterable reconnects on transient socket disconnects, up to the client's `maxReconnectAttempts`.

onEvent ?: (event: HandleMessageStreamEvent) => void

onSessionChange ?: (session: SessionState) => void

prepareSend ?: PrepareSend

suggestions ?: readonly ThreadSuggestion[]

isDisabled ?: boolean

Whether the entire thread is disabled. When `true`, the composer's input is also disabled (the user cannot type, attach files, or submit). For a narrower gate that keeps the input usable but blocks only sending, use `isSendDisabled`.

isSendDisabled ?: boolean

Whether sending new messages is currently disabled. When `true`, the thread composer's input remains usable but `send()` becomes a no-op and the thread composer's `canSend` is `false`. Use this to gate sending on external React state (e.g. while tool config is loading) without disabling the input itself the way `isDisabled` does. Edit composers (saving message edits) intentionally ignore this flag.

unstable_capabilitiesunstable ?: UseEveAgentRuntimeOptions["unstable_capabilities"]

copy ?: boolean

adapters ?: UseEveAgentRuntimeOptions["adapters"]

attachments ?: AttachmentAdapter

accept : string
add : (state: { file: File; }) => Promise<PendingAttachment> | AsyncGenerator<PendingAttachment, void>
remove : (attachment: Attachment) => Promise<void>
send : (attachment: PendingAttachment) => Promise<CompleteAttachment>

speech ?: SpeechSynthesisAdapter

speak : (text: string) => SpeechSynthesisAdapter.Utterance

dictation ?: DictationAdapter

listen : () => DictationAdapter.Session
disableInputDuringDictation ?: boolean

voice ?: RealtimeVoiceAdapter

connect : (options: { abortSignal?: AbortSignal; }) => RealtimeVoiceAdapter.Session

feedback ?: FeedbackAdapter

submit : (feedback: FeedbackAdapterFeedback) => void