UseNextChatOptions

Defined in: react-nextjs/src/client.ts:20

Extended options for Next.js useChat.

Extends

• UseChatOptions

Properties

api?

optional api: string

Defined in: react-core/dist/types/types.d.ts:117

API endpoint for chat

Inherited from

UseChatOptions.api

---

body?

optional body: Record<string, unknown>

Defined in: react-core/dist/types/types.d.ts:121

Request body extras

Inherited from

UseChatOptions.body

---

direct?

optional direct: DirectModeOptions

Defined in: react-core/dist/types/types.d.ts:130

Direct backend mode configuration. When provided, bypasses HTTP and uses the backend adapter directly.

Inherited from

UseChatOptions.direct

---

experimental?

optional experimental: object

Defined in: react-nextjs/src/client.ts:24

Experimental features

partialHydration?

optional partialHydration: boolean

Enable partial hydration

suspense?

optional suspense: boolean

Enable React Suspense

---

generateId()?

optional generateId: () => string

Defined in: react-core/dist/types/types.d.ts:132

Generate unique message IDs

Returns

string

Inherited from

UseChatOptions.generateId

---

headers?

optional headers: Record<string, string>

Defined in: react-core/dist/types/types.d.ts:119

Request headers

Inherited from

UseChatOptions.headers

---

id?

optional id: string

Defined in: react-core/dist/types/types.d.ts:115

Chat ID for persistence

Inherited from

UseChatOptions.id

---

initialInput?

optional initialInput: string

Defined in: react-core/dist/types/types.d.ts:113

Initial input value

Inherited from

UseChatOptions.initialInput

---

initialMessages?

optional initialMessages: Message[]

Defined in: react-core/dist/types/types.d.ts:111

Initial messages

Inherited from

UseChatOptions.initialMessages

---

keepLastMessageOnError?

optional keepLastMessageOnError: boolean

Defined in: react-core/dist/types/types.d.ts:138

Keep last message on error

Inherited from

UseChatOptions.keepLastMessageOnError

---

maxToolRoundtrips?

optional maxToolRoundtrips: number

Defined in: react-core/dist/types/types.d.ts:140

Max number of automatic tool retries

Inherited from

UseChatOptions.maxToolRoundtrips

---

onError()?

optional onError: (error) => void

Defined in: react-core/dist/types/types.d.ts:136

Called on error

Parameters

error

Error

Returns

void

Inherited from

UseChatOptions.onError

---

onFinish()?

optional onFinish: (message) => void

Defined in: react-core/dist/types/types.d.ts:134

Called when response stream finishes

Parameters

message

Message

Returns

void

Inherited from

UseChatOptions.onFinish

---

onResponse()?

optional onResponse: (response) => void

Defined in: react-core/dist/types/types.d.ts:125

Called for each response chunk (HTTP mode only)

Parameters

response

Response

Returns

void

Inherited from

UseChatOptions.onResponse

---

sendExtraMessageFields?

optional sendExtraMessageFields: boolean

Defined in: react-core/dist/types/types.d.ts:142

Send extra message fields

Inherited from

UseChatOptions.sendExtraMessageFields

---

serverAction()?

optional serverAction: (body) => Promise<unknown>

Defined in: react-nextjs/src/client.ts:22

Use server action instead of API route

Parameters

body

unknown

Returns

Promise<unknown>

---

streamProtocol?

optional streamProtocol: "text" | "data"

Defined in: react-core/dist/types/types.d.ts:123

Stream protocol

Inherited from

UseChatOptions.streamProtocol