Outline Knowledge Base API#

配置#

通过环境变量配置（必填）：

变量说明示例OUTLINE_BASE_URLOutline 实例地址（含 /api）https://example.com/api``OUTLINE_API_KEYAPI Key（ ol_api_ 开头）ol_api_xxxxxxxxx

获取 API Key: Outline → Settings → API Keys → Create

协议#

• 全部 POST，Content-Type: application/json，参数放 body
• 认证: Authorization: Bearer $OUTLINE_API_KEY
• 响应: { "ok": true/false, "data": ..., "status": 200 }
• 分页: list 类接口支持 limit + offset，响应含 pagination.nextPath
• 错误: { "ok": false, "error": "message" }
• 限流: 429 状态码，等待 Retry-After 秒

调用方式#

读取环境变量后用 curl 调用：

bash

OUTLINE_BASE_URL="${OUTLINE_BASE_URL:?未设置 OUTLINE_BASE_URL}"
OUTLINE_API_KEY="${OUTLINE_API_KEY:?未设置 OUTLINE_API_KEY}"

curl -s "$OUTLINE_BASE_URL/documents.list" \
  -X POST -H "authorization: Bearer $OUTLINE_API_KEY" \
  -H "content-type: application/json" -d '{}'

或用 web_fetch POST 到 $OUTLINE_BASE_URL/端点名。

首次使用时先验证连通性： auth.info 端点（无需参数），返回当前用户和团队信息。

常用操作速查#

文档 (Documents)#

操作端点关键参数搜索文档documents.search``query, collectionId?, userId?搜索标题documents.search_titles``queryAI 问答documents.answerQuestion``query, documentId?文档详情documents.info``id*创建文档documents.create``title*, collectionId*, text?, parentDocumentId?更新文档documents.update``id*, title?, text?列出文档documents.list``collectionId?, limit?, offset?草稿列表documents.drafts归档文档documents.archive``id*恢复文档documents.restore``id*删除文档documents.delete``id*导出文档documents.export``id*, format? (markdown/html)复制文档documents.duplicate``id*, title?, collectionId?移动文档documents.move``id*, collectionId*, parentDocumentId?子文档结构documents.documents``id*最近查看documents.viewed

文集 (Collections)#

操作端点关键参数列出文集collections.list``query?, limit?, offset?文集详情collections.info``id*创建文集collections.create``name*, description?, permission?, icon?, color?更新文集collections.update``id*, name?, description?文集文档树collections.documents``id*导出文集collections.export``id*, format?删除文集collections.delete``id*

用户 (Users)#

操作端点关键参数列出用户users.list``query?, limit?, offset?用户详情users.info``id*邀请用户users.invite``emails*, role?, collectionId?

评论 (Comments)#

操作端点关键参数创建评论comments.create``documentId*, data* (JSON {type, text?})列出评论comments.list``documentId*更新评论comments.update``id*, data*删除评论comments.delete``id*

其他#

• Stars: stars.list / stars.create( documentId* or collectionId*) / stars.delete
• Shares: shares.list / shares.create( documentId*) / shares.revoke
• Groups: groups.list / groups.create( name*) / groups.info
• Templates: templates.list / templates.create( title*, text?)

注意事项#

• 删除操作不可逆，先确认
• 文档内容格式为 Markdown
• id 参数为 UUID 格式
• 遇到 429 等待 Retry-After 秒后重试
• 完整 API 端点参考见 references/api-endpoints.md
• OpenAPI 原始规范: https://github.com/outline/openapi/blob/main/spec3.yml