API overview
API standards and multilingual preset SDKs
The OpenAPI of this product (AgentRun/2025-09-10) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Flow orchestration
|
API |
Title |
Description |
| DeleteFlowVersion | Delete flow version | Deletes a workflow version. |
| DeleteFlow | Delete flow orchestration | Deletes a workflow. |
| DeleteFlowEndpoint | Delete a flow orchestration invocation endpoint | Deletes a workflow endpoint. |
| ConvertFlowDSL | Convert flow DSL | Converts a flow DSL. |
| PublishFlowVersion | Publish workflow version | Publishes a workflow version. |
| ListFlows | Get flow list | List flows |
| ListFlowVersions | Retrieve flow version list | Lists the versions of a flow. |
| ListFlowEndpoints | List flow orchestration invocation endpoints | Lists workflow endpoints. |
| UpdateFlowEndpoint | Update orchestration invocation endpoint | Updates a workflow endpoint. |
| UpdateFlowDraft | Update Flow Draft | Update a flow draft. |
| UpdateFlow | Update flow orchestration | Updates a workflow. |
| GetFlowVersion | Retrieve flow version information | Retrieves the details of a workflow version. |
| GetFlowEndpoint | Retrieve workflow endpoint details | Retrieves the details of a workflow endpoint. |
| GetFlowDraft | Query flow draft details | Get the workflow draft. |
| GetFlow | Query Flow Orchestration Details | Get flow details |
| CreateFlowEndpoint | Create a workflow invocation endpoint | Creates a workflow endpoint. |
| CreateFlow | Create flow orchestration | Creates a workflow. |
Agent runtime
|
API |
Title |
Description |
| CreateAgentRuntime | Create an agent runtime | Creates an agent runtime. |
| GetAgentRuntime | Retrieve an agent runtime | Retrieves an agent runtime. |
| UpdateAgentRuntime | Update agent runtime | Updates an agent runtime. |
| DeleteAgentRuntime | Delete an agent runtime | Deletes an agent runtime. |
| ListAgentRuntimes | List agent runtimes | Retrieves a list of agent runtimes. |
| CreateAgentRuntimeEndpoint | Create an access endpoint for an agent runtime | Creates an access endpoint for an agent runtime. |
| ListAgentRuntimeEndpoints | Get agent runtime access endpoint list | Retrieves the list of access endpoints for an agent runtime. |
| GetAgentRuntimeEndpoint | Get agent runtime access endpoint | Retrieves the access endpoint of an agent runtime. |
| UpdateAgentRuntimeEndpoint | Update an agent runtime access endpoint | Updates an agent runtime access endpoint. |
| DeleteAgentRuntimeEndpoint | Delete an agent access endpoint | Deletes an agent access endpoint. |
| PublishRuntimeVersion | Publish a new version of an agent runtime | Publishes a new version of an agent runtime. |
| ListAgentRuntimeVersions | Retrieve agent runtime versions | Retrieves agent runtime versions. |
Sandbox
|
API |
Title |
Description |
| Sandbox template management | Sandbox template management | |
| CreateTemplate | Create a template | Creates a template. |
| GetTemplate | Retrieve a template | Retrieves a template. |
| ListTemplates | List templates | Lists templates. |
| UpdateTemplate | Update a template | Updates a template. |
| DeleteTemplate | Delete a template | Deletes a template. |
| StopTemplateMCP | Stop a templateMCP service | Stops a TemplateMCP service. |
| ActivateTemplateMCP | Enable templateMCP service | Enables the sandbox MCP service, which allows clients to access sandboxes through the MCP protocol. |
| Sandbox instance management | Sandbox instance management | |
| CreateSandbox | Create a sandbox | Creates a sandbox. |
| GetSandbox | GetSandbox | Retrieves the details of a specific sandbox. |
| ListSandboxes | ListSandboxes | Returns a list of sandboxes. |
| StopSandbox | StopSandbox | Stops a sandbox. |
| DeleteSandbox | Delete a sandbox | Deletes a sandbox instance. |
Model management
|
API |
Title |
Description |
| CreateModelService | Create a model | Initiates model creation. |
| UpdateModelService | UpdateModelService | Updates a model service. |
| GetModelService | Retrieve model information | Retrieves model information. |
| DeleteModelService | Delete a model | Deletes a model. |
| ListModelServices | List all models | Lists all models. |
| CreateModelProxy | Create model governance | Creates model governance. |
| UpdateModelProxy | UpdateModelProxy | Updates the configuration of a model proxy. |
| GetModelProxy | GetModelProxy | Retrieves model governance information. |
| DeleteModelProxy | Delete model governance | Deletes a model. |
| ListModelProxies | ListModelProxies | Lists all Model Proxies. |
Memory storage
|
API |
Title |
Description |
| GetMemoryCollection | Retrieve memory storage | Queries the details of the memory storage. |
| UpdateMemoryCollection | Update memory store | Updates the memory store information. |
| DeleteMemoryCollection | Delete a memory store | Deletes a memory store. |
| CreateMemoryCollection | Create memory storage | Adds memory storage. |
| ListMemoryCollections | List memory storages | Queries a list of memory storages. |
Other
|
API |
Title |
Description |
| GetCredential | GetCredential | Retrieves information about a specific credential. |
| UpdateCredential | Update a credential | Updates a credential. |
| ListCredentials | List all credentials | Lists all credentials. |
| CreateCredential | Create a new credential | Creates a new credential. |
| DeleteCredential | Delete a specified credential | Deletes the specified credential. |
| GetAccessToken | GetAccessToken | Obtains an access token. |
| CreateKnowledgeBase | Create a knowledge base | Creates a knowledge base. |
| UpdateKnowledgeBase | Update a knowledge base | Updates a knowledge base. |
| DeleteKnowledgeBase | Delete a knowledge base | Deletes a knowledge base. |
| GetKnowledgeBase | Retrieve a knowledge base | Retrieves a knowledge base. |
| ListKnowledgeBases | List knowledge bases | Lists knowledge bases. |
| ListModelProviders | List all model providers | Lists all model providers. |
| DeleteCustomDomain | Delete a custom domain name | Deletes a custom domain name. |
| ListCustomDomains | ListCustomDomains | Lists custom domains. |
| CreateCustomDomain | Create a custom domain name | Creates a custom domain name. |
| GetCustomDomain | Retrieve custom domain name | Retrieves the custom domain name configuration. |
| UpdateCustomDomain | UpdateCustomDomain | Updates a custom domain. |
| GetWorkspaceDiscoveryEndpoints | GetWorkspaceDiscoveryEndpoints | Gets the discovery endpoints for a workspace. |
| UpdateWorkspaceDiscoveryEndpoints | UpdateWorkspaceDiscoveryEndpoints | Updates the discovery endpoint configuration for a specified workspace. |
| DeleteWorkspace | DeleteWorkspace | Deletes a workspace. |
| UpdateWorkspace | UpdateWorkspace | Updates a workspace. |
| ListWorkspaces | List workspaces | Retrieves a list of workspaces. |
| GetWorkspace | GetWorkspace | Retrieves the details of a specific workspace. |
| CreateWorkspace | Create a workspace | Creates a workspace. |
| UpdateTool | Update a tool | Updates a tool. |
| CreateTool | Create a tool | Creates a tool. |
| ListTools | List tools | Lists tools. |
| GetTool | Get a tool | Gets a tool. |
| DeleteTool | Delete a tool | Deletes a tool. |
| ResumeSandbox | Resume a sandbox | Resumes a paused sandbox, transitioning it from the PAUSED state to the running (READY) state. |
| PauseSandbox | Pause a sandbox | Pauses the sandbox, retains memory and file system snapshots, and transitions the sandbox to the PAUSED state for subsequent resumption. |
| CreateIMBot | Create an IM bot | Creates an IM bot. |
| DeleteIMBot | Delete an IM bot | Deletes an IM bot. |
| GetIMBot | Retrieve an IM bot | Retrieves an IM bot. |
| ListIMBots | List IM bots by page | Lists IM bots by page. |
| UpdateIMBot | Update an IM bot | Updates an IM bot. |
Pending deprecation
|
API |
Title |
Description |
| Browser sandbox | Browser sandbox | |
| CreateBrowser | Create a browser sandbox | Creates a browser sandbox. |
| ListBrowsers | List Browser Sandboxes | List Browser Sandboxes |
| GetBrowser | GetBrowserSandbox | GetBrowserSandbox |
| DeleteBrowser | Delete a browser sandbox | Deletes a browser sandbox. |
| Code interpreter | Code interpreter | |
| CreateCodeInterpreter | Create a code interpreter | Creates a code interpreter. |
| ListCodeInterpreters | List Code Interpreters | List Code Interpreters |
| GetCodeInterpreter | Retrieve an interpreter | Retrieves an interpreter. |
| DeleteCodeInterpreter | Delete a code interpreter | Deletes a code interpreter. |