getnote-kb

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

getnote-kb Skill

getnote-kb 技能

Manage knowledge bases — list, create, browse notes, add/remove notes. Also supports subscribed knowledge bases, blogger content, live sessions, and quota.

管理知识库——支持列出、创建、浏览笔记、添加/移除笔记。同时也支持订阅知识库、博主内容、直播会话和配额查询。

Prerequisites

前置条件

```
getnote
```
CLI installed and authenticated (
```
getnote auth status
```
should show "Authenticated")

```
getnote
```
CLI 已安装并完成认证（执行
```
getnote auth status
```
应返回“Authenticated”）

Commands

命令

List all knowledge bases

列出所有知识库

getnote kbs

Returns all knowledge bases. Each item includes:

topic_id

name

description

note_count

created_at

bash

getnote kbs
getnote kbs -o json

getnote kbs

返回所有知识库，每条记录包含：

topic_id

、

name

、

description

、

note_count

、

created_at

。

bash

getnote kbs
getnote kbs -o json

List subscribed knowledge bases

列出已订阅的知识库

getnote kbs-sub [--page <n>]

Returns knowledge bases the user has subscribed to. Supports pagination.

Flag	Default	Description
`--page`	1	Page number

bash

getnote kbs-sub
getnote kbs-sub --page 2
getnote kbs-sub -o json

Use
getnote kb <topic_id>
to browse notes inside a subscribed knowledge base.

getnote kbs-sub [--page <n>]

返回用户已订阅的知识库，支持分页。

参数	默认值	描述
`--page`	1	页码

bash

getnote kbs-sub
getnote kbs-sub --page 2
getnote kbs-sub -o json

可使用
getnote kb <topic_id>
浏览已订阅知识库内的笔记。

List notes in a knowledge base

列出知识库内的笔记

getnote kb <topic_id> [--limit <n>] [--all]

Returns 20 notes per page by default.

Flag	Default	Description
`--limit`	20	Notes per page
`--all`	—	Fetch all notes (auto-paginate)

bash

getnote kb vnrOAaGY
getnote kb vnrOAaGY --all
getnote kb vnrOAaGY -o json

getnote kb <topic_id> [--limit <n>] [--all]

默认每页返回20条笔记。

参数	默认值	描述
`--limit`	20	每页笔记数量
`--all`	—	获取所有笔记（自动分页）

bash

getnote kb vnrOAaGY
getnote kb vnrOAaGY --all
getnote kb vnrOAaGY -o json

Create a knowledge base

创建知识库

getnote kb create <name> [--desc <description>]

bash

getnote kb create "Research Papers"
getnote kb create "Project Docs" --desc "Documentation links"

Max 50 knowledge bases per day (resets at 00:00 Beijing time).

getnote kb create <name> [--desc <description>]

bash

getnote kb create "Research Papers"
getnote kb create "Project Docs" --desc "Documentation links"

每日最多可创建50个知识库（北京时间00:00重置）。

Add notes to a knowledge base

向知识库添加笔记

getnote kb add <topic_id> <note_id> [note_id...]

Supports multiple note IDs. Max 20 per call.

bash

getnote kb add vnrOAaGY 1234567890
getnote kb add vnrOAaGY 1234567890 9876543210

Already-existing notes are silently skipped.

getnote kb add <topic_id> <note_id> [note_id...]

支持传入多个笔记ID，单次调用最多添加20个。

bash

getnote kb add vnrOAaGY 1234567890
getnote kb add vnrOAaGY 1234567890 9876543210

已存在的笔记会被静默跳过。

Remove notes from a knowledge base

从知识库移除笔记

getnote kb remove <topic_id> <note_id> [note_id...]

bash

getnote kb remove vnrOAaGY 1234567890

⚠️ 订阅知识库限制：如果目标知识库是他人创建（通过
getnote kbs-sub
获取），且用户不是该知识库的管理员，则无法添加或移除笔记，API 会返回错误。只有自己创建的知识库（
getnote kbs
）才支持完整的增删操作。

getnote kb remove <topic_id> <note_id> [note_id...]

bash

getnote kb remove vnrOAaGY 1234567890

⚠️ 订阅知识库限制：如果目标知识库是他人创建（通过
getnote kbs-sub
获取），且用户不是该知识库的管理员，则无法添加或移除笔记，API 会返回错误。只有自己创建的知识库（
getnote kbs
）才支持完整的增删操作。

List bloggers in a knowledge base

列出知识库内的博主

getnote kb bloggers <topic_id> [--page <n>]

Returns subscribed bloggers. Each item includes:

follow_id

(required for content queries),

account_name

platform

follow_time

bash

getnote kb bloggers vnrOAaGY
getnote kb bloggers vnrOAaGY --page 2 -o json

getnote kb bloggers <topic_id> [--page <n>]

返回已订阅的博主，每条记录包含：

follow_id

（内容查询必填）、

account_name

、

platform

、

follow_time

。

bash

getnote kb bloggers vnrOAaGY
getnote kb bloggers vnrOAaGY --page 2 -o json

List blogger contents

列出博主内容

getnote kb blogger-contents <topic_id> <follow_id> [--page <n>]

Returns content list (no full text). Use

post_id_alias

to fetch detail.

bash

getnote kb blogger-contents vnrOAaGY follow123
getnote kb blogger-contents vnrOAaGY follow123 --page 2

getnote kb blogger-contents <topic_id> <follow_id> [--page <n>]

返回内容列表（不含全文），可使用

post_id_alias

获取详情。

bash

getnote kb blogger-contents vnrOAaGY follow123
getnote kb blogger-contents vnrOAaGY follow123 --page 2

Show blogger content detail

查看博主内容详情

getnote kb blogger-content <topic_id> <post_id>

Returns full content including original text (

post_media_text

bash

getnote kb blogger-content vnrOAaGY post_abc123
getnote kb blogger-content vnrOAaGY post_abc123 -o json

getnote kb blogger-content <topic_id> <post_id>

返回完整内容，包括原文(

post_media_text

)。

bash

getnote kb blogger-content vnrOAaGY post_abc123
getnote kb blogger-content vnrOAaGY post_abc123 -o json

List completed lives in a knowledge base

列出知识库内的已完成直播

getnote kb lives <topic_id> [--page <n>]

Returns only completed live sessions that have been AI-processed.

bash

getnote kb lives vnrOAaGY
getnote kb lives vnrOAaGY --page 2

getnote kb lives <topic_id> [--page <n>]

仅返回已完成且经过AI处理的直播会话。

bash

getnote kb lives vnrOAaGY
getnote kb lives vnrOAaGY --page 2

Show live detail

查看直播详情

getnote kb live <topic_id> <live_id>

Returns AI summary (

post_summary

) and full transcript (

post_media_text

bash

getnote kb live vnrOAaGY live_abc123
getnote kb live vnrOAaGY live_abc123 -o json

getnote kb live <topic_id> <live_id>

返回AI摘要(

post_summary

)和完整转录文本(

post_media_text

)。

bash

getnote kb live vnrOAaGY live_abc123
getnote kb live vnrOAaGY live_abc123 -o json

Show API quota usage

查看API配额使用情况

getnote quota

bash

getnote quota
getnote quota -o json

getnote quota

bash

getnote quota
getnote quota -o json

Agent Usage Notes

Agent使用注意事项

Use
```
-o json
```
when parsing results programmatically.

kbs -o json

returns

{"success":true,"data":{"topics":[...],"total":N}}

```
kbs-sub -o json
```
returns the same shape as
```
kbs -o json
```
.

kb <topic_id> -o json

returns

{"success":true,"data":{"notes":[...],"has_more":...}}

Get

topic_id

from

getnote kbs -o json

getnote kbs-sub -o json

→

data.topics[].topic_id

field (not

id

```
kb add
```
/
```
kb remove
```
accept multiple note IDs — prefer batching over multiple calls.
Subscribed KBs are read-only unless the user is an admin of that KB.
```
kb add
```
/
```
kb remove
```
will return an API error on subscribed KBs owned by others. Use
```
getnote kbs
```
(owned) vs
```
getnote kbs-sub
```
(subscribed) to distinguish.

kb bloggers

→ get

follow_id

→

kb blogger-contents

→ get

post_id_alias

→

kb blogger-content

for full text.

```
kb lives
```
→ get
```
live_id
```
→
```
kb live
```
for AI summary + transcript.

quota -o json

returns

{"success":true,"data":{"read":{"daily":{limit,used,remaining,reset_at},"monthly":{...}},"write":{...},"write_note":{...}}}

Exit code
```
0
```
= success; non-zero = error. Error details go to stderr.

通过程序解析结果时请使用
```
-o json
```
参数。

kbs -o json

返回格式为

{"success":true,"data":{"topics":[...],"total":N}}

```
kbs-sub -o json
```
返回格式与
```
kbs -o json
```
一致。

kb <topic_id> -o json

返回格式为

{"success":true,"data":{"notes":[...],"has_more":...}}

可通过

getnote kbs -o json

或

getnote kbs-sub -o json

的

data.topics[].topic_id

字段获取

topic_id

（注意不是

id

字段）。

```
kb add
```
/
```
kb remove
```
支持传入多个笔记ID——优先批量调用而非多次单独调用。
订阅的知识库为只读权限，除非你是该知识库的管理员。对他人所有的订阅知识库执行
```
kb add
```
/
```
kb remove
```
会返回API错误。可通过
```
getnote kbs
```
（自有）和
```
getnote kbs-sub
```
（订阅）区分知识库类型。

调用流程：

kb bloggers

→ 获取

follow_id

→ 调用

kb blogger-contents

→ 获取

post_id_alias

→ 调用

kb blogger-content

获取全文。

调用流程：
```
kb lives
```
→ 获取
```
live_id
```
→ 调用
```
kb live
```
获取AI摘要+转录文本。

quota -o json

返回格式为

{"success":true,"data":{"read":{"daily":{limit,used,remaining,reset_at},"monthly":{...}},"write":{...},"write_note":{...}}}

退出码
```
0
```
表示成功；非0表示出错，错误详情输出到stderr。