API Reference

Components

IntentCtrlProvider

The root provider component. Must wrap any component that uses IntentCtrl hooks.

---

Hooks

useIntentCtrl

Returns the full chat interface. Throws if used outside IntentCtrlProvider.

useTool

Registers a custom tool for the AI to call. The tool is available while the component is mounted.

usePermissions

Reads and updates the current permission state reactively.

useDataContext

Injects contextual data that is sent with every chat request. Data is cleaned up when the component unmounts.

---

Functions

setRouter

Registers a client-side router for the navigate tool.

---

Types

RuntimePermissions

Controls which built-in tools are available to the AI.

• undefined — allowed, approval may be required
• true — allowed, bypasses approval
• false — denied

SerializedTool

A tool definition serialized for transport.

ChatRequest

The payload sent to your backend with every user message.

SessionState

PaginatedChatSessionsResponse

ChatSessionResponse

ApiResponse

UIMessage

Re-exported from the Vercel AI SDK. Represents a chat message with structured parts.