Skip to main content
Every page shared with the integration becomes a folder with a page.json (metadata, the body as Markdown, and raw blocks) and a folder per child page. Databases become their data sources, each with its schema and rows.

Setup

Create an internal connection, give it Read content, share the pages to mount with it, and export its API token:
  1. As a workspace owner, open the Developer portal, select Internal connections under Build, and click Create a new connection. Name it (for example mirage) and pick the workspace.
  2. On the Configuration tab, turn on the read content capability. The update and insert content capabilities are only for writes through the ntn CLI.
  3. Copy the API token from the same tab (it starts with ntn_).
  4. The connection reaches no page until one is shared with it. Either open the Content access tab, click Edit access and pick pages and databases, or open a page in Notion, click •••, Connections, Add connection, and pick the connection.
  5. Child pages inherit access, so sharing a top-level page exposes its whole subtree.
A personal access token from notion.so/developers/tokens with the Notion API capability also works. It acts with its creator’s permissions and needs no sharing step.

Connect

workspace.yaml

Layout

  • Titles are sanitized and end in __<id>; ls the parent instead of building a path.
  • rows.jsonl holds one row per line, each with path to its page.json. Row folders are not listed; open one by that path.
  • database.json lists the database’s data sources; data_source.json holds the property schema.

Sample runs

The mount is read-only. Create and edit pages with the ntn CLI, which takes the same token.

SDK guides

Python

Every config field, the VFS.md and write support.

TypeScript

Every config field, the VFS.md and write support.