开放 API
PRO 及以上会员可以用访问令牌调用 Insighto 的 REST API,把写笔记这件事接进你自己的脚本、快捷指令或自动化流程里——一条 curl 就能记一条笔记。
第一步:获取访问令牌
API 用访问令牌(Access Token)认证,在设置里生成:
- 打开「设置 → 访问令牌」。
- 点「创建密钥」,填一个描述(方便你日后分辨这个令牌用在哪),选有效期(默认 30 天,也可选永不过期)。
- 创建后立即复制——令牌只会完整显示这一次,关闭后无法再次查看。
- 把令牌妥善保存在你的脚本或密钥管理工具里。
第二步:带上令牌认证
所有请求都通过 HTTP 头带上令牌,API 域名为 api.insighto.com.cn:
Authorization: Bearer <你的访问令牌>
创建一条笔记
向 /api/v1/memos 发一个 POST,请求体就是笔记本身,content 是正文,visibility 目前仅支持 PRIVATE(私有):
curl -X POST https://api.insighto.com.cn/api/v1/memos \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"content":"想到就记 #insighto","visibility":"PRIVATE"}'获取笔记列表
用 GET 拉取自己的笔记:
curl https://api.insighto.com.cn/api/v1/memos \ -H "Authorization: Bearer $TOKEN"
常用端点
下面这些覆盖了绝大多数集成场景。路径里的 {id} 换成具体笔记 ID(列表接口返回的 name 形如 memos/123):
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /api/v1/memos | 创建笔记 |
| GET | /api/v1/memos | 获取笔记列表 |
| GET | /api/v1/memos/{id} | 获取单条笔记 |
| PATCH | /api/v1/memos/{id} | 更新笔记(需带 updateMask) |
| DELETE | /api/v1/memos/{id} | 删除笔记 |
| POST | /api/v1/attachments | 上传附件 |
| GET | /api/v1/memos/{id}/comments | 获取评论列表 |
| POST | /api/v1/memos/{id}/comments | 为笔记添加评论 |
请求参数
请求体与查询参数都用 JSON 惯用的驼峰命名(如 pageSize、orderBy)。
笔记字段(创建 / 更新的请求体)
| 字段 | 类型 | 说明 |
|---|---|---|
| content | string | 笔记正文(Markdown),#标签 直接写在正文里 |
| visibility | enum | 目前仅支持 PRIVATE(私有) |
| pinned | boolean | 是否置顶 |
| state | enum | NORMAL 正常 / ARCHIVED 归档 |
列表查询参数(GET /api/v1/memos)
| 参数 | 类型 | 说明 |
|---|---|---|
| pageSize | int | 每页条数 |
| pageToken | string | 翻页令牌,取上一页返回的 nextPageToken |
| state | enum | NORMAL / ARCHIVED,默认只返回正常笔记 |
| orderBy | string | 排序,如 display_time desc |
| filter | string | 过滤表达式(CEL),如按标签、可见性筛选 |
响应里 memos 是本页笔记数组,nextPageToken 非空时把它作为下一次请求的 pageToken 继续翻页。
附件字段(POST /api/v1/attachments)
| 字段 | 类型 | 说明 |
|---|---|---|
| filename | string | 文件名(必填) |
| type | string | MIME 类型,如 image/png(必填) |
| content | bytes | 文件内容,JSON 里为 base64 字符串 |
| memo | string | 可选,绑定到某条笔记,如 memos/123 |
评论(POST /api/v1/memos/{id}/comments)
请求体 comment 就是一条笔记,字段同上(content、visibility)——评论本质上是挂在目标笔记下的一条笔记。
更新示例
更新用 PATCH,并通过 updateMask 指明要改哪些字段(否则未列出的字段可能被清空),例如只改正文:
curl -X PATCH "https://api.insighto.com.cn/api/v1/memos/123?updateMask=content" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"content":"改过的正文"}'令牌等同于你的账号权限,请像密码一样保管,不要写进公开仓库或分享给他人。令牌泄露时,回到「设置 → 访问令牌」删除对应令牌即可立即失效,再重新创建一个。