# Office Copilot

> Build your own Office copilot with a collaborative web app, native editors, and bring-your-own-key AI.

- Human documentation: [https://docs.univer.ai/overview/examples/copilot](https://docs.univer.ai/overview/examples/copilot)

- Agent Markdown: [https://docs.univer.ai/overview/examples/copilot.md](https://docs.univer.ai/overview/examples/copilot.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.4.0`

- Source: [examples/copilot.mdx](https://github.com/dream-num/documentation/blob/dev/content/docs/examples/copilot.mdx)

---

**Univer Office Copilot** is an open-source reference web app built with **[Univer Office SDK](https://docs.univer.ai/overview.md)**, LangChain, React, and TypeScript. It places editable spreadsheets, documents, slides, relational tables, and canvases beside a conversation assistant. Use the runnable code sample to build your own Office copilot.

[Run locally](#quick-start) · [Editable examples](https://github.com/dream-num/univer-office-copilot#included-examples) · [Source repository](https://github.com/dream-num/univer-office-copilot)

![An editable financial workbook beside the Copilot conversation, with six example files in the workspace](https://raw.githubusercontent.com/dream-num/documentation/dev/public/assets/examples/office-copilot/overview.webp)

## What you can build

| Product | Applications to build |
| --- | --- |
| Sheets | Financial models, scenario analysis, formulas, and charts. |
| Docs | Research reports and memos in Modern or Paged Docs. |
| Slides | Editable investor decks and project presentations. |
| Base | Linked records, operations trackers, and live dashboards. |
| Board | Decision maps, workflows, and connected diagrams. |

## Run the reference app locally

Use **Node.js 24+** and **pnpm 10.33.4**:

```bash
git clone https://github.com/dream-num/univer-office-copilot.git
cd univer-office-copilot
pnpm install --frozen-lockfile
pnpm dev
```

Open [http://127.0.0.1:5173](http://127.0.0.1:5173). A new local demo account receives six private, editable examples covering all five products and both document modes. Browsing and manual editing require no model key, Docker, or external database.

To use Copilot, open the model menu in chat and choose **Add model** or **Manage models**. Configure your provider, model ID, and API key. The app supports OpenAI, Anthropic, Google Gemini, DeepSeek, OpenRouter, and custom OpenAI-compatible HTTPS endpoints. Choose **Ask** to inspect a file or **Edit** to change the current file directly.

AI text measurement and rendered checks require local Chrome, Chromium, or Edge. See the [local development guide](https://github.com/dream-num/univer-office-copilot/blob/main/docs/local-development.md) for model configuration, attachments, import/export, and browser setup.

> [!INFO]
> The application source is Apache-2.0. Embedded Univer Pro features have separate SDK licensing terms; the app does not grant a Pro license. See [SDK licensing](https://github.com/dream-num/univer-office-copilot/blob/main/docs/local-development.md#univer-licensing).

## How Office SDK powers it

The React workspace provides the editors and chat interface. The Node backend runs the LangChain tool loop, product Skills, and bounded editing scripts against a headless Univer client. Confirmed edits reach the browser through the same collaboration channel used by people; native readback and rendered checks provide verification feedback.

Modern Docs use Markdown, Paged Docs use Typst, and Slides use SVG compiled into editable elements. The app also includes multiple conversations per file, attachment context, per-turn change inspection, native file history, owner-controlled restore, and separate file/conversation sharing.

Build on the [architecture](https://github.com/dream-num/univer-office-copilot/blob/main/docs/architecture.md) and [extension guide](https://github.com/dream-num/univer-office-copilot/blob/main/docs/extending.md), or explore the underlying [content operations](https://docs.univer.ai/ai/content-operations.md), [collaboration](https://docs.univer.ai/overview/features/shared/collaboration.md), and [history](https://docs.univer.ai/overview/features/shared/history.md) capabilities.

[All examples](https://docs.univer.ai/overview/examples.md)