@assistant-ui/react-hook-form

React Hook Form integration for AI-assisted form filling.

A React Hook Form integration for @assistant-ui.

API Reference

`useAssistantForm`

Drop-in replacement hook for useForm that adds support for @assistant-ui/react.

- import { useForm } from "react-hook-form";
+ import { useAssistantForm } from "@assistant-ui/react-hook-form";

- useForm({
+ useAssistantForm({
    ...
  });

Properties

UseAssistantFormProps

assistant?: object

Configuration for useAssistantForm

tools?: object

Tools configuration for useAssistantForm

set_form_field?: object

Configuration for the set_form_field tool

render?: ToolCallMessagePartComponent<{ name: string; value: string; }, {}>

The component to render when set_form_field is called.

submit_form?: object

Configuration for the submit_form tool

render?: ToolCallMessagePartComponent<{}, {}>

The component to render when submit_form is called.

The set of tools to use with useAssistantForm on the server side. While the AI SDK now supports forwarding frontend tools via frontendTools(), using formTools directly on the server gives you more control over tool execution.

import { formTools } from "@assistant-ui/react-hook-form";

const result = streamText({
  ...
  tools: {
    ...formTools,
  }
});