管理面 API
Base:https://openagent-os.com/api/v1 | 鉴权:Authorization: Bearer <token>(控制台登录/注册返回)| RBAC:platform_admin / team_admin / team_operator / team_viewer
控制台(/console/)即由这套 API 驱动;以下为常用端点摘要,路径均前缀 /api/v1。
账号与商业化
| 端点 | 权限 | 说明 |
|---|---|---|
POST /signup | 公开 | 自助注册(免费套餐);重复邮箱 409 |
POST /auth/login | 公开 | 登录换 token |
GET /plans | 公开 | 三档套餐配额 |
GET /billing/summary | 登录 | 本租户套餐 + 用量 + 超限标记 |
POST /keys / GET /keys / POST /keys/{id}/revoke | team:llm:write | 开放 API 密钥签发/列表/吊销(secret 仅签发时返回) |
POST /tenants/{id}/plan | 平台管理员 | 调整租户套餐(即时生效) |
业务资源(team 作用域自动收敛到本租户)
| 资源 | 端点 | 说明 |
|---|---|---|
| 智能体 | POST/GET /agents · PUT/DELETE /agents/{id} · POST /agents/{id}/debug | 提示词 + kb_ids + llm_channel_id;debug 即控制台试跑(真实 RAG+LLM) |
| LLM 渠道 | POST/GET /llm-channels · PUT/DELETE /llm-channels/{id} · POST /llm-channels/{id}/models · POST /llm-channels/{id}/set-default | 预设 13 家厂商;models 用已存 Key 拉厂商真实模型列表;set-default 仅平台池渠道 |
| LLM 预设 | GET /llm-presets | DeepSeek/千问/GLM/Kimi/OpenAI/Claude/Gemini/豆包/MiniMax/硅基流动/Ollama/vLLM/自定义 |
| 消息渠道 | POST/GET /channels · PUT/DELETE /channels/{id} | 飞书/钉钉/企微,凭据加密,渠道归属租户 |
| 设备 | POST/GET /device-registry · POST /device-registry/{id}/bind-agent · POST /device-registry/{id}/revoke | 一机一码签发(token 仅显示一次)、绑定智能体、吊销 |
| 推送 | POST /pushes | target={scope: tenant|devices|channel} + action: notice.show / config.update / ota.push,设备回执 push.ack |
| 观测 | GET /conversations · GET /audit · GET /stats/dashboard · GET/PUT /safety-policy | 对话审计 / 管理审计 / 看板 / 注入与脱敏策略 |
知识库代理端点(/kb/…)见 知识库 RAG。
管理面 create 类资源受套餐配额约束:超限返回 402 quota exceeded。
调用示例
TOKEN=$(curl -s -X POST https://openagent-os.com/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{"email":"me@corp.com","password":"***"}' | python3 -c "import json,sys;print(json.load(sys.stdin)['token'])")
# 建一个绑定自有渠道的智能体
curl -s -X POST https://openagent-os.com/api/v1/agents \
-H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d '{"name":"织唛客服","system_prompt":"你是织唛行业客服…","kb_ids":[],"llm_channel_id":"<渠道ID>"}'
# 试跑(真实 RAG + LLM,不落正式会话)
curl -s -X POST https://openagent-os.com/api/v1/agents/<agentID>/debug \
-H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d '{"message":"你好"}'
错误码
| 401 | token 缺失/过期/用户被禁用(禁用即时生效) |
| 403 | RBAC 权限不足或跨租户访问 |
| 402 | 套餐配额超限 |
| 409 | 唯一性冲突(如邮箱已注册) |