# API 文档

共 27 个分组、188 个接口。

## 身份主体

应用下独立身份主体(Principal)的创建、删除和列表查询

- [`POST` 创建身份主体](/api/principal/principalCreate.md)
- [`POST` 修改身份主体](/api/principal/principalUpdate.md)
- [`GET` 查询身份主体列表](/api/principal/principalList.md)
- [`DELETE` 删除身份主体](/api/principal/principalDelete.md)

## 智能体管理与设定

智能体创建、查询、删除以及基础信息、头像、功能开关和技能矩阵的管理

- [`POST` 创建智能体](/api/agent/agentCreate.md)
- [`GET` 查询智能体详情](/api/agent/agentDetail.md)
- [`GET` 查询智能体列表](/api/agent/agentList.md)
- [`POST` 更新基础信息](/api/agent/agentUpdateBasicInfo.md)
- [`PUT` 更新智能体基本定义](/api/agent/agentUpdateDefinition.md)
- [`POST` 更新智能体身份定义](/api/agent/agentUpdateIdentity.md)
- [`POST` 更新头像](/api/agent/agentUpdateAvatar.md)
- [`POST` 更新模型配置](/api/agent/agentUpdateModelConfig.md)
- [`POST` 更新图片理解模型](/api/agent/agentUpdateImageModel.md)
- [`GET` 查询可用模型列表](/api/agent/agentListModels.md)
- [`POST` 更新功能设置](/api/agent/agentUpdateFeatureSettings.md)
- [`POST` 更新技能隔离范围](/api/agent/agentUpdateSkillScope.md)
- [`GET` 查询技能列表](/api/agent/agentListSkills.md)
- [`GET` 查询可用技能列表](/api/agent/agentListAvailableSkills.md)
- [`POST` 切换知识库启用/禁用](/api/agent/agentToggleKnowledgeLibrary.md)
- [`POST` AIGC 生成头像](/api/agent/agentGenerateAvatar.md)
- [`GET` 检查智能体是否可删除](/api/agent/agentDeleteCheck.md)
- [`DELETE` 删除智能体](/api/agent/agentDelete.md)

## 身份定义版本

智能体身份定义(Identity)的版本历史查询与回滚

- [`GET` 查询身份版本列表](/api/agent-identity/agentIdentityListVersions.md)
- [`GET` 查询身份版本详情](/api/agent-identity/agentIdentityGetVersionDetail.md)
- [`POST` 恢复身份版本](/api/agent-identity/agentIdentityRestoreVersion.md)

## 灵魂设定版本

智能体灵魂设定(System Prompt)的版本历史查询与回滚

- [`GET` 查询Soul版本列表](/api/agent-soul/agentSoulListVersions.md)
- [`GET` 查询Soul版本详情](/api/agent-soul/agentSoulGetVersionDetail.md)
- [`POST` 恢复Soul版本](/api/agent-soul/agentSoulRestoreVersion.md)

## 附件管理

附件的上传、下载、预览、复制和按会话维度查询

- [`POST` 上传附件](/api/agent-attachment/agentAttachmentUpload.md)
- [`POST` 通过URL导入附件](/api/agent-attachment/agentAttachmentUploadByUrl.md)
- [`GET` 下载附件](/api/agent-attachment/agentAttachmentDownload.md)
- [`GET` 查询附件文件信息](/api/agent-attachment/agentAttachmentGetInfo.md)
- [`GET` 预览附件](/api/agent-attachment/agentAttachmentPreview.md)
- [`GET` 查询最近会话附件列表](/api/agent-attachment/agentAttachmentListRecentBySession.md)
- [`GET` 查询指定会话附件详情](/api/agent-attachment/agentAttachmentGetBySession.md)
- [`GET` 根据消息ID查询附件](/api/agent-attachment/agentAttachmentGetByMessage.md)
- [`POST` 复制附件到新会话](/api/agent-attachment/agentAttachmentFork.md)

## 知识文档

知识库与文档管理（用户控制台代理至 dianjin-agent 内核）：知识库的增删/重建、文档的上传/导入/解析/语义树查询/下载

- [`GET` 查询知识库列表](/api/knowledge/knowledgeLibraryList.md)
- [`POST` 创建知识库](/api/knowledge/knowledgeLibraryCreate.md)
- [`POST` 重建知识库](/api/knowledge/knowledgeLibraryRebuild.md)
- [`POST` 删除知识库](/api/knowledge/knowledgeLibraryDelete.md)
- [`GET` 查询文档列表](/api/knowledge/knowledgeDocumentList.md)
- [`GET` 获取文档语义树](/api/knowledge/knowledgeDocumentGetTree.md)
- [`GET` 获取文档节点原文](/api/knowledge/knowledgeDocumentNodeContent.md)
- [`GET` 下载文档原文件](/api/knowledge/knowledgeDocumentDownload.md)
- [`POST` 上传知识库文件](/api/knowledge/knowledgeDocumentUpload.md)
- [`POST` 解析表格结构](/api/knowledge/knowledgeDocumentParseTableStructure.md)
- [`POST` 导入文档](/api/knowledge/knowledgeDocumentImport.md)
- [`POST` 导入表格文档](/api/knowledge/knowledgeDocumentImportTable.md)
- [`POST` 重建文档语义树](/api/knowledge/knowledgeDocumentRebuild.md)
- [`POST` 删除文档](/api/knowledge/knowledgeDocumentDelete.md)
- [`POST` 更新知识库](/api/knowledge/knowledgeLibraryUpdate.md)

## 智能体运行

智能体任务的提交、SSE事件流读取、任务生命周期管控（挂起/恢复/终止/重试）

- [`POST` 异步运行智能体](/api/agent-run/agentRunAsync.md)
- [`GET` SSE 流式读取智能体运行事件](/api/agent-run/agentRunStreamEvents.md)
- [`GET` 分页查询运行记录列表](/api/agent-run/agentRunListTasks.md)
- [`GET` 查询运行记录详情](/api/agent-run/agentRunGetTask.md)
- [`GET` 查询运行问答消息](/api/agent-run/agentRunGetMessages.md)
- [`GET` 查询待处理任务](/api/agent-run/agentRunListPendingTasks.md)
- [`GET` 统计运行记录数量](/api/agent-run/agentRunCountTasks.md)
- [`POST` 挂起运行中的任务](/api/agent-run/agentRunSuspendTask.md)
- [`POST` 恢复挂起的任务](/api/agent-run/agentRunResumeTask.md)
- [`POST` 终止任务](/api/agent-run/agentRunTerminateTask.md)
- [`POST` 重试失败的任务](/api/agent-run/agentRunRetryTask.md)
- [`POST` 添加运行时补充输入](/api/agent-run/agentRunAddSupplementaryInput.md)
- [`POST` 移除运行时补充输入](/api/agent-run/agentRunRemoveSupplementaryInput.md)
- [`GET` 预览补充输入队列](/api/agent-run/agentRunPreviewSupplementaryInput.md)

## 智能体技能

技能的详情查询、导入、下载、删除和启停

- [`GET` 查询技能详情](/api/agent-skill/agentSkillDetail.md)
- [`POST` 导入自定义技能](/api/agent-skill/agentSkillImportFromZip.md)
- [`POST` 从技能市场安装技能](/api/agent-skill/agentSkillInstallFromHub.md)
- [`GET` 下载自定义技能](/api/agent-skill/agentSkillDownload.md)
- [`POST` 禁用/启用技能](/api/agent-skill/agentSkillToggleEnabled.md)
- [`POST` 变更技能类型](/api/agent-skill/agentSkillChangeType.md)
- [`POST` 删除自定义技能](/api/agent-skill/agentSkillDelete.md)

## 会话管理

会话的创建、查询、维护以及历史轨迹导入和导出

- [`POST` 创建空会话](/api/session/sessionCreate.md)
- [`GET` 获取会话详情](/api/session/sessionGetDetail.md)
- [`GET` 查询会话上下文占用](/api/session/sessionContextUsage.md)
- [`GET` 查询会话后台任务](/api/session/sessionListBackgroundTasks.md)
- [`GET` 查询后台任务详情](/api/session/sessionGetBackgroundTaskDetail.md)
- [`POST` 停止后台任务](/api/session/sessionTerminateBackgroundTask.md)
- [`GET` 分页查询会话列表](/api/session/sessionList.md)
- [`POST` 搜索会话](/api/session/sessionSearch.md)
- [`GET` 分页查询会话消息列表](/api/session/sessionListMessages.md)
- [`GET` 查询消息部件列表](/api/session/sessionListMessageParts.md)
- [`PUT` 修改会话标题](/api/session/sessionUpdateTitle.md)
- [`POST` 分叉会话](/api/session/sessionFork.md)
- [`POST` 提交会话反馈](/api/session/sessionSubmitFeedback.md)
- [`GET` 获取会话LLM调用轨迹](/api/session/sessionGetTrajectory.md)
- [`POST` 导入完整会话轨迹](/api/session/sessionImportTrace.md)
- [`POST` 导入一问一答会话](/api/session/sessionImportQaPair.md)
- [`DELETE` 删除会话](/api/session/sessionDelete.md)
- [`GET` 查询消息部件详情](/api/session/sessionGetMessagePartDetail.md)

## 用量观测

Token 用量数据的汇总查询与模型、智能体维度排行，支持按身份主体、智能体和时间范围筛选

- [`GET` 查询用量汇总](/api/usage/usageGetSummary.md)
- [`GET` 查询模型消耗排行](/api/usage/usageGetModelRanking.md)
- [`GET` 查询智能体消耗排行](/api/usage/usageGetAgentRanking.md)

## 会话调用分析

查询自己会话的执行元数据、查看单份模型原始请求并压缩下载

- [`GET` 分页查询会话执行时间线](/api/session-analysis/sessionAnalysisGetSessionDetail.md)
- [`GET` 查询消息完整调用元数据](/api/session-analysis/sessionAnalysisGetMessageTrace.md)
- [`GET` 查看单份模型原始请求](/api/session-analysis/sessionAnalysisGetLlmRequestDetail.md)
- [`GET` 压缩下载模型原始请求](/api/session-analysis/sessionAnalysisDownloadLlmRequests.md)

## 配额管控

身份主体的Token配额策略绑定、账户状态查询、加油包充值撤销与主额度即时重置。主体可拥有一个全局账户（在全部智能体上生效）和多个智能体组账户（仅在一组智能体上生效，组内智能体共享同一份额度，一组可只含一个智能体），两类账户叠加扣减、任一耗尽即拦截；接口中的 scopeAgentId 指共享配额的一组智能体中任意一个智能体的ID，用于定位该组的账户

- [`GET` 查询配额状态](/api/token-budget/tokenBudgetGetQuotaStatus.md)
- [`GET` 查询智能体组账户的配额消耗状态](/api/token-budget/tokenBudgetListScopedQuotaStatus.md)
- [`GET` 查询加油包列表](/api/token-budget/tokenBudgetListTopups.md)
- [`GET` 查询配额策略列表](/api/token-budget/tokenBudgetListPolicies.md)
- [`POST` 绑定配额策略](/api/token-budget/tokenBudgetBindPolicy.md)
- [`POST` 解绑配额策略](/api/token-budget/tokenBudgetUnbindPolicy.md)
- [`POST` 充值加油包](/api/token-budget/tokenBudgetGrantTopup.md)
- [`POST` 撤销加油包](/api/token-budget/tokenBudgetRevokeTopup.md)
- [`POST` 即时重置配额](/api/token-budget/tokenBudgetResetQuotaUsage.md)

## 权限确认

工具调用触发人工确认时的决策提交与待确认列表查询

- [`POST` 解决权限确认请求](/api/permission-ask/permissionAskResolve.md)
- [`GET` 查询待确认列表](/api/permission-ask/permissionAskListPending.md)

## 用户问题交互

处理智能体等待当前用户回答的问题批次

- [`GET` 查询待回答问题](/api/human-questions/humanQuestionListPending.md)
- [`POST` 提交问题回答](/api/human-questions/humanQuestionResolve.md)
- [`POST` 取消问题批次](/api/human-questions/humanQuestionCancel.md)

## 工作台

工作台首页个性化动态内容的异步生成与轮询

- [`POST` 触发工作台动态内容生成](/api/workbench/workbenchTriggerFeed.md)
- [`GET` 轮询工作台动态内容生成结果](/api/workbench/workbenchPollFeed.md)

## 外部服务(Finx)

MCP/API 类型外部服务和工具的创建、管理与调试

- [`POST` 创建MCP服务](/api/agent-finx/finxCreateMcpService.md)
- [`POST` 编辑MCP服务](/api/agent-finx/finxUpdateMcpService.md)
- [`POST` 通过JSON导入MCP服务](/api/agent-finx/finxImportMcpService.md)
- [`POST` 创建HTTP服务](/api/agent-finx/finxCreateHttpService.md)
- [`POST` 编辑HTTP服务](/api/agent-finx/finxUpdateHttpService.md)
- [`GET` 查询服务列表](/api/agent-finx/finxListServices.md)
- [`GET` 获取市场服务](/api/agent-finx/finxListMarketServices.md)
- [`GET` 获取服务详情](/api/agent-finx/finxGetServiceDetail.md)
- [`GET` 查询服务分类列表](/api/agent-finx/finxListCategories.md)
- [`GET` 查询工具列表](/api/agent-finx/finxListTools.md)
- [`GET` 获取工具详情](/api/agent-finx/finxGetToolDetail.md)
- [`POST` 创建工具](/api/agent-finx/finxCreateTool.md)
- [`POST` 编辑工具](/api/agent-finx/finxUpdateTool.md)
- [`POST` 删除工具](/api/agent-finx/finxDeleteTool.md)
- [`POST` 执行Finx命令](/api/agent-finx/finxExecute.md)
- [`POST` 删除服务](/api/agent-finx/finxDeleteService.md)
- [`POST` 启用/禁用服务](/api/agent-finx/finxToggleServiceEnabled.md)
- [`POST` 获取服务授权Schema](/api/agent-finx/finxGetAuthSchema.md)
- [`POST` 保存服务授权凭证](/api/agent-finx/finxSaveAuthCredential.md)
- [`POST` 创建MCP服务（流式）](/api/agent-finx/finxCreateMcpServiceStream.md)
- [`POST` 导入MCP服务（流式）](/api/agent-finx/finxImportMcpServiceStream.md)
- [`POST` 创建HTTP服务（流式）](/api/agent-finx/finxCreateHttpServiceStream.md)

## 权限规则

智能体工具调用权限规则的增删改查与模板管理

- [`POST` 创建权限规则](/api/security-permission/permissionRuleCreate.md)
- [`POST` 批量创建权限规则](/api/security-permission/permissionRuleBatchCreate.md)
- [`GET` 查询权限规则列表](/api/security-permission/permissionRuleList.md)
- [`POST` 更新权限规则](/api/security-permission/permissionRuleUpdate.md)
- [`POST` 删除权限规则](/api/security-permission/permissionRuleDelete.md)
- [`POST` 智能生成权限规则](/api/security-permission/permissionRuleGenerate.md)
- [`GET` 轮询权限规则生成结果](/api/security-permission/permissionRulePollGenerate.md)
- [`GET` 获取权限模板列表](/api/security-permission/permissionTemplateList.md)
- [`GET` 获取权限模板详情](/api/security-permission/permissionTemplateGetDetail.md)
- [`POST` 应用权限模板](/api/security-permission/permissionTemplateApply.md)

## 用户记忆

用户记忆内容的查看、编辑和版本管理

- [`GET` 获取最新记忆内容](/api/memory/memoryGetLatestContext.md)
- [`POST` 编辑记忆内容](/api/memory/memoryUpdateContext.md)
- [`GET` 查询记忆版本列表](/api/memory/memoryListContextVersions.md)
- [`GET` 查询记忆版本详情](/api/memory/memoryGetContextVersion.md)
- [`POST` 恢复记忆版本](/api/memory/memoryRestoreContextVersion.md)

## 项目存储空间

查询并开通当前身份主体的项目存储空间

- [`GET` 查询项目存储空间状态](/api/storage-space/storageSpaceStatus.md)
- [`POST` 开通项目存储空间](/api/storage-space/storageSpaceEnsure.md)

## 定时任务

定时任务的创建、修改、查询、调度状态管理和执行历史查询

- [`POST` 创建定时任务](/api/agent-schedule/scheduleTaskCreate.md)
- [`GET` 查询任务列表](/api/agent-schedule/scheduleTaskList.md)
- [`GET` 查询任务详情](/api/agent-schedule/scheduleTaskDetail.md)
- [`POST` 修改定时任务](/api/agent-schedule/scheduleTaskUpdate.md)
- [`POST` 暂停任务](/api/agent-schedule/scheduleTaskDisable.md)
- [`POST` 恢复任务](/api/agent-schedule/scheduleTaskEnable.md)
- [`POST` 批量更新任务状态](/api/agent-schedule/scheduleTaskBatchUpdateStatusByAgentIds.md)
- [`POST` 按任务ID批量更新状态](/api/agent-schedule/scheduleTaskBatchUpdateStatusByTaskIds.md)
- [`POST` 立即触发任务](/api/agent-schedule/scheduleTaskTriggerNow.md)
- [`POST` 删除任务](/api/agent-schedule/scheduleTaskDelete.md)
- [`GET` 查询执行历史](/api/agent-schedule/scheduleTaskExecutionHistory.md)
- [`POST` 迁移历史运行记录](/api/agent-schedule/scheduleTaskImportExecution.md)
- [`POST` 更新定时任务执行策略](/api/agent-schedule/scheduleTaskUpsertTaskPolicy.md)
- [`GET` 查询定时任务执行策略](/api/agent-schedule/scheduleTaskGetTaskPolicy.md)

## 项目

管理当前身份主体的项目，并查询项目下的会话

- [`POST` 创建项目](/api/project/projectCreate.md)
- [`GET` 分页查询项目](/api/project/projectList.md)
- [`GET` 查询项目详情](/api/project/projectDetail.md)
- [`POST` 修改项目名称](/api/project/projectUpdateName.md)
- [`DELETE` 删除项目](/api/project/projectDelete.md)
- [`GET` 分页查询项目会话](/api/project/projectSessionList.md)

## 静态资源

智能体头像和预览图片等静态文件的代理访问，支持按尺寸缩放

- [`GET` 获取智能体头像](/api/agent-static/staticGetAgentAvatar.md)
- [`GET` 获取 Agent Hub 头像](/api/agent-static/staticGetHubAvatar.md)
- [`GET` 获取 AIGC 临时预览文件](/api/agent-static/staticGetTempResource.md)

## 斜杠命令

系统内注册的所有斜杠命令查询

- [`GET` 获取所有可用命令列表](/api/agent-command/commandList.md)

## 应用成员

应用下成员账号的创建、移除和列表查询，成员是可登录产品页面或 IM 渠道的正式用户

- [`GET` 查询应用成员列表](/api/member/memberList.md)

## 行业专家

浏览和安装官方推荐及当前应用我的市场中的已发布专家

- [`GET` 分页查询行业专家](/api/hub-agent/agentHubList.md)
- [`POST` 安装智能体市场专家智能体](/api/hub-agent/agentHubApply.md)

## 入驻千问(Qwen Onboarding)

千问应用与点金智能体的入驻绑定、品牌配置、列表查询、编辑、删除与Agent Card预览

- [`POST` 编辑入驻配置](/api/qwen-onboarding/qwenOnboardingUpdate.md)
- [`POST` 删除入驻配置](/api/qwen-onboarding/qwenOnboardingDelete.md)
- [`POST` 更新品牌配置](/api/qwen-onboarding/qwenOnboardingBrandUpdate.md)
- [`POST` 绑定千问应用](/api/qwen-onboarding/qwenOnboardingBind.md)
- [`GET` 查询入驻配置列表](/api/qwen-onboarding/qwenOnboardingList.md)
- [`GET` 预览Agent Card](/api/qwen-onboarding/qwenOnboardingAgentCardPreview.md)

## 免登接入(SSO)

为拥有自有登录体系的客户提供免登进入控制台的能力

- [`POST` 创建免登票据](/api/sso/ssoCreateTicket.md)
- [`GET` 免登入口](/api/sso/ssoLogin.md)