Introduction

Assistant Cloud persists conversations, reports every run, records what users do, and gives you a dashboard over threads, runs, models, users and engagement.

Assistant Cloud is the hosted backend for assistant-ui apps. The runtime in your app talks to it directly: threads and messages are stored as the conversation streams, every assistant response is reported with its timing, tokens, tools and outcome, and what users do around the answers is recorded as events. Your server adds the inside view by exporting its model and tool spans. The dashboard turns all of it into pages you can read, and this book describes every one of those pages, every setting behind them, and every call the SDK makes.

What you get

CapabilityWhat it meansWhere it is described
PersistenceThreads and messages, stored as they stream, resumed across sessions and devices, listed per user, archived and deletedThreads, Messages
TitlesA model names each conversation from its first messageThread titles
Run reportsStatus, outcome, error, duration, time to first token, steps, tool calls, tokens, model, provider and cost for every responseRun reports
TracesAn OpenTelemetry receiver that joins your server's spans to the browser's reportTraces
EngagementSends, stops, edits, regenerations, copies and more, recorded without message text, plus thumbs and the scores your own code writesEngagement events, Feedback and scores
IntelligenceTopics, tasks, unanswered questions, sentiment and resolution, judged by a model of your choiceIntelligence, Evaluators
The dashboardOverview, Threads, Runs, Models, Users, Engagement and Intelligence over any range, with alerts, exports and an audit logUsing the dashboard

How it fits together

threads, messages, run reports, events spans, scores, tokens your appassistant-ui runtime + assistant-cloud frontend APIproj-<id>.assistant-api.com your server backend APIbackend.assistant-api.com project dashboardcloud.assistant-ui.com

A project has two hosts. The frontend API answers the browser with an anonymous session or a token from your auth provider; the backend API answers your server with an API key: minting tokens, receiving traces, writing scores, reading the project. The assistant-cloud package is the client for both, and the assistant-ui runtimes drive it for you. Concepts names every object once, and Authentication follows a request through the API.

Pick your integration

You useThe cloud addsGuide
The AI SDK through useChatRuntime, including Mastra agentsThread list, persistence, titles, run reports, engagement, feedback, attachmentsAI SDK
Your own backend through useLocalRuntime or useDataStreamRuntimeThe same, over any chat model adapterLocal runtime
LangGraph, LangChain or Google ADKThread list, copied settled messages, feedback and engagement; the backend remains the transcript source, and telemetry: { messages: false } keeps copies outLangGraph, LangChain and ADK
AG-UI or A2AEverything, by composing the thread list yourselfCustom thread list
A server without a browser: a bot, an agent, a batch jobThreads, messages, titles and run reports through the client with an API keyServers and bots
A backend in another language, or a framework with OpenTelemetryRuns, steps, tool calls and models from exported spans, or the REST API directlyTraces, REST API
The Cloud AI SDK, useCloudChatNothing new: the package is retired and the runtime replaces itMigrate from Cloud AI SDK

Which runtime is the full matrix of what each integration stores and reports. The runtime guides work on React, React Native and Ink: the packages are the same, only the environment differs.

How the book is organised

SectionWhat it holds
Authentication and accessThe three ways a client proves who it is, the rules a project enforces, and who the user and the workspace are
ConversationsThreads, messages and their formats, titles, attachments and retention
IntegrationsOne guide per runtime, servers and bots, and the migration from the Cloud AI SDK
TelemetryRun reports field by field, traces and the receiver's rules, engagement events, feedback and scores
Cloud featuresThe features the cloud runs on your conversations with a model: providers, intelligence, evaluators, assistants and harnesses
DashboardEvery page of the dashboard with every figure defined
SettingsEvery settings page, who may change it, alerts, the audit log and billing
ReferenceThe REST API route by route, the client, the stored formats and every limit

Every page follows the same order: what the feature is, how it works, every control with its default and bound, the calls from your code, what it costs, and a troubleshooting table of what you see, why, and what to do.

Where to start

The demo project is open without an account: a retailer's synthetic support assistant that gains an hour of conversations every hour, with every page of the dashboard read only. The screenshots in this book were taken there.

Upgrading from 0.1

@assistant-ui/core requires assistant-cloud@^0.2.1, so update assistant-cloud, @assistant-ui/react and your integration package together. Then:

  • Add the messageMetadata callback to your route; see Run reports. Without it runs show as No model reported and cannot be priced.
  • Pass telemetry: { environment, release } to AssistantCloud so runs can be filtered by deployment. Engagement events are on by default; see Turning telemetry off.
  • If your server emits OpenTelemetry spans, add the span processor from Traces.
  • Review Settings › Access: anonymous sessions and allowed origins are settings, and both default to open.
  • If you use @assistant-ui/cloud-ai-sdk, plan the move: the package is retired; see Migrate from Cloud AI SDK.