接口索引
按用途浏览全部 Developer OpenAPI 接口。每个接口页面包含参数、请求与响应示例、返回字段、错误码和后续操作。
| 接口 | 方法 | 路径 | 分组 |
|---|---|---|---|
| 健康检查 | GET | /openapi/v2/health | 元信息 |
| 获取 OpenAPI 契约 | GET | /openapi/v2/openapi.json | 元信息 |
| API 版本 | GET | /openapi/v2/version | 元信息 |
| 列出知识库 | GET | /openapi/v2/knowledge-bases | 知识库 |
| 创建知识库 | POST | /openapi/v2/knowledge-bases | 知识库 |
| 删除知识库 | DELETE | /openapi/v2/knowledge-bases/{knowledgeBaseId} | 知识库 |
| 获取知识库 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId} | 知识库 |
| 修改知识库 | PATCH | /openapi/v2/knowledge-bases/{knowledgeBaseId} | 知识库 |
| 创建上传会话 | POST | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions | 上传 |
| 取消上传会话 | DELETE | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId} | 上传 |
| 获取上传会话 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId} | 上传 |
| 添加上传文件 | POST | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId}/entries | 上传 |
| 上传单个 Markdown 文件 | PUT | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId}/entries/{entryId}/content | 上传 |
| 完成上传会话 | POST | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId}/finalize | 上传 |
| 刷新上传冲突 | POST | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId}/reconcile | 上传 |
| 确认上传文件列表 | POST | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId}/seal | 上传 |
| 列出上传目录 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-directories | 上传目录 |
| 删除上传目录 | DELETE | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-directories/{directoryId} | 上传目录 |
| 获取上传目录 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-directories/{directoryId} | 上传目录 |
| 移动上传目录 | PATCH | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-directories/{directoryId} | 上传目录 |
| 列出已上传文件 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files | 已上传文件 |
| 删除已上传文件 | DELETE | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId} | 已上传文件 |
| 获取已上传文件 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId} | 已上传文件 |
| 移动已上传文件 | PATCH | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId} | 已上传文件 |
| 获取已上传文件内容 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId}/content | 已上传文件 |
| 替换已上传文件内容 | PUT | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId}/content | 已上传文件 |
| 重试已上传文件 | POST | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId}/retry | 已上传文件 |
| 列出文档索引和资源变更 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/operations | 文件和目录变更 |
| 获取文档索引或资源变更 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/operations/{operationId} | 文件和目录变更 |
| 获取文件 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/files/{fileId} | 文件 |
| 按 ID 获取文件内容 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/files/{fileId}/content | 文件 |
| 列出相关文件 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/files/{fileId}/related | 文件 |
| 按路径获取文件内容 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/files/content | 文件 |
| 搜索文件 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/files/search | 文件 |
| 探索相关文件 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/graph/expand | 文件 |
| 获取关系概览 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/graph/overview | 文件 |
| 列出文件树 | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/tree | 文件 |
| 列出投递记录 | GET | /openapi/v2/webhook-deliveries | Webhook |
| 重新投递 Webhook | POST | /openapi/v2/webhook-deliveries/{deliveryId}/redeliver | Webhook |
| 列出 Webhook | GET | /openapi/v2/webhooks | Webhook |
| 创建 Webhook | POST | /openapi/v2/webhooks | Webhook |
| 删除 Webhook | DELETE | /openapi/v2/webhooks/{webhookId} | Webhook |