# Univer Boards API

> Learn how to use Facade API in a Univer Boards application.

- Human documentation: [https://docs.univer.ai/guides/boards/features/core/boards-api](https://docs.univer.ai/guides/boards/features/core/boards-api)

- Agent Markdown: [https://docs.univer.ai/guides/boards/features/core/boards-api.md](https://docs.univer.ai/guides/boards/features/core/boards-api.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [boards/features/core/boards-api.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/boards/features/core/boards-api.mdx)

---

Facade API provides an application-facing layer over Univer services and unit models. Use it for common Board operations such as creating boards, reading active pages, adding elements, updating containers, and managing swimlanes.

> [!WARNING: Caution]
> Board mutations are synchronous and return `boolean` or a nullable handle. Check the return value before reading the result.

## Enable the facade entry

Boards is distributed as Web SDK plugins. Import the facade entry for the Board capability used by your application:

```ts
import { FUniver } from '@univerjs/core/facade'
import '@univerjs-pro/boards/facade'
```

Create the API object after the Univer instance and required plugins are registered:

```ts
const univerAPI = FUniver.newAPI(univer)
```

## Create and read a board

Use `createBoard` to create a Board unit through the facade layer. In lower-level setup code, create the unit with `univer.createUnit(UniverInstanceType.UNIVER_BOARD, snapshot)`.

```ts
const board = univerAPI.createBoard({
  id: 'board-demo',
  name: 'Board Demo',
})

const activeBoard = univerAPI.getActiveBoard()
const sameBoard = univerAPI.getBoard(board.getId())
```

## Continue with core features

The returned `FBoard` object is the entry point for the active page and its content. Continue with the focused guides for detailed operations:

* [Elements](https://docs.univer.ai/guides/boards/features/core/elements.md) covers reading, inserting, connecting, transforming, arranging, and removing Board elements.
* [Containers & Swimlanes](https://docs.univer.ai/guides/boards/features/core/containers.md) covers framed groups, membership, and swimlane structure.

## Reference

* [General API](https://docs.univer.ai/guides/boards/features/core/general-api.md)
* [Boards facade reference](https://docs.univer.ai/reference/facade/boards.md)
* [Board data model](https://docs.univer.ai/guides/boards/model/board-data.md)
* [Board Elements](https://docs.univer.ai/guides/boards/model/board-elements.md)