Skip to main content
Durable chat runs can span hours and many turns. You usually want:
  1. Conversation state — full UIMessage[] (or equivalent) keyed by chatId, so reloads and history views work.
  2. Live session state — a scoped access token for the session and optionally lastEventId for stream resume.
You can persist the conversation state through a transcript storage on the agent rather than the hook mapping below. Give chat.agent a storage that writes to your database and the runtime hands it every change (a new message, an undo, a regenerate, a compaction) as it happens, with the resume cursors, and reads it back when a run continues. Your own database is then the transcript. The hook mapping below still works, and it is the way to persist the live session state (the access token) and anything the transcript does not cover.
This page describes a hook mapping that works with any database. Adapt table and column names to your stack.

Conceptual data model

You can use one table or two; the important split is semantic: The conversation row is what your UI lists as “chats.” The session row is what the transport needs after a refresh: a session-scoped PAT (so the transport doesn’t have to re-mint on first paint) and the SSE resume cursor. Storing the current runId is optional — useful for telemetry / dashboard linking (“View this run”) but not required for resume. The Session row owns its current run server-side; the transport reads from session.out keyed on chatId, so a run swap (continuation, upgrade) is invisible to your DB schema.
Store UIMessage[] in a JSON-compatible column, or normalize to a messages table — the pattern is when you read/write, not how you encode rows.

Where each hook writes

This pattern covers durable DB rows (the conversation and the active session). Per-process in-memory state (chat.local, DB connection pools, sandboxes, etc.) belongs in onBoot — it fires on every fresh worker including continuation runs, where onPreload and onChatStart do not.

onPreload (optional)

When the user triggers preload, the run starts before the first user message.
  • Ensure the conversation row exists (create or no-op).
  • Upsert session: chatAccessToken from the event (a session-scoped PAT covering both read:sessions:{chatId} and write:sessions:{chatId}).
  • Load any user / tenant context you need for prompts (clientData).
If you skip preload, do the equivalent in onChatStart when preloaded is false.

onChatStart (chat’s first message, non-preloaded path)

  • Fires once per chat, on the very first user message. Does NOT fire on continuation runs (post-endRun, post-waitpoint-timeout, post-chat.requestUpgrade) or on OOM-retry attempts.
  • If preloaded is true, return early — onPreload already ran.
  • Otherwise mirror preload: user/context, conversation create, session upsert.
  • No need to gate the conversation create on continuation — it’s always a brand-new chat at this point.
  • For continuation runs that need to refresh per-run state (new PAT, new lastEventId), do it in onTurnStart / onTurnComplete — both fire on every turn including the first turn of a continuation run.

onTurnStart

  • Persist uiMessages (full accumulated history including the new user turn). Two ways, and which one you want depends on who reads the write:
    • Nothing in the turn reads it back (the usual case: the row exists for the next page load). Use chat.deferBeforeOutput(). The write runs alongside the model, so it adds nothing to time to first token, and no part of the answer reaches the frontend until it lands. That bounds “user message is durable before anything can render the answer”.
    • A tool, a prepareStep, or another service reads it back during the turn. await it. chat.deferBeforeOutput orders the write against the frontend, not against the model, so the turn’s own code can still see pre-write state. Awaiting costs time to first token and is the only thing that bounds “durable before the model starts”.
Don’t use chat.defer() for the message write here. chat.defer is fire-and-forget: the hook resolves, the stream starts immediately, and the write is only guaranteed before onTurnComplete. If the user refreshes in between, the next page load reads [] from your DB, the resumed SSE stream pushes the assistant into an empty array, and the user’s message disappears from the rendered conversation.
chat.defer is for writes whose timing doesn’t matter for resume: analytics, audit logs, search-index updates. Anything the next page load reads belongs on chat.deferBeforeOutput.

onTurnComplete

  • Persist uiMessages again with the assistant reply finalized.
  • Upsert session with the fresh chatAccessToken and lastEventId from the event.
lastEventId lets the frontend resume without replaying SSE events it already applied. Treat it as part of session state, not optional polish, if you care about duplicate chunks after refresh.
Write the messages and lastEventId in a single transaction. Both values are read in parallel on the next page load (one fetches the conversation, the other fetches the session). If a refresh races between the two writes, the page can see the assistant message persisted (full history) but a stale lastEventId from the previous turn. The transport then resumes from that stale cursor and replays this turn’s chunks on top of the already-persisted assistant message, producing a duplicated render.

Token renewal (app server)

The persisted PAT has a TTL (see chatAccessTokenTTL on chat.agent, default 1h). When the transport gets a 401 on a session-PAT-authed request, it calls your accessToken callback to mint a fresh PAT — no DB lookup required, since the session is keyed on chatId (which the transport already has). Your accessToken callback typically just wraps auth.createPublicToken:
If you want to keep your DB session row in sync, the transport’s onSessionChange callback fires every time the cached PAT changes — persist the new value there. No Trigger task code needs to run for renewal.

Minimal pseudocode

Alternative: hydrateMessages (deprecated)

For apps that need the backend to be the single source of truth for message history — abuse prevention, branching conversations, or rollback support — the recommended path is a transcript storage with loadContext. The deprecated hydrateMessages hook does the same job without the runtime writing to your store. With hydration, the hook loads messages from your database on every turn. The frontend’s messages are ignored (except for the new user message, which arrives in incomingMessages):
This replaces the onTurnStart persistence pattern — the hook handles both loading and persisting the new message in one place. Hydration composes with Head Start: on a head-start first turn the route handler’s history arrives as incomingMessages, and the write path must be an upsert because no preload ran to create the row.

Design notes

  • chatId is stable for the life of a thread and is the only identifier the transport persists. Runs come and go (idle continuation, upgrade, cancel/restart) but the chat keeps its identity.
  • continuation: true means “same logical chat, new run” — refresh the persisted PAT, don’t assume an empty conversation.
  • The current runId is available on every hook event for telemetry / dashboard linking (“View this run”), but you don’t need to persist it for resume to work — the transport addresses by chatId.
  • Keep task modules that perform writes out of browser bundles; the pattern assumes persistence runs in the worker (or your BFF that the task calls).

Complete example

End-to-end implementation across the three files involved: agent task, server actions, and React component.
The example below trusts raw chatId and returns rows without filtering by user. In a real multi-user app, scope every query by the authenticated user — read the user from your auth/session in each server action and add where: { userId } to all db.chat.* and db.chatSession.* queries. Without that, one client could read or delete another user’s chat state, and getAllSessions() would leak other users’ publicAccessTokens. The snippet keeps auth out of the way to focus on the persistence shape.

See also