nullkey
1c7171b2c6
Refs #890 #1049 #1168. 按集成方视角全量审计 17 个 API markdown 文档与 internal/router/router.go 对齐。每个端点新增参数说明小节（path/query/body 字段含义）和响应字段 含义说明（#1168 的核心诉求）。 【与代码对齐】 - 删除已下线端点：system.md 中的 /system/minio/buckets（代码中已无对 应路由）。 - 修正路径错误：chunk.md 中 /chunks/get-by-id/:id → /chunks/by-id/:id； /chunks/:id/delete-question → /chunks/by-id/:id/questions； organization.md 中 /organizations/preview/:invite_code → :code。 - 修正字段类型：faq tag_id / entry_id 由 string 改为 int64； knowledge.search 响应结构纠正。 - 补齐缺失端点（move-targets、batch-delete、move/progress、pin/unpin/ stop/continue-stream、tool-approvals、organization agent-shares 等 30+ 条）。 【精简】 - knowledge-base.md / model.md 把重复 5 次 / 3 次的完整对象样例 收敛为指向首次出现（"字段结构同 POST /xxx 响应"），节省约 400 行 而不损失信息（仅去重，原作者写的每个字段定义都保留可达）。 - 示例 X-API-Key 统一为 sk-xxxxx（避免读者复制看似真实的 key）。 【清理】 - 删除内部实现细节引用：mcp-service.md 中 6 处 "issue #1173"、 organization.md 中 "RegisterOrganizationRoutes" 等。 不动 initialization.md：其中端点（KB 配置、模型连通性测试、Ollama 管理） 对集成方有实用价值，保留原作者写好的内容不删。 格式统一遵循 web-search.md 重写后的范式（路由表 + 每端点方法/路径 + 参数表 + curl + 响应 JSON + 字段说明）。
WeKnora API 文档
目录
概述
WeKnora 提供了一系列 RESTful API，用于创建和管理知识库、检索知识，以及进行基于知识的问答。本文档详细描述了这些 API 的使用方式。
基础信息
- 基础 URL:
/api/v1 - 响应格式: JSON
- 认证方式: API Key
认证机制
所有 API 请求需要在 HTTP 请求头中包含 X-API-Key 进行身份认证：
X-API-Key: your_api_key
为便于问题追踪和调试，建议每个请求的 HTTP 请求头中添加 X-Request-ID：
X-Request-ID: unique_request_id
获取 API Key
在 web 页面完成账户注册后，请前往账户信息页面获取您的 API Key。
请妥善保管您的 API Key，避免泄露。API Key 代表您的账户身份，拥有完整的 API 访问权限。
错误处理
所有 API 使用标准的 HTTP 状态码表示请求状态，并返回统一的错误响应格式：
{
"success": false,
"error": {
"code": "错误代码",
"message": "错误信息",
"details": "错误详情"
}
}
API 概览
WeKnora API 按功能分为以下几类：
| 分类 | 描述 | 文档链接 |
|---|---|---|
| 认证管理 | 用户注册、登录、令牌管理 | OIDC认证调用流程.md |
| 租户管理 | 创建和管理租户账户 | tenant.md |
| 知识库管理 | 创建、查询和管理知识库 | knowledge-base.md |
| 知识管理 | 上传、检索和管理知识内容 | knowledge.md |
| 模型管理 | 配置和管理各种AI模型 | model.md |
| 分块管理 | 管理知识的分块内容 | chunk.md |
| 标签管理 | 管理知识库的标签分类 | tag.md |
| FAQ管理 | 管理FAQ问答对 | faq.md |
| 智能体管理 | 创建和管理自定义智能体 | agent.md |
| 会话管理 | 创建和管理对话会话 | session.md |
| 知识搜索 | 在知识库中搜索内容 | knowledge-search.md |
| 聊天功能 | 基于知识库和 Agent 进行问答 | chat.md |
| 消息管理 | 获取和管理对话消息 | message.md |
| 评估功能 | 评估模型性能 | evaluation.md |
| 初始化管理 | 知识库模型配置与 Ollama 管理 | initialization.md |
| 系统管理 | 系统信息、解析引擎、存储引擎 | system.md |
| MCP 服务 | MCP 工具服务管理 | mcp-service.md |
| 组织管理 | 组织、成员、知识库/智能体共享 | organization.md |
| Skills | 预装智能体技能 | skill.md |
| 网络搜索 | 网络搜索服务商 | web-search.md |
| 向量存储 | 向量数据库连接管理 | vector-store.md |