API overview

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

Initialization and configuration

Univer supports two integration modes: Preset Mode and Plugin Mode. Preset Mode simplifies setup with preconfigured plugin bundles. If you need deep customization or extensions, we recommend Plugin Mode so you can combine and configure plugins individually.

Browse Packages → Plugins for individual package options. createUniver and Presets remain available for loading predefined plugin bundles.

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.