API标准及多语言预置SDK
本产品（AgentRun/2025-09-10）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
流程编排
|
API |
标题 |
API概述 |
| DeleteFlowVersion | 删除流程版本 | 删除工作流版本。 |
| DeleteFlow | 删除流程编排 | 删除工作流。 |
| DeleteFlowEndpoint | 删除流程编排调用端点 | 删除工作流端点 |
| ConvertFlowDSL | 流程DSL转换 | 转换Flow DSL。 |
| PublishFlowVersion | 发布流程版本 | 发布工作流版本。 |
| ListFlows | 获取流程编排列表 | 列出工作流 |
| ListFlowVersions | 获取流程版本列表 | 列出工作流版本。 |
| ListFlowEndpoints | 获取流程编排调用端点列表 | 列出工作流端点。 |
| UpdateFlowEndpoint | 更新变成编排调用端点 | 更新工作流端点 |
| UpdateFlowDraft | 更新流程编排草稿 | 更新工作流草稿。 |
| UpdateFlow | 更新流程编排 | 更新工作流。 |
| GetFlowVersion | 获取流程版本信息 | 获取工作流版本详情。 |
| GetFlowEndpoint | 查询流程调用端点详情 | 获取工作流端点详情。 |
| GetFlowDraft | 查询流程草稿详情 | 获取工作流草稿。 |
| GetFlow | 查询流程编排详情 | 获取工作流详情 |
| CreateFlowEndpoint | 创建流程调用端点 | 创建工作流端点。 |
| CreateFlow | 创建流程编排 | 创建工作流。 |
Agent 运行时
|
API |
标题 |
API概述 |
| CreateAgentRuntime | 创建智能体运行时 | 创建智能体运行时。 |
| GetAgentRuntime | 获取智能体运行时 | 获取智能体运行时 |
| UpdateAgentRuntime | 更新智能体运行时 | 更新智能体运行时 |
| DeleteAgentRuntime | 删除智能体运行时 | 删除智能体运行时 |
| ListAgentRuntimes | 获取智能体运行时列表 | 获取智能体运行时列表 |
| CreateAgentRuntimeEndpoint | 创建智能体运行时的访问端点 | 创建智能体运行时的访问端点 |
| ListAgentRuntimeEndpoints | 获取智能体运行时访问端点列表 | 获取智能体运行时访问端点列表 |
| GetAgentRuntimeEndpoint | 获取智能体运行时访问端点 | 获取智能体运行时访问端点 |
| UpdateAgentRuntimeEndpoint | 更新智能体运行时访问端点 | 更新智能体运行时访问端点 |
| DeleteAgentRuntimeEndpoint | 删除智能体访问端点 | 删除智能体访问端点 |
| PublishRuntimeVersion | 发布智能体运行时新版本 | 发布智能体运行时新版本 |
| ListAgentRuntimeVersions | 获取智能体运行时版本 | 获取智能体运行时版本 |
Sandbox 沙箱
|
API |
标题 |
API概述 |
| 沙箱模板管理 | 沙箱模板管理 | |
| CreateTemplate | 创建模板 | 创建模板。 |
| GetTemplate | 获取模板 | 获取模板。 |
| ListTemplates | 列出模板 | 列出模板。 |
| UpdateTemplate | 更新模板 | 更新模板。 |
| DeleteTemplate | 删除模板 | 删除模板。 |
| StopTemplateMCP | 停止 TemplateMCP 服务 | 停止 TemplateMCP 服务。 |
| ActivateTemplateMCP | 启用 TemplateMCP 服务 | 启用 沙箱 MCP 服务，用于客户端通过MCP协议进行访问沙箱。 |
| 沙箱实例管理 | 沙箱实例管理 | |
| CreateSandbox | 创建 Sandbox | 创建 Sandbox。 |
| GetSandbox | 获取 Sandbox | 获取 Sandbox。 |
| ListSandboxes | 列出 Sandbox | 列出 Sandbox。 |
| StopSandbox | 停止 Sandbox | 停止 Sandbox。 |
| DeleteSandbox | 删除 Sandbox | 删除Sandbox实例。 |
模型管理
|
API |
标题 |
API概述 |
| CreateModelService | 创建模型 | 创建模型。 |
| UpdateModelService | 更新模型 | 更新模型。 |
| GetModelService | 获取模型信息 | 获取模型信息。 |
| DeleteModelService | 删除模型 | 删除模型。 |
| ListModelServices | 列出全部模型 | 列出全部模型。 |
| CreateModelProxy | 创建模型治理 | 创建模型治理 |
| UpdateModelProxy | 更新模型治理 | 更新模型治理。 |
| GetModelProxy | 获取模型治理信息 | 获取模型治理信息。 |
| DeleteModelProxy | 删除模型治理 | 删除模型 |
| ListModelProxies | 列出全部模型治理 | 列出全部模型治理。 |
记忆存储
|
API |
标题 |
API概述 |
| GetMemoryCollection | 获取记忆存储 | 查询记忆存储详情 |
| UpdateMemoryCollection | 更新记忆存储 | 修改记忆存储信息 |
| DeleteMemoryCollection | 删除记忆存储 | 删除记忆存储 |
| CreateMemoryCollection | 创建记忆存储 | 添加记忆存储 |
| ListMemoryCollections | 列出记忆存储 | 查询记忆存储列表 |
其他
|
API |
标题 |
API概述 |
| GetCredential | 获取凭证信息 | 获取凭证信息。 |
| UpdateCredential | 更新凭证 | 更新凭证。 |
| ListCredentials | 列出全部凭证 | 列出全部凭证。 |
| CreateCredential | 创建新凭证 | 创建新凭证。 |
| DeleteCredential | 删除指定凭证 | 删除指定凭证。 |
| GetAccessToken | 获取accessToken | 获取accessToken。 |
| CreateKnowledgeBase | 创建知识库 | 创建知识库。 |
| UpdateKnowledgeBase | 更新知识库 | 更新知识库。 |
| DeleteKnowledgeBase | 删除知识库 | 删除知识库。 |
| GetKnowledgeBase | 获取知识库 | 获取知识库。 |
| ListKnowledgeBases | 列出知识库 | 列出知识库。 |
| ListModelProviders | 列出全部模型供应商 | 列出全部模型供应商。 |
| DeleteCustomDomain | 删除自定义域名 | 删除自定义域名。 |
| ListCustomDomains | 列出自定义域名 | 获取自定义域名信息列表。 |
| CreateCustomDomain | 创建自定义域名 | 创建自定义域名 |
| GetCustomDomain | 获取自定义域名 | 获取自定义域名配置。 |
| UpdateCustomDomain | 更新自定义域名 | 更新自定义域名。 |
| GetWorkspaceDiscoveryEndpoints | 获取工作空间发现端点配置 | 获取工作空间下的发现端点 |
| UpdateWorkspaceDiscoveryEndpoints | 更新工作空间的发现端点 | 获取工作空间下的发现端点 |
| DeleteWorkspace | 删除工作空间 | 删除工作空间 |
| UpdateWorkspace | 更新工作空间 | 更新工作空间 |
| ListWorkspaces | 获取工作空间列表 | 获取工作空间列表 |
| GetWorkspace | 获取工作空间详情 | 查看工作空间 |
| CreateWorkspace | 创建工作空间 | 创建工作空间 |
| UpdateTool | 更新工具 | Update a tool. |
| CreateTool | 创建工具 | Create a tool. |
| ListTools | 列出工具 | List tools |
| GetTool | 获取工具 | Get a tool |
| DeleteTool | 删除工具 | Delete a tool |
| ResumeSandbox | 恢复沙箱 | 恢复暂停状态的沙箱，可以将PAUSED状态的沙箱恢复至运行态（READY）状态 |
| PauseSandbox | 暂停沙箱 | 暂停该沙箱，保留内存和文件系统快照，沙箱进入PAUSED状态，以便在后续恢复 |
待下线
|
API |
标题 |
API概述 |
| 浏览器沙箱 | 浏览器沙箱 | |
| CreateBrowser | 创建浏览器沙箱 | 创建浏览器沙箱 |
| ListBrowsers | 获取浏览器沙箱列表 | 获取浏览器沙箱列表 |
| GetBrowser | 获取浏览器沙箱 | 获取浏览器沙箱 |
| DeleteBrowser | 删除浏览器沙箱 | 删除浏览器沙箱 |
| 代码解释器 | 代码解释器 | |
| CreateCodeInterpreter | 创建代码解释器 | 创建代码解释器 |
| ListCodeInterpreters | 获取代码解释器列表 | 获取代码解释器列表 |
| GetCodeInterpreter | 获取代码解释器 | 获取代码解释器 |
| DeleteCodeInterpreter | 删除代码解释器 | 删除代码解释器 |
该文章对您有帮助吗？