Skip to content

REST API Reference

zhouning edited this page Mar 22, 2026 · 1 revision

REST API 参考 / REST API Reference

134 端点,全部需要 JWT Cookie 认证 | All endpoints require JWT cookie auth


中文 / English

认证 Auth (2)

方法 路径 说明 / Description
POST /auth/register 用户注册 / Register
POST /auth/login 用户登录 / Login

数据目录 Data Catalog (10)

方法 路径 说明
GET /api/catalog 列出数据资产 / List assets
GET /api/catalog/{id} 资产详情 / Asset detail
POST /api/catalog/search 语义搜索 / Semantic search
POST /api/catalog/register 注册资产 / Register asset
PUT /api/catalog/{id}/tag 打标签 / Tag asset
PUT /api/catalog/{id}/share 共享 / Share
DELETE /api/catalog/{id} 删除 / Delete
GET /api/catalog/lineage/{id} 血缘追踪 / Lineage
GET /api/catalog/download/{id} 下载 / Download
GET /api/catalog/stats 统计 / Statistics

语义层 Semantic Layer (9)

方法 路径 说明
POST /api/semantic/resolve 解析语义上下文 / Resolve context
GET /api/semantic/table/{name} 表语义描述 / Table semantics
POST /api/semantic/annotate 注册标注 / Annotate
POST /api/semantic/source 注册源 / Register source
GET /api/semantic/sources 列出语义源 / List sources
POST /api/semantic/domain 注册域 / Register domain
GET /api/semantic/equivalences 列等价 / Equivalences
GET /api/semantic/export 导出模型 / Export model
GET /api/semantic/hierarchy 浏览层级 / Browse hierarchy

管道 Pipeline (3)

方法 路径 说明
GET /api/pipeline/history 执行历史 / History
GET /api/pipeline/history/{id} 历史详情 / History detail
GET /api/map/pending 待更新地图数据 / Pending map updates

用户 User (5)

方法 路径 说明
GET /api/user/settings 用户设置 / Settings
PUT /api/user/settings 更新设置 / Update settings
GET /api/user/memories 记忆列表 / Memories
DELETE /api/user/account 删除账号 / Delete account
GET /api/user/files 用户文件 / Files

管理 Admin (5)

方法 路径 说明
GET /api/admin/metrics 系统指标 / Metrics
GET /api/admin/users 用户列表 / Users
PUT /api/admin/users/{id} 更新用户 / Update user
GET /api/admin/audit 审计日志 / Audit log
DELETE /api/admin/users/{id} 删除用户 / Delete user

MCP Hub (10)

方法 路径 说明
GET /api/mcp/servers 服务器列表 / List servers
POST /api/mcp/servers 添加服务器 / Add server
GET /api/mcp/servers/{id} 服务器详情 / Server detail
PUT /api/mcp/servers/{id} 更新 / Update
DELETE /api/mcp/servers/{id} 删除 / Delete
POST /api/mcp/servers/{id}/toggle 启用/禁用 / Toggle
GET /api/mcp/tools 工具列表 / List tools
POST /api/mcp/servers/{id}/reload 热重载 / Reload
GET /api/mcp/servers/{id}/health 健康检查 / Health
GET /api/mcp/stats 统计 / Stats

工作流 Workflows (8)

方法 路径 说明
GET /api/workflows 列表 / List
POST /api/workflows 创建 / Create
GET /api/workflows/{id} 详情 / Detail
PUT /api/workflows/{id} 更新 / Update
DELETE /api/workflows/{id} 删除 / Delete
POST /api/workflows/{id}/run 运行 / Run
GET /api/workflows/{id}/runs 运行历史 / Run history
POST /api/workflows/{id}/schedule 调度 / Schedule

技能 Skills (5)

方法 路径 说明
GET /api/skills 列表 / List
POST /api/skills 创建 / Create
GET /api/skills/{id} 详情 / Detail
PUT /api/skills/{id} 更新 / Update
DELETE /api/skills/{id} 删除 / Delete

技能包 Bundles (6)

方法 路径 说明
GET /api/bundles 列表 / List
POST /api/bundles 创建 / Create
GET /api/bundles/{id} 详情 / Detail
PUT /api/bundles/{id} 更新 / Update
DELETE /api/bundles/{id} 删除 / Delete
POST /api/bundles/{id}/clone 克隆 / Clone

用户工具 User Tools (6)

方法 路径 说明
GET /api/user-tools 列表 / List
POST /api/user-tools 创建 / Create
GET /api/user-tools/{id} 详情 / Detail
PUT /api/user-tools/{id} 更新 / Update
DELETE /api/user-tools/{id} 删除 / Delete
POST /api/user-tools/{id}/test 测试 / Test

知识库 Knowledge Base (10)

方法 路径 说明
GET /api/kb 列表 / List
POST /api/kb 创建 / Create
GET /api/kb/{id} 详情 / Detail
DELETE /api/kb/{id} 删除 / Delete
POST /api/kb/{id}/documents 添加文档 / Add document
GET /api/kb/{id}/documents 文档列表 / Documents
POST /api/kb/{id}/search 搜索 / Search
POST /api/kb/{id}/graph/build 构建图谱 / Build graph
GET /api/kb/{id}/graph 图谱数据 / Graph data
DELETE /api/kb/{id}/documents/{doc_id} 删除文档 / Delete document

模板 Templates (6)

方法 路径 说明
GET /api/templates 列表 / List
POST /api/templates 创建 / Create
GET /api/templates/{id} 详情 / Detail
PUT /api/templates/{id} 更新 / Update
DELETE /api/templates/{id} 删除 / Delete
POST /api/templates/{id}/share 共享 / Share

分析统计 Analytics (5)

方法 路径 说明
GET /api/analytics/summary 摘要 / Summary
GET /api/analytics/tools 工具使用 / Tool usage
GET /api/analytics/daily 每日统计 / Daily stats
GET /api/analytics/pipelines 管道统计 / Pipeline stats
GET /api/analytics/users 用户统计 / User stats

任务队列 Tasks (4)

方法 路径 说明
GET /api/tasks 列表 / List
POST /api/tasks 创建 / Create
GET /api/tasks/{id} 详情 / Detail
PUT /api/tasks/{id} 更新 / Update

其他 Other

方法 路径 说明
GET /api/capabilities 能力聚合 / Capabilities
GET /api/annotations 地图标注 / Annotations
GET /api/virtual-sources 虚拟源 / Virtual sources
GET /api/quality/rules 质量规则 / Quality rules
GET /api/quality/standards 数据标准 / Data standards
GET /health 健康检查 / Health check

Clone this wiki locally