{/* 本页面由 website/scripts/generate-skill-docs.py 从技能 SKILL.md 自动生成。请编辑源 SKILL.md 而非本页面。 */}

Notion

Notion API + ntn CLI:页面、数据库、Markdown、Workers。

技能元数据

来源内置(默认安装)
路径skills/productivity/notion
版本2.0.0
作者community
许可证MIT
平台linux, macos, windows
标签Notion, Productivity, Notes, Database, API, CLI, Workers

参考:完整 SKILL.md

:::info 以下是此技能被触发时 Hermes 加载的完整技能定义。这是技能激活时代理所看到的指令。 :::

Notion

通过两种方式与 Notion 交互。同一集成令牌两者通用——按可用性选择。

ntn CLI — Notion 官方 CLI。语法更简洁,支持单行文件上传,Workers 必需。截至 2026 年 5 月,仅 macOS + Linux(Windows 支持”即将推出”)。已安装时默认使用。HTTP + curl — 可在包括 Windows 的所有平台使用。未安装 ntn 时的默认回退。

设置

1. 获取集成令牌(两种路径都需要)

  1. https://notion.so/my-integrations 创建集成
  2. 复制 API 密钥(以 ntn_secret_ 开头)
  3. 存储在 ~/.hermes/.env 中:
    NOTION_API_KEY=ntn_your_key_here
    
  4. 在 Notion 中将目标页面/数据库与集成共享:页面菜单 ...Connect to → 你的集成名称。没有此步骤,即使页面存在,API 也会返回 404。

2. 安装 ntn(macOS / Linux 上的首选路径)

# 推荐
curl -fsSL https://ntn.dev | bash
 
# 或通过 npm(需要 Node 22+,npm 10+)
npm install --global ntn
 
ntn --version    # 验证

跳过 ntn login——改用集成令牌。 这种方式可无头运行,无需浏览器:

export NOTION_API_TOKEN=$NOTION_API_KEY      # ntn 读取 NOTION_API_TOKEN
export NOTION_KEYRING=0                       # 不要使用操作系统密钥链

将这些导出添加到你的 shell 配置文件(或 ~/.hermes/.env)中,以便每个会话都继承它们。

3. 运行时选择路径

if command -v ntn >/dev/null 2>&1; then
  # 使用 ntn
else
  # 回退到 curl
fi

Windows 用户:在原生 ntn 发布前完全跳过步骤 2——路径 B 工作正常。如果现在需要 CLI 便利性,请在 WSL2 中安装 ntn

API 基础

所有 HTTP 请求需要 Notion-Version: 2025-09-03ntn 为你处理此头。在此版本中,用户所称的”数据库”在 API 中称为数据源(data sources)

路径 A — ntn CLI(首选,macOS / Linux)

原始 API 调用(curl 的简写)

ntn api v1/users                                  # GET
ntn api v1/pages parent[page_id]=abc123 \         # 带内联请求体的 POST
  properties[title][0][text][content]="Notes"
ntn api v1/pages/abc123 -X PATCH archived:=true   # PATCH;:= 表示非字符串(布尔/数字/null)

语法说明:

  • key=value — 字符串字段
  • key[nested]=value — 嵌套对象字段
  • key:=value — 类型赋值(布尔、数字、null、数组)

搜索

ntn api v1/search query="page title"

读取页面元数据

ntn api v1/pages/{page_id}

以 Markdown 形式读取页面(对代理友好)

ntn api v1/pages/{page_id}/markdown

以块形式读取页面内容

ntn api v1/blocks/{page_id}/children

从 Markdown 创建页面

ntn api v1/pages \
  parent[page_id]=xxx \
  properties[title][0][text][content]="Notes from meeting" \
  markdown="# Agenda
 
- Q3 roadmap
- Hiring"

使用 Markdown 修补页面

ntn api v1/pages/{page_id}/markdown -X PATCH \
  markdown="## Update
 
Shipped the prototype."

查询数据库(数据源)

ntn api v1/data_sources/{data_source_id}/query -X POST \
  filter[property]=Status filter[select][equals]=Active

对于包含 sorts、多个筛选子句或复合逻辑的复杂查询,通过管道传入 JSON:

echo '{"filter": {"property": "Status", "select": {"equals": "Active"}}, "sorts": [{"property": "Date", "direction": "descending"}]}' | \
  ntn api v1/data_sources/{data_source_id}/query -X POST --json -

文件上传(单行命令——最大的 CLI 优势)

ntn files create < photo.png
ntn files create --external-url https://example.com/photo.png
ntn files list

比较一下 HTTP 的 3 步流程(创建上传 → PUT 字节 → 引用)。

有用的环境变量

变量效果
NOTION_API_TOKEN认证令牌(覆盖密钥链)——设置为你的集成令牌
NOTION_KEYRING=0使用 ~/.config/notion/auth.json 的基于文件的凭据,而非操作系统密钥链
NOTION_WORKSPACE_ID跳过工作空间选择器提示

路径 B — HTTP + curl(跨平台,Windows 上默认)

所有请求遵循此模式:

curl -s -X GET "https://api.notion.com/v1/..." \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03" \
  -H "Content-Type: application/json"

Windows 10+ 自带的 curl 可直接使用。PowerShell 用户也可使用 Invoke-RestMethod

搜索

curl -s -X POST "https://api.notion.com/v1/search" \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03" \
  -H "Content-Type: application/json" \
  -d '{"query": "page title"}'

读取页面元数据

curl -s "https://api.notion.com/v1/pages/{page_id}" \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03"

以 Markdown 形式读取页面(对代理友好)

比块 JSON 更容易输入模型。

curl -s "https://api.notion.com/v1/pages/{page_id}/markdown" \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03"

以块形式读取页面内容(需要结构时)

curl -s "https://api.notion.com/v1/blocks/{page_id}/children" \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03"

从 Markdown 创建页面

POST /v1/pages 接受 markdown 请求体参数。

curl -s -X POST "https://api.notion.com/v1/pages" \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03" \
  -H "Content-Type: application/json" \
  -d '{
    "parent": {"page_id": "xxx"},
    "properties": {"title": [{"text": {"content": "Notes from meeting"}}]},
    "markdown": "# Agenda\n\n- Q3 roadmap\n- Hiring\n\n## Decisions\n- Ship MVP Friday"
  }'

使用 Markdown 修补页面

curl -s -X PATCH "https://api.notion.com/v1/pages/{page_id}/markdown" \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03" \
  -H "Content-Type: application/json" \
  -d '{"markdown": "## Update\n\nShipped the prototype."}'

在数据库中创建页面(类型化属性)

curl -s -X POST "https://api.notion.com/v1/pages" \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03" \
  -H "Content-Type: application/json" \
  -d '{
    "parent": {"database_id": "xxx"},
    "properties": {
      "Name": {"title": [{"text": {"content": "New Item"}}]},
      "Status": {"select": {"name": "Todo"}}
    }
  }'

查询数据库(数据源)

curl -s -X POST "https://api.notion.com/v1/data_sources/{data_source_id}/query" \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": {"property": "Status", "select": {"equals": "Active"}},
    "sorts": [{"property": "Date", "direction": "descending"}]
  }'

创建数据库

curl -s -X POST "https://api.notion.com/v1/data_sources" \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03" \
  -H "Content-Type: application/json" \
  -d '{
    "parent": {"page_id": "xxx"},
    "title": [{"text": {"content": "My Database"}}],
    "properties": {
      "Name": {"title": {}},
      "Status": {"select": {"options": [{"name": "Todo"}, {"name": "Done"}]}},
      "Date": {"date": {}}
    }
  }'

更新页面属性

curl -s -X PATCH "https://api.notion.com/v1/pages/{page_id}" \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03" \
  -H "Content-Type: application/json" \
  -d '{"properties": {"Status": {"select": {"name": "Done"}}}}'

向页面追加块

curl -s -X PATCH "https://api.notion.com/v1/blocks/{page_id}/children" \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03" \
  -H "Content-Type: application/json" \
  -d '{
    "children": [
      {"object": "block", "type": "paragraph", "paragraph": {"rich_text": [{"text": {"content": "Hello from Hermes!"}}]}}
    ]
  }'

文件上传(3 步流程)

# 1. 创建上传
curl -s -X POST "https://api.notion.com/v1/file_uploads" \
  -H "Authorization: Bearer ***" \
  -H "Notion-Version: 2025-09-03" \
  -H "Content-Type: application/json" \
  -d '{"filename": "photo.png", "content_type": "image/png"}'
 
# 2. PUT 字节到上面返回的 upload_url
curl -s -X PUT "{upload_url}" --data-binary @photo.png
 
# 3. 在页面/块负载中引用 {file_upload_id}

属性类型

数据库项中常用的属性格式:

  • 标题: {"title": [{"text": {"content": "..."}}]}
  • 富文本: {"rich_text": [{"text": {"content": "..."}}]}
  • 单选: {"select": {"name": "Option"}}
  • 多选: {"multi_select": [{"name": "A"}, {"name": "B"}]}
  • 日期: {"date": {"start": "2026-01-15", "end": "2026-01-16"}}
  • 复选框: {"checkbox": true}
  • 数字: {"number": 42}
  • URL: {"url": "https://..."}
  • 邮箱: {"email": "user@example.com"}
  • 关联: {"relation": [{"id": "page_id"}]}

API 版本 2025-09-03 — 数据库 vs 数据源

  • 数据库变成了数据源。 查询和检索使用 /data_sources/ 端点。
  • 每个数据库有两个 ID: database_iddata_source_id
    • 创建页面时使用 database_idparent: {"database_id": "..."}
    • 查询时使用 data_source_idPOST /v1/data_sources/{id}/query
  • 搜索返回的数据库显示为 "object": "data_source",带有 data_source_id 字段。

Notion Workers(高级功能,需要 ntn

Workers 是 Notion 为你托管的 TypeScript 程序。一个 worker 可以暴露以下任意组合:

  • 同步(Syncs) — 按计划(默认 30 分钟)从外部 API 拉取数据到 Notion 数据库。
  • 工具(Tools) — 在 Notion 的自定义代理中显示为可调用工具。
  • Webhooks — 从外部服务(GitHub、Stripe 等)接收 HTTP 事件并在 Notion 中执行操作。

套餐/平台限制:

  • CLI 适用于所有套餐。部署 Workers 需要 Business 或 Enterprise。
  • 截至 2026 年 5 月,ntn 仅限 macOS/Linux。Windows 用户需要 WSL2 或等待原生支持。
  • 截至 2026 年 8 月 11 日免费;之后按 Notion 积分计量。

最小 Worker

ntn workers new my-worker      # 脚手架
cd my-worker
# 编辑 src/index.ts
ntn workers deploy --name my-worker

src/index.ts

import { Worker } from "@notionhq/workers";
 
const worker = new Worker();
export default worker;
 
worker.tool("greet", {
  title: "Greet a User",
  description: "Returns a friendly greeting",
  inputSchema: { type: "object", properties: { name: { type: "string" } }, required: ["name"] },
  execute: async ({ name }) => `Hello, ${name}!`,
});

Webhook 能力

worker.webhook("onGithubPush", {
  title: "GitHub Push Handler",
  execute: async (events, { notion }) => {
    for (const event of events) {
      // event.body, event.rawBody(用于签名验证), event.headers
      console.log("got delivery", event.deliveryId);
    }
  },
});

部署后:ntn workers webhooks list 显示 Notion 生成的 URL。将该 URL 视为机密——任何人只要拥有它就可以 POST 事件,除非你添加签名验证。

Worker 生命周期命令

ntn workers deploy
ntn workers list
ntn workers exec <capability-key> -d '{"name": "world"}'
ntn workers sync trigger <key>            # 立即运行同步
ntn workers sync pause <key>
ntn workers env set GITHUB_WEBHOOK_SECRET=...
ntn workers runs list                     # 最近的调用
ntn workers runs logs <run-id>
ntn workers webhooks list

当被要求构建 Worker 时,使用 ntn workers new 搭建脚手架,在 src/index.ts 中编写代码,使用 ntn workers env set 设置任何密钥,然后部署。Notion 的文档位于 https://developers.notion.com/workers 涵盖完整 API 表面。

Notion 风格的 Markdown(由 /markdown 端点使用)

标准 CommonMark 加上用于 Notion 特定块的 XML 风格标签。使用制表符进行缩进。

CommonMark 之外的块:

<callout icon="🎯" color="blue_bg">
	Ship the MVP by **Friday**.
</callout>

<details color="gray">
<summary>Toggle title</summary>
	Children indented one tab
</details>

<columns>
	<column>Left side</column>
	<column>Right side</column>
</columns>

<table_of_contents color="gray"/>

内联:

  • 提及:<mention-user url="..."/><mention-page url="...">Title</mention-page><mention-date start="2026-05-15"/>
  • 下划线:<span underline="true">text</span>
  • 颜色:<span color="blue">text</span> 或块级在第一行使用 {color="blue"}
  • 数学:内联 $x^2$,块级 $$ ... $$
  • 引用:[^https://example.com]

颜色: gray brown orange yellow green blue purple pink red,加上用于背景的 *_bg 变体。

标题 5/6 折叠为 H4。多个 > 行渲染为单独的引用块——在单个 > 内部使用 <br> 实现多行引用。

选择正确路径

任务Mac / LinuxWindows
读写页面、搜索、查询数据库ntn api ...curl
读取页面供代理总结ntn api v1/pages/{id}/markdowncurl /markdown 端点
上传文件ntn files create < file3 步 HTTP 流程
一次性 API 探索ntn api ...curl
构建由 Notion 托管的同步/webhook/代理工具ntn workers ...WSL2 + ntn workers ...

注意

  • 页面/数据库 ID 是 UUID(带或不带短划线——两者均可接受)。
  • 速率限制:平均约 3 请求/秒。CLI 不会绕过此限制。
  • API 无法设置数据库视图筛选器——那是 UI 专属功能。
  • 创建数据源时使用 "is_inline": true 将其嵌入页面。
  • 始终向 curl 传递 -s 以抑制进度条(更干净的代理输出)。
  • 读取时通过 jq 管道输出 JSON:... | jq '.results[0].properties'
  • Notion 现在也提供了 MCP 服务器(Notion MCP,在数据库操作上比之前版本节省约 91% 的令牌)——通过 Hermes 的 MCP 支持进行连接,以便在会话中获得流式 Notion 访问,但上述路径对于大多数一次性任务已足够。