Office SDK overview

Learn about the three parts of Office SDK: Web SDK, Server SDK, and AI SDK, and how they work together in an Office application.

Univer Office SDK consists of three parts: Web SDK, Server SDK, and AI SDK. It covers spreadsheets, documents, slides, Relational Table, Canvases, and PDFs.

Web SDK is the shared content engine. It runs the browser editors and also runs headless to process content without a UI. The other two SDKs build on that headless runtime: Server SDK adds collaboration and file processing, and AI SDK adds content operations and result inspection for agents.

Explore features

The feature catalog lists what each product supports, grouped by product and category. It also records the support level, whether a feature is open source, and the scope of the integration. Charts, file conversion, collaboration, Worktree, and embedding are shared across products.

Get started provides one requirements template and three runnable examples, then explains how to connect, build, and deploy an application.

SDK architecture and responsibilities

Web SDK: the shared content engine

Use Web SDK to display, edit, or process Office content in an application. Facade APIs are the interface to content, data, and UI, whether the code runs in a browser editor or in a headless Node.js process.

Web SDK is built entirely from plugins, including product capabilities, editor UI, and individual features such as find and replace. An application can start from a preset, or select the product and feature plugins it needs and assemble them with their dependencies.

Business-specific features can be implemented in custom plugins without modifying Univer's core code. The same content engine adapts to each environment through its plugin set: a browser application loads the editor UI, while a headless application omits those UI plugins. See Univer Architecture: plugin design.

Shared Canvas rendering. All Office content renders through the same Canvas architecture, so content types can reuse the layout and drawing code and can hold nested content. Spreadsheet cell text, for example, follows the document layout and rendering path, which keeps the presentation consistent. See Architecture of Rendering Engine.

Hybrid computation. The formula engine calculates in the frontend and on a server-side Rust engine. Frontend calculation keeps editing responsive, while the Rust engine handles large formula workloads. See formula capabilities and server-side calculation.

Start with spreadsheets. The same SDK also covers documents, slides, relational tables, boards, and PDFs.

Server SDK: connect collaboration and files

Server SDK adds shared editing, file conversion, and backend extensions. It builds on the headless content capabilities of Web SDK: the modules run inside your own backend and use the application's own identity, permissions, and storage.

Real-time collaboration. OT (Operational Transformation) handles concurrent operations such as row or column changes and content edits. An edit applies locally first, and the replicas then converge while preserving each user's intent where possible. History, comments, and Worktree are separate modules that an application adds when needed. See collaborative editing design and the collaboration quick start.

File conversion. Conversion moves content between Office files and Univer document data and connects the import, edit, and export steps. It works with or without collaboration. See Office file import and export for the conversion APIs and file exchange integration for uploads, tasks, and downloads.

Deployment and scaling. The modules are assembled inside your own Node.js application, and a single machine is sufficient to start. As load grows, the application can move file conversion to a separate service and then scale to multiple collaboration nodes. See application architecture and the deployment guide.

The Server SDK overview describes the modules in more detail.

AI SDK: give agents an entry point

AI SDK adds Office capabilities to existing agents, automation, and application-specific CLIs. It builds on the headless runtime and Facade APIs of Web SDK for content operations, calculation, and inspection.

Connect your existing agent stack. Office tools can be exposed as TypeScript APIs or as a CLI assembled from the SDK. Model selection, task orchestration, and Skills stay in the application. Agents receive execution results and inspection feedback, then continue their workflow.

Create content that stays editable. An agent reads the document structure, locates the range or paragraph it needs, and uses Facade APIs to create and modify spreadsheets, documents, slides, and other content, including formula calculation. The result keeps its content structure and remains editable, so people can continue refining it. See content operations.

Inspect, then revise. The agent reads back values and formula results and inspects a screenshot of the actual page. For slides, layout checks also identify text that runs off the page, overflows, or overlaps. The agent uses this feedback to revise the content and verify it again, which completes the read → edit and calculate → inspect → revise loop. See visual inspection.

With Server SDK, Worktree isolates intermediate changes made by an agent until a person reviews and merges them in the Web application. Start with the AI SDK overview.

Application workflow

100%
  • Embedded editor: Web SDK displays and edits content inside an application.
  • Collaborative application: Web SDK and Server SDK together let users edit shared documents.
  • Human and agent collaboration: agents edit and verify drafts through AI SDK, Server SDK manages versions and merging, and the Web application provides viewing, comparison, and human review. The complete review workflow involves all three.

Shared foundation and dependencies

Web SDK runs independently, as an editor or as a headless content engine. Server SDK and AI SDK both depend on the headless capabilities of Web SDK: running without a browser UI still requires the content runtime. An application enables the services and modules it needs, and a complete human–agent workflow typically combines all three SDKs.

Start with your use case

I want toStart here
Embed a spreadsheet editorWeb SDK quick start
Choose another Office editorDocuments, slides, relational tables, boards, or PDFs
Let multiple users edit the same documentCollaboration quick start
Import or export Office filesServer SDK file conversion
Operate documents through an agent or CLIAI SDK overview
Review an agent's changes to a shared documentAI SDK Worktree

Next steps

Start with the Web SDK content runtime. Server SDK and AI SDK complete the first application workflow, and additional modules can be added as needed. Keep related Univer package versions aligned, and prepare the environment, authorization, and licenses that the chosen modules require.

Examples collects open-source applications, agent integrations, demos, and repositories. You can also try the Office products in the online showcase.

How is this guide?

© 2026 DreamNum Co., Ltd.