Persistence

Custom thread persistence

Persist threads and messages to your own database with RemoteThreadListAdapter and ThreadHistoryAdapter.

When AssistantCloud doesn't fit (self-hosting, compliance, threads alongside existing app data), back the multi-thread runtime with your own database. This page is the worked example: schema, route handlers, and adapter wiring with Postgres + Drizzle. The shape is identical for any SQL or document store.

For the high-level adapter contract, see threads. This page focuses on the storage layer and how withFormat round-trips AI SDK messages.

Prerequisites

The route handlers below import auth from @/auth and db from @/db. This guide assumes:

  • A working Drizzle setup at db/index.ts exporting a db instance.
  • An auth solution with a server-side auth() helper exposing session.user.id. See Auth.js (next-auth) for the canonical setup, including the callback that populates session.user.id.

If you're rolling your own auth, replace auth() calls with whatever your stack uses to resolve the current user.

How it works

browser  ──►  /api/threads/*   (RemoteThreadListAdapter)  ──►  threads table
              /api/messages/*  (ThreadHistoryAdapter)     ──►  messages table

Two adapters, two tables:

  • RemoteThreadListAdapter owns thread metadata: list, create, rename, archive, delete.
  • ThreadHistoryAdapter owns messages per thread. The withFormat variant is required by useChatRuntime and converts AI SDK UIMessage to and from a fixed row shape: { id, parent_id, format, content }.

Schema

db/schema.ts
import { pgTable, text, timestamp, jsonb, index } from "drizzle-orm/pg-core";

export const threads = pgTable(
  "threads",
  {
    id: text("id").primaryKey(),
    userId: text("user_id").notNull(),
    title: text("title"),
    status: text("status", { enum: ["regular", "archived"] })
      .notNull()
      .default("regular"),
    custom: jsonb("custom").$type<Record<string, unknown>>(),
    createdAt: timestamp("created_at").notNull().defaultNow(),
    updatedAt: timestamp("updated_at").notNull().defaultNow(),
  },
  (t) => [index("threads_user_idx").on(t.userId)],
);

export const messages = pgTable(
  "messages",
  {
    id: text("id").primaryKey(),
    threadId: text("thread_id")
      .notNull()
      .references(() => threads.id, { onDelete: "cascade" }),
    parentId: text("parent_id"),
    format: text("format").notNull(),
    content: jsonb("content").notNull(),
    createdAt: timestamp("created_at").notNull().defaultNow(),
  },
  (t) => [index("messages_thread_idx").on(t.threadId)],
);

The four message columns (id, parent_id, format, content) are the contract withFormat writes against. format lets multiple runtimes coexist on one row (e.g., "aisdk-v6" from useChatRuntime, a different value from another runtime).

Setup

Install dependencies

npm install drizzle-orm postgres drizzle-kit

Configure Drizzle and run the migration. See the Drizzle quickstart for the full setup.

Build the thread list endpoints

Each method on RemoteThreadListAdapter maps to one route. Always scope by userId from the session so users see only their own threads.

app/api/threads/route.ts
import { db } from "@/db";
import { threads } from "@/db/schema";
import { auth } from "@/auth";
import { and, desc, eq } from "drizzle-orm";
import { generateId } from "ai";

export async function GET() {
  const session = await auth();
  if (!session?.user) return new Response(null, { status: 401 });

  const rows = await db
    .select()
    .from(threads)
    .where(eq(threads.userId, session.user.id))
    .orderBy(desc(threads.updatedAt));

  return Response.json(rows);
}

export async function POST(req: Request) {
  const session = await auth();
  if (!session?.user) return new Response(null, { status: 401 });

  const id = generateId();
  await db.insert(threads).values({ id, userId: session.user.id });
  return Response.json({ id });
}

Implement the per-thread routes the same way under app/api/threads/[id]/route.ts. PATCH updates title or status (used by rename, archive, unarchive); DELETE deletes the thread; GET returns one thread (used by fetch). Always check userId on every handler:

app/api/threads/[id]/route.ts
import { db } from "@/db";
import { threads } from "@/db/schema";
import { auth } from "@/auth";
import { and, eq } from "drizzle-orm";

export async function PATCH(
  req: Request,
  { params }: { params: Promise<{ id: string }> },
) {
  const { id } = await params;
  const session = await auth();
  if (!session?.user) return new Response(null, { status: 401 });

  const patch = (await req.json()) as { title?: string; status?: "regular" | "archived" };
  await db
    .update(threads)
    .set({ ...patch, updatedAt: new Date() })
    .where(and(eq(threads.id, id), eq(threads.userId, session.user.id)));

  return new Response(null, { status: 204 });
}

A POST /api/threads/[id]/title endpoint that calls your model with the first few messages and returns { title } completes the set. The shape mirrors the others; treat it as streamText plus a JSON response.

Build the message endpoints

Two routes: list messages for a thread and append one. Both check thread ownership before touching the messages table.

app/api/threads/[id]/messages/route.ts
import { db } from "@/db";
import { threads, messages } from "@/db/schema";
import { auth } from "@/auth";
import { and, asc, eq } from "drizzle-orm";

export async function GET(
  _req: Request,
  { params }: { params: Promise<{ id: string }> },
) {
  const { id } = await params;
  const session = await auth();
  if (!session?.user) return new Response(null, { status: 401 });

  const [thread] = await db
    .select()
    .from(threads)
    .where(and(eq(threads.id, id), eq(threads.userId, session.user.id)));
  if (!thread) return new Response(null, { status: 404 });

  const rows = await db
    .select()
    .from(messages)
    .where(eq(messages.threadId, id))
    .orderBy(asc(messages.createdAt));

  return Response.json(rows);
}

export async function POST(
  req: Request,
  { params }: { params: Promise<{ id: string }> },
) {
  const { id } = await params;
  const session = await auth();
  if (!session?.user) return new Response(null, { status: 401 });

  const body = (await req.json()) as {
    id: string;
    parent_id: string | null;
    format: string;
    content: Record<string, unknown>;
  };

  await db.insert(messages).values({
    id: body.id,
    threadId: id,
    parentId: body.parent_id,
    format: body.format,
    content: body.content,
  });

  return new Response(null, { status: 204 });
}

Implement RemoteThreadListAdapter

The adapter calls your endpoints. unstable_Provider injects the per-thread history adapter so messages persist alongside metadata.

app/runtime/thread-adapter.tsx
"use client";

import {
  RuntimeAdapterProvider,
  useAui,
  type RemoteThreadListAdapter,
  type ThreadHistoryAdapter,
} from "@assistant-ui/react";
import { createAssistantStream } from "assistant-stream";
import { useMemo } from "react";

export const threadListAdapter: RemoteThreadListAdapter = {
  async list() {
    const rows = await fetch("/api/threads").then((r) => r.json());
    return {
      threads: rows.map((t: any) => ({
        status: t.status,
        remoteId: t.id,
        title: t.title ?? undefined,
      })),
    };
  },
  async initialize() {
    const { id } = await fetch("/api/threads", { method: "POST" }).then((r) =>
      r.json(),
    );
    return { remoteId: id };
  },
  async rename(remoteId, title) {
    await fetch(`/api/threads/${remoteId}`, {
      method: "PATCH",
      body: JSON.stringify({ title }),
    });
  },
  async archive(remoteId) {
    await fetch(`/api/threads/${remoteId}`, {
      method: "PATCH",
      body: JSON.stringify({ status: "archived" }),
    });
  },
  async unarchive(remoteId) {
    await fetch(`/api/threads/${remoteId}`, {
      method: "PATCH",
      body: JSON.stringify({ status: "regular" }),
    });
  },
  async delete(remoteId) {
    await fetch(`/api/threads/${remoteId}`, { method: "DELETE" });
  },
  async fetch(remoteId) {
    const t = await fetch(`/api/threads/${remoteId}`).then((r) => r.json());
    return { status: t.status, remoteId: t.id, title: t.title };
  },
  async generateTitle(remoteId, messages) {
    return createAssistantStream(async (controller) => {
      const { title } = await fetch(`/api/threads/${remoteId}/title`, {
        method: "POST",
        body: JSON.stringify({ messages }),
      }).then((r) => r.json());
      controller.appendText(title);
    });
  },
  unstable_Provider({ children }) {
    const aui = useAui();
    const history = useMemo<ThreadHistoryAdapter>(
      () => ({
        async load() {
          return { messages: [] };
        },
        async append() {},
        withFormat: (fmt) => ({
          async load() {
            const { remoteId } = aui.threadListItem().getState();
            if (!remoteId) return { messages: [] };
            const rows = await fetch(
              `/api/threads/${remoteId}/messages`,
            ).then((r) => r.json());
            return {
              messages: rows.map((row: any) =>
                fmt.decode({
                  id: row.id,
                  parent_id: row.parent_id,
                  format: row.format,
                  content: row.content,
                }),
              ),
            };
          },
          async append(item) {
            const { remoteId } = await aui.threadListItem().initialize();
            await fetch(`/api/threads/${remoteId}/messages`, {
              method: "POST",
              body: JSON.stringify({
                id: fmt.getId(item.message),
                parent_id: item.parentId,
                format: fmt.format,
                content: fmt.encode(item),
              }),
            });
          },
        }),
      }),
      [aui],
    );
    return (
      <RuntimeAdapterProvider adapters={{ history }}>
        {children}
      </RuntimeAdapterProvider>
    );
  },
};

The top-level load/append on the history adapter are required by the type but unused by useChatRuntime. The AI SDK code path always goes through withFormat.

Mount the runtime

Wrap the app in a useRemoteThreadListRuntime that delegates per-thread runtime to useChatRuntime:

app/runtime/MyProvider.tsx
"use client";

import {
  AssistantRuntimeProvider,
  useRemoteThreadListRuntime,
} from "@assistant-ui/react";
import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
import { threadListAdapter } from "./thread-adapter";

export function MyProvider({ children }: { children: React.ReactNode }) {
  const runtime = useRemoteThreadListRuntime({
    runtimeHook: () => useChatRuntime(),
    adapter: threadListAdapter,
  });
  return (
    <AssistantRuntimeProvider runtime={runtime}>
      {children}
    </AssistantRuntimeProvider>
  );
}

Run and verify

Send a message in a fresh thread. Check the database:

  • The threads table has a new row with the current userId.
  • The messages table has at least two rows (user + assistant) for that thread.
  • format is "aisdk-v6" (or whatever AI SDK's current format string is).
  • Reload the page; the thread list and the messages survive.

Notes

  • First-message race. append may fire before the thread row exists. The unstable_Provider example above always awaits aui.threadListItem().initialize() before writing; do the same in any custom implementation.
  • Reload after async auth. If auth() resolves after the initial list() call, threads won't appear until the user refreshes. Call aui.threads().reload() from a useEffect watching the session. Pattern is documented in threads.
  • Format string. The format column is not a free-text label; it identifies the on-disk shape so multiple runtimes can coexist. Don't strip it. Don't make assumptions about its value (useChatRuntime is responsible for setting and decoding it).
  • unstable_Provider synchronous-children rule. The Provider must render children on first commit; do not gate them behind suspense, loading state, or useEffect. Load data inside an always-rendered child.