Nox-Lumen MfgNox-Lumen Mfg

HTTP API

调用总览

Rendering diagram…

端点总览

Agent 管理

MethodPath说明
POST/v1/combo/agents创建 Agent
GET/v1/combo/agents列出 Agent
GET/v1/combo/agents/{agent_id}获取 Agent 详情
PUT/v1/combo/agents/{agent_id}更新 Agent
DELETE/v1/combo/agents/{agent_id}删除 Agent

Session 管理

MethodPath说明
POST/v1/combo/agents/{agent_id}/sessions创建 Session
GET/v1/combo/agents/{agent_id}/sessions列出 Session
GET/v1/combo/sessions/{session_id}获取 Session 详情
DELETE/v1/combo/sessions/{session_id}删除 Session
POST/v1/combo/sessions/{session_id}/archive归档

对话补全

MethodPath说明
POST/v1/combo/agents/{agent_id}/completions与 Agent 对话（支持流式）
POST/v1/combo/sessions/{session_id}/messages向 Session 发消息（不触发 Agent 推进，仅记录）

知识库（KB）

MethodPath说明
POST/v1/kb创建知识库
GET/v1/kb列出知识库
POST/v1/document上传文档
GET/v1/document/{doc_id}获取文档
POST/v1/chunk/search混合检索（向量 + 全文）

技能（Skill）

MethodPath说明
GET/v1/skills列出已安装技能
POST/v1/skills/install安装技能
POST/v1/skills/{skill_id}/activate激活到某 Session
GET/v1/skills/{skill_id}技能详情

定时任务（Cron）

MethodPath说明
POST/v1/cron创建定时任务
GET/v1/cron列出定时任务
DELETE/v1/cron/{cron_id}删除

事件触发（Event Trigger）

MethodPath说明
POST/v1/event-trigger创建触发器
GET/v1/event-trigger列出触发器

元数据 & 健康

MethodPath说明
GET/v1/combo/scenarios支持的场景类型
GET/v1/combo/processors支持的处理器
GET/v1/health健康检查
GET/v1/ready就绪检查（K8s 用）
GET/v1/openapi.jsonOpenAPI 规格

对话补全详解

POST /v1/combo/agents/{agent_id}/completions
Content-Type: application/json
Authorization: Bearer ragflow-<key>
 
{
  "session_id": "sess_abc123",
  "question": "帮我审查 https://gerrit.../c/456",
  "stream": true,
  "route": "@code-review@combo_solo@strict@"
}

请求字段

字段类型必填说明
session_idstring✅必须先创建 Session
questionstring✅用户消息
streamboolean❌默认 false；true 返回 SSE 流
routestring❌智能路由：@scenario@processor@mode@
attachmentsarray❌附件文件 ID 列表
context_idsarray❌引用的 KB 文档 ID

流式响应（SSE）

Rendering diagram…
event: thinking
data: {"phase": "plan"}

event: tool_call
data: {"tool": "gerrit.fetch_change", "args": {...}}

event: tool_result
data: {"tool": "gerrit.fetch_change", "result": {...}}

event: message
data: {"answer": "## 审查报告\n\n..."}

event: done
data: {"session_id": "sess_abc123", "cost": {"tokens": 4320, "duration_ms": 18500}}

非流式响应

{
  "code": 0,
  "data": {
    "session_id": "sess_abc123",
    "answer": "## 审查报告\n\n...",
    "reference": [...],
    "trace_id": "trc_xyz789",
    "cost": {
      "tokens": 4320,
      "duration_ms": 18500
    }
  }
}

文件上传

POST /v1/document
Content-Type: multipart/form-data
 
file: <binary>
kb_id: <knowledge_base_id>
parser_id: naive | laws | paper | patent | ...

响应：

{
  "code": 0,
  "data": {
    "doc_id": "doc_abc123",
    "status": "parsing",
    "chunk_count": 0
  }
}

通过 GET /v1/document/{doc_id} 轮询解析进度。

混合检索

POST /v1/chunk/search
Content-Type: application/json
 
{
  "question": "MCAL 超时重试",
  "kb_ids": ["kb_1", "kb_2"],
  "top_k": 10,
  "similarity_threshold": 0.7,
  "vector_similarity_weight": 0.3,
  "keyword_weight": 0.7,
  "rerank_top_n": 5
}

错误码

代码HTTP含义
0200成功
10001400参数错误
10002401未认证
10003403权限不足
10004404资源不存在
10005409资源冲突
10006429请求超限
20001500内部错误
30001502LLM 调用失败
30002504外部工具超时

速率限制 Headers

每次响应都会带：

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 42
X-RateLimit-Reset: 1699999999

相关文档

Next

产品介绍

On this page

调用总览端点总览Agent 管理Session 管理对话补全知识库（KB）技能（Skill）定时任务（Cron）事件触发（Event Trigger）元数据 & 健康对话补全详解请求字段流式响应（SSE）非流式响应文件上传混合检索错误码速率限制 Headers相关文档