Back to Weknora

API文档概览

docs/wiki/API参考/API文档概览.md

0.5.14.0 KB
Original Source

API 文档概览

WeKnora 提供了一系列 RESTful API,用于创建和管理知识库、检索知识,以及进行基于知识的问答。

基础信息

  • 基础 URL: /api/v1
  • 响应格式: JSON
  • 认证方式: API Key

API 认证使用 WeKnora 本地 JWT,OIDC 认证流程参见 OIDC认证调用流程

认证机制

所有 API 请求需要在 HTTP 请求头中包含 X-API-Key

X-API-Key: your_api_key
X-Request-ID: unique_request_id  # 建议,便于追踪

API Key 在 Web 页面完成账户注册后,前往账户信息页面获取。

错误处理

json
{
  "success": false,
  "error": {
    "code": "错误代码",
    "message": "错误信息",
    "details": "错误详情"
  }
}

API 分类

分类描述详细文档
认证管理用户注册、登录、令牌管理auth.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

各 API 的详细说明参见 docs/api/ 目录下的对应文档

相关主题


反向链接