创建一个新的智能体实例,可指定名称、描述、灵魂设定、身份定义和禁用的内置技能。身份定义支持Markdown,不传或传空白内容时使用系统默认身份。
/api/agent/create创建智能体
请求参数
请求头参数1 个字段
身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。
请求体(JSON)7 个字段
智能体名称
灵魂设定,不传则使用默认人设
禁用的内置技能名称列表。null 或不传表示不禁用任何技能(全部启用),指定列表表示禁用指定技能
智能体描述,不超过512个字符
默认模型名称,不传则使用系统默认模型
头像文件名,通过 AIGC 生成头像接口获取的 fileName,不传则使用默认头像
智能体身份定义,用于描述角色、职责和专业背景,支持Markdown;不传或传空白内容则使用系统默认身份
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/detail查询智能体详情
根据智能体ID查询智能体的详细信息,包含基础信息、头像、技能矩阵和功能开关等。
请求参数
Query 参数1 个字段
智能体ID,必填
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/list查询智能体列表
查询当前用户有权限访问的智能体列表,返回智能体ID、名称和头像URL。
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/updateBasicInfo更新基础信息
兼容更新智能体名称、描述和灵魂设定;仅编辑名称和描述时,建议使用 updateDefinition。
请求参数
请求体(JSON)4 个字段
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/updateDefinition更新智能体基本定义
仅更新智能体名称和描述,不修改灵魂设定、身份定义、模型、技能、头像或能力配置。更新成功后返回最新的基本定义;如需同时修改灵魂设定,请继续使用兼容接口 updateBasicInfo。
请求参数
请求体(JSON)3 个字段
智能体ID
智能体名称,去除首尾空白后不能为空,最多128个字符
智能体描述,最多512个字符;传null或空白字符串表示清空描述
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/updateIdentity更新智能体身份定义
更新智能体的身份定义内容(支持Markdown),传null则清空。更新后自动创建版本快照,可通过配置版本管理接口(configType=identity)查看历史版本并恢复。身份说明:当您通过API访问本系统时,请求头中必须传递 X-Principal-Id 以标识操作主体;当您通过页面访问本系统时,无需传递。
请求参数
请求体(JSON)2 个字段
智能体ID
身份定义内容(支持Markdown),传null则清空当前身份定义
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/updateAvatar更新头像
更新智能体的头像,传 null 表示恢复默认头像。
请求参数
请求体(JSON)2 个字段
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/updateModelConfig更新模型配置
设置智能体的默认模型名称,modelName 传 null 或空字符串表示清除自定义设置、恢复为系统默认模型。modelName 按当前租户可用模型列表校验,与「查询可用模型列表」接口返回的列表口径一致。身份说明:当您通过API访问本系统时,请求头中必须传递 X-Principal-Id 以标识操作主体;当您通过页面访问本系统时,无需传递。
请求参数
请求体(JSON)2 个字段
智能体ID,必填
模型名称,对应智能体实体的 defaultModelName 字段。传 null 或空字符串表示清除自定义设置,恢复为系统默认模型。必须为系统支持的模型名称(不区分大小写,由上游服务统一转小写存储)
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/updateImageModel更新图片理解模型
设置智能体在 file 工具 view 图片(含 PDF、知识库文档内嵌图片)时使用的视觉模型,运行时优先于系统默认视觉模型。imageModelName 传 null 或空字符串表示清除自定义设置、恢复为系统默认视觉模型。模型按当前租户可用模型列表校验,且必须支持图片输入(「查询可用模型列表」接口返回的 inputModalities 包含 IMAGE),纯文本模型会被拒绝。身份说明:当您通过API访问本系统时,请求头中必须传递 X-Principal-Id 以标识操作主体;当您通过页面访问本系统时,无需传递。
请求参数
请求体(JSON)2 个字段
智能体ID,必填
图片理解模型名称,对应智能体实体的 imageModelName 字段。传 null 或空字符串表示清除自定义设置,恢复为系统默认视觉模型。必须为「查询可用模型列表」接口返回且 inputModalities 包含 IMAGE 的模型(不区分大小写,由上游服务统一转小写存储)
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/models查询可用模型列表
查询当前租户下可选的模型列表,含模型ID、上下文窗口、最大输出token及输入模态等元数据。inputModalities可选值:TEXT、IMAGE、VIDEO,调用方应使用该字段判断模型是否支持图片或视频输入。原supportVision字段已废弃但暂时保留,新调用方不应继续依赖该字段。同时返回服务端建议预选的 selectedModelName(恒非空),前端下拉框应直接用该值预选。元数据字段可能为空(供应商未配置时),前端渲染需容错。可选传入 agentId:传入且可解析时 selectedModelName 为该智能体的有效模型,否则回落为系统默认。
请求参数
Query 参数1 个字段
智能体ID,可选;传入后按该智能体的有效模型建议预选
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/updateFeatureSettings更新功能设置
更新智能体的功能设置,包括定时任务、斜杠命令、代码执行、Shell执行、联网搜索、网页读取和向用户提问等开关。所有开关字段均为可选,传null表示不修改。
请求参数
请求体(JSON)9 个字段
智能体ID,必填
是否启用定时任务能力,传null表示不修改
是否启用斜杠命令,传null表示不修改
是否启用代码执行能力,传null表示不修改
是否启用Shell执行能力,传null表示不修改
是否启用联网搜索能力,传null表示不修改
是否启用网页读取能力,传null表示不修改
是否允许Agent自主修改SOUL.md(人设文件),设为false则Agent无法在运行时修改人设,SOUL.md变为只读。传null表示不修改
是否允许智能体向用户提问并等待回答,默认 false,传 null 表示不修改
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/updateSkillScope更新技能隔离范围
设置智能体的技能数据隔离策略。AGENT模式下所有用户共享技能数据;PRINCIPAL模式下按用户隔离。注意:若智能体下已存在自定义技能,则禁止切换,需先删除所有自定义技能后再修改。
请求参数
请求体(JSON)2 个字段
智能体ID,必填
技能隔离范围,可选值:AGENT(所有用户共享,默认)、PRINCIPAL(按用户隔离)
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/skills查询技能列表
根据智能体ID查询该智能体下的技能列表,包含内置技能和自定义技能。当智能体技能隔离范围为PRINCIPAL模式时,传递 X-Principal-Id 可按身份主体过滤技能数据;未传递则返回该智能体下所有技能。
身份说明:当您通过API访问本系统时,可在请求头中传递 X-Principal-Id 以按身份主体过滤技能(可选);当您通过页面访问本系统时,无需传递。
请求参数
Query 参数1 个字段
智能体ID,必填
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/availableSkills查询可用技能列表
查询当前租户下所有可用的内置技能列表。
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/toggleKnowledgeLibrary切换知识库启用/禁用
在智能体上启用或禁用指定知识库。启用后该 agent 在对话时会看到 knowledge_search 工具,且仅能访问启用范围内的知识库。
启用(enabled=true)时只允许指定<b>当前应用空间下</b>的知识库,跨应用空间或跨租户的知识库返回无权访问;用户被迁移到新应用空间后,其在原空间创建的旧库同样不能再被新空间的智能体启用。禁用(enabled=false)不做该校验,历史上已启用的跨空间知识库随时可关闭。
请求参数
请求头参数1 个字段
身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。
Query 参数3 个字段
智能体ID
知识库ID
是否启用
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/avatar/generateAIGC 生成头像
调用 AIGC 接口生成头像,返回 fileName 和 previewUrl。
请求参数
请求体(JSON)1 个字段
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/deleteCheck检查智能体是否可删除
删除智能体前调用,返回是否可删除、当前阻塞项、预计软删除的资源数量以及删除后保留的历史资源。阻塞类型可选值:DEFAULT_AGENT、ACTIVE_RUN、REGISTERED_EXECUTION、SANDBOX_BACKGROUND_TASK、PUBLISHED_AGENT_HUB、BOUND_CHANNEL、CHANNEL_PRINCIPAL_MAPPING、DELETE_IN_PROGRESS、UNKNOWN。
请求参数
Query 参数1 个字段
待检查的智能体ID
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理
/api/agent/delete删除智能体
标准软删除智能体及其定义资源,返回统一删除时间和各类资源的软删除数量。调用前应先使用 deleteCheck 展示删除影响;执行删除时系统会再次检查,如果状态变化导致不可删除,将返回HTTP 409及最新删除检查结果。会话、运行记录、附件和配置快照等历史资源会按删除检查结果保留。
请求参数
Query 参数1 个字段
待删除的智能体ID
响应
200
HTTP状态码
响应消息
响应数据
是否成功
上游请求ID,用于跨系统链路追踪排查问题
上游错误码,前端可据此做特殊UI处理