API overview
Find APIs, configure packages, and start using Univer Office SDK.
Use the Facade API to read and update Office content in your application. Start with a product below, or look up initialization and plugin configuration further down.
Try the API
First complete installation and basic usage. With the Sheets editor initialized and univerAPI returned by createUniver, this example writes to cell A1:
const workbook = univerAPI.getActiveWorkbook()const worksheet = workbook?.getActiveSheet()worksheet?.getRange('A1').setValue('Hello, Univer!')univerAPI is an FUniver instance. In Sheets, navigate from the workbook to a worksheet and then a range. See Facade API basics for Plugin Mode initialization and feature-specific Facade imports.
Find an API
| Task | Reference |
|---|---|
| Instances, lifecycle, and shared operations | FUniver |
| Workbooks, worksheets, and cells | FWorkbook · FWorksheet · FRange |
| Documents and text | FDocument |
| Presentations | Slides |
| Whiteboards | Boards |
| Databases | Bases |
| PDF content | |
| Events | Events |
| Collaboration | Collaboration |
| Comments | Comments |
Initialization and configuration
Use createUniver with presets, or Univer when registering plugins directly. The Univer instance manages plugins and units; univerAPI exposes application-facing content operations.
Configure Sheets Core or Docs Core to start. Browse Packages → Presets / Plugins in the sidebar for individual package options. Feature APIs require the corresponding plugins to be registered; in Plugin Mode, also import the package’s Facade entry when the feature guide specifies one.
Server and AI integration
For backend collaboration and file conversion, start with Server SDK. For CLI workflows and AI Agent content operations, start with AI SDK.
How is this guide?