# API 概览

> 查找 API、配置功能包，开始使用 Univer Office SDK。

- Human documentation: [https://docs.univer.ai/zh-CN/reference](https://docs.univer.ai/zh-CN/reference)

- Agent Markdown: [https://docs.univer.ai/zh-CN/reference.md](https://docs.univer.ai/zh-CN/reference.md)

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

- Source: [index.zh-CN.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/index.zh-CN.mdx)

---

通过 Facade API 在应用中读取和修改 Office 内容。你可以按产品查找接口，也可以从下方的初始化与插件配置入口开始。

## 试用 API

先完成[安装和基本使用](https://docs.univer.ai/zh-CN/guides/sheets/getting-started/installation.md)。初始化 Sheets 编辑器并拿到 `createUniver` 返回的 `univerAPI` 后，下面的代码会向 A1 单元格写入内容：

```ts
const workbook = univerAPI.getActiveWorkbook()
const worksheet = workbook?.getActiveSheet()
worksheet?.getRange('A1').setValue('Hello, Univer!')
```

`univerAPI` 是 `FUniver` 实例。在 Sheets 中，从工作簿进入工作表，再取得单元格范围。插件模式的初始化方式与功能包的 Facade 导入方式，见 [Facade API 基础](https://docs.univer.ai/zh-CN/guides/sheets/getting-started/facade.md)。

## 按用途查找

| 用途           | 参考文档                                                                                                                    |
| ------------ | ----------------------------------------------------------------------------------------------------------------------- |
| 实例、生命周期与通用操作 | [FUniver](https://docs.univer.ai/zh-CN/reference/facade/univer.md)                                                                                     |
| 工作簿、工作表与单元格  | [FWorkbook](https://docs.univer.ai/zh-CN/reference/facade/workbook.md) · [FWorksheet](https://docs.univer.ai/zh-CN/reference/facade/worksheet.md) · [FRange](https://docs.univer.ai/zh-CN/reference/facade/range.md) |
| 文档与文本        | [FDocument](https://docs.univer.ai/zh-CN/reference/facade/document.md)                                                                                 |
| 演示文稿         | [Slides](https://docs.univer.ai/zh-CN/reference/facade/slides.md)                                                                                      |
| 画板           | [Boards](https://docs.univer.ai/zh-CN/reference/facade/boards.md)                                                                                      |
| 多维表格         | [Bases](https://docs.univer.ai/zh-CN/reference/facade/bases.md)                                                                                        |
| PDF 内容       | [PDF](https://docs.univer.ai/zh-CN/reference/facade/pdf.md)                                                                                            |
| 事件           | [Events](https://docs.univer.ai/zh-CN/reference/facade/events.md)                                                                                      |
| 协同编辑         | [Collaboration](https://docs.univer.ai/zh-CN/reference/facade/collaboration.md)                                                                        |
| 评论           | [Comments](https://docs.univer.ai/zh-CN/reference/facade/thread-comment.md)                                                                            |

## 初始化与配置

使用预设时，从 [createUniver](https://docs.univer.ai/zh-CN/reference/methods/create-univer.md) 开始；直接注册插件时，查看 [Univer](https://docs.univer.ai/zh-CN/reference/classes/univer.md)。`Univer` 实例负责管理插件和文档单元，`univerAPI` 提供面向应用的内容操作接口。

基础配置可从 [Sheets Core](https://docs.univer.ai/zh-CN/reference/packages/presets/univerjs/preset-sheets-core.md) 或 [Docs Core](https://docs.univer.ai/zh-CN/reference/packages/presets/univerjs/preset-docs-core.md) 开始。侧边栏 **Packages → Presets / Plugins** 列出了各功能包的配置。使用功能 API 前，需要注册对应插件；插件模式下，还应按功能指南导入相应的 Facade 入口。

## 服务端与 AI 集成

后端协同与文件转换请从 [Server SDK](https://docs.univer.ai/zh-CN/server.md) 开始；CLI 工作流与 AI Agent 内容操作请从 [AI SDK](https://docs.univer.ai/zh-CN/ai.md) 开始。