API
通过 API Key 集成 Agent、工作流、会话和知识库
Clouisle API 的基础路径为 /api/v1。请求使用 JSON，响应使用统一 code、data、msg 结构。需要认证的请求在 Authorization 请求头中使用 Bearer JWT 或以 clou_ 开头的 API Key。
开始使用
创建 API Key、设置基础 URL 并发送第一个请求。
文件上传
上传图片、文档和沙箱产物，并解析文件内容。
API Keys
创建和管理用于调用 Agent、工作流与上传接口的用户级 API Key。
认证与登录
注册、人机验证、密码登录、TOTP 两步验证与密码找回。
SSO 单点登录
供应商发现、OAuth2/OIDC/SAML2/CAS 登录流程与连接解绑。
两步验证（TOTP）
绑定、启用、停用 TOTP 两步验证并管理备用码。
Agents
管理 Agent 生命周期、发布控制与统计查询。
Agent 聊天
发送消息、附件、变量并消费流式响应。
会话
查询、更新、删除和管理消息版本。
记忆
管理当前用户的长期记忆实体与关系图谱。
知识库
管理文档、分块和检索测试。
提示词生成
调用大模型流式生成与优化 Agent 系统提示词。
工作流执行
运行、Webhook、取消和订阅节点事件。
工作流版本与模板
历史版本、发布、Diff 比对、回滚与模板市场。
工具
管理与执行 Agent 可调用的工具。
技能
导入、更新、删除与测试沙箱技能包。
团队
管理团队信息、成员角色与所有权移交。
团队模型授权
配置团队可用模型、配额上限与用量查询。
模型
发现可用模型并查询指定类型的默认模型。
通知
读取站内通知收件箱，管理员发布与删除通知。
流式事件
解析 Agent 与工作流的 SSE 事件。
嵌入集成
将 Agent 对话与工作流嵌入第三方网站与 iframe。
用户
管理当前用户资料与密码，以及管理员的用户 CRUD。
管理 API
管理后台端点的分组、权限码与调用边界。
设置
管理站点设置、通知渠道、公开设置和后台记忆提取。
错误处理
按 HTTP 状态和业务错误码恢复。
/api/v1/admin/* 是管理后台使用的受保护端点，不等同于稳定的第三方公共 API。集成优先使用本栏列出的资源端点，并为版本变化保留兼容策略。
这篇文章对你有帮助吗？