# Alibaba Cloud AgentRun API

> Alibaba Cloud AgentRun API on Apizie: 101 endpoints (Enables the sandbox MCP service, which allows clients to access sandboxes through the MCP protocol, Converts a flow DSL, Creates an agent runtime, Creates an access endpoint for an agent runtime, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-agentrun`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/agentrun
- Page: https://zieapi.vercel.app/api/cloud/aliyun-agentrun
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-agentrun/openapi.json

Alibaba Cloud OpenAPI for AgentRun (agentrun, version 2025-09-10). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Enables the sandbox MCP service, which allows clients to access sandboxes through the MCP protocol
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/activate-template-mcp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| enabledTools | array | no | The list of enabled tools |
| transport | string | no | The transport protocol |
| templateName | string | yes | The template name |

### Converts a flow DSL
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/convert-flow-dsl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| dslSource | object | yes | The source configuration of the workflow DSL, supporting inline and base64 formats |
| options | object | no | The optional configuration parameters for DSL conversion |

### Creates an agent runtime
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-agent-runtime` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentIdentityConfig | object | no | The agent identity configuration |
| agentIdentityEnabled | string | no | Specifies whether to enable the agent identity feature |
| agentRuntimeName | string | yes | The name of the agent runtime. The name must be unique |
| armsConfiguration | object | no | 应用实时监控服务（ARMS）的配置信息 |
| artifactType | string | yes | Specifies the deployment type of the agent runtime. Valid values: Code (code mode) and Container (container mode) |
| codeConfiguration | object | no | The code configuration information when artifactType is set to Code, including the code source and entry file |
| containerConfiguration | object | no | The container configuration information when artifactType is set to Container, including the image address and startup command |
| cpu | number | yes | The CPU resources allocated to the agent runtime, in cores |
| credentialId | string | no | The ID of the credential used to access external services |
| credentialName | string | no | The name of the credential used to access the agent runtime |
| description | string | no | The description of the agent runtime |
| disableOndemand | string | no | Specifies whether to disable on-demand scaling. Default value: false. Set to true to disable on-demand scaling |
| disableSessionAffinity | string | no | Specifies whether to disable session affinity. Default value: false, which means session affinity is enabled by default. Set to true to… |
| diskSize | integer | no | The disk size |
| edition | string | no | The runtime version specifications |
| enableSessionIsolation | string | no | Specifies whether to enable session isolation. If enabled, each session runs in an isolated environment |
| environmentVariables | object | no | The environment variables of the agent runtime |
| executionRoleArn | string | no | The ARN of the execution role that grants the agent runtime permissions to access cloud services |
| externalAgentEndpointUrl | string | no | The endpoint URL of the external agent |
| headerFieldName | string | no | The name of the request header used for session affinity when sessionAffinityType is set to HEADER_FIELD |
| healthCheckConfiguration | object | no | The health check configuration of the agent runtime |
| logConfiguration | object | no | The Simple Log Service (SLS) configuration |
| memory | integer | yes | The memory resources allocated to the agent runtime, in MB |
| nasConfig | object | no | The NAS mount configuration |
| networkConfiguration | object | yes | The network configuration of the agent runtime |
| ossMountConfig | object | no | The OSS mount configuration |
| port | integer | yes | The listening port of the agent runtime |
| protocolConfiguration | object | no | The communication protocol configuration of the agent runtime |
| resourceGroupId | string | no | The ID of the resource group to which the resource belongs |
| sessionAffinityType | string | no | The session affinity mode. Valid values: NONE (disables session affinity), HEADER_FIELD (enables session affinity based on request… |
| sessionConcurrencyLimitPerInstance | integer | no | The maximum number of concurrent sessions allowed per runtime instance |
| sessionIdleTimeoutSeconds | integer | no | The idle timeout period for a session, in seconds. When an instance has no session requests, it enters an idle state and is billed in idle… |
| systemTags | array | no | The system tags of the agent runtime |
| workspaceId | string | no | The ID of the workspace to which the resource belongs |

### Creates an access endpoint for an agent runtime
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-agent-runtime-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentRuntimeId | string | yes | The ID of the agent runtime |
| agentRuntimeEndpointName | string | no | The name of the agent runtime endpoint |
| description | string | no | The description |
| disablePublicNetworkAccess | string | no | Specifies whether to disable public network access for the endpoint |
| routingConfiguration | object | no | The routing configuration of the agent runtime endpoint. Multi-version weight allocation is supported |
| scalingConfig | object | no | The elastic scaling configuration of the endpoint, including the minimum number of instances and scheduled scaling policies. This reuses… |
| targetVersion | string | no | The target version of the agent runtime |

### Creates a browser sandbox
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-browser` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| browserName | string | yes | The name of the browser |
| cpu | number | yes | The CPU cores to allocate to the browser instance |
| credentialId | string | no | The credential ID used for authentication |
| description | string | no | A description of the browser instance |
| executionRoleArn | string | no | The ARN of the execution role |
| memory | integer | yes | The memory (in MB) to allocate to the browser instance |
| networkConfiguration | object | yes | The network configuration for the browser instance |
| sessionIdleTimeoutSeconds | integer | no | The idle time in seconds before a session expires. When a session is idle, the instance enters an idle billing mode |

### Creates a code interpreter
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-code-interpreter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| codeInterpreterName | string | yes | The name of the code interpreter. Use this to identify and distinguish code interpreter instances |
| cpu | number | yes | The amount of CPU to allocate, in cores |
| credentialId | string | no | The credential ID used for authentication |
| description | string | no | A description of the code interpreter |
| executionRoleArn | string | no | The Alibaba Cloud Resource Name (ARN) of the execution role for the code interpreter |
| memory | integer | yes | The amount of memory to allocate, in megabytes (MB) |
| networkConfiguration | object | yes | Specifies the network configuration for the code interpreter, including VPC and security group settings |
| sessionIdleTimeoutSeconds | integer | no | The idle timeout for a session, in seconds. If an instance has no new requests for this duration, its session expires and cannot be reused |

### Creates a new credential
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| credentialAuthType | string | yes | The authentication type of the credential |
| credentialName | string | yes | The name of the credential |
| credentialPublicConfig | object | no | The public configuration of the credential |
| credentialSecret | string | no | The secret key of the credential |
| credentialSourceType | string | yes | The source type of the credential |
| description | string | no | The description text for the credential creation input |
| enabled | string | no | Specifies whether the credential is enabled |
| workspaceId | string | no | The ID of the workspace to which the resource belongs |

### Creates a custom domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-custom-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| certConfig | object | no | The HTTPS certificate information |
| description | string | no | The description |
| domainName | string | yes | The domain name. Enter a custom domain name that has an ICP filing or is connected to an ICP filing through Alibaba Cloud |
| domainType | string | no | The domain name type |
| protocol | string | yes | The protocol types supported by the domain name. Valid values: HTTP: Supports only the HTTP protocol. HTTPS: Supports only the HTTPS… |
| routeConfig | object | no | The route table. The mapping from paths to resources when the custom domain name is accessed |
| tlsConfig | object | no | The TLS configuration information |

### Creates a workflow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| definition | string | no | The definition of the workflow in JSON or YAML format |
| description | string | no | The description of the workflow, which explains the purpose and functionality of the workflow |
| disablePublicNetworkAccess | string | no | Specifies whether to disable public network access for the workflow. This value serves as the default policy at the workflow level. If… |
| environmentConfiguration | object | no | The environment variable configuration of the workflow, which contains a list of named variables |
| executionRoleArn | string | no | The Alibaba Cloud Resource Name (ARN) of the execution role that grants the workflow permissions to access cloud services |
| externalStorageLocation | string | no | The external storage location of the workflow, such as an OSS path |
| flowName | string | yes | The unique name of the workflow, which is used to distinguish different workflow instances |
| loggingConfiguration | object | no | The logging configuration of the workflow |
| resourceGroupId | string | no | The ID of the resource group to which the workflow belongs |
| tracingConfiguration | object | no | The Tracing Analysis configuration of the workflow |
| workspaceId | string | no | The ID of the workspace to which the workflow belongs. This parameter is used for resource isolation and permission management |

### Creates a workflow endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-flow-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | The workflow ID |
| description | string | no | The description of the workflow endpoint |
| disablePublicNetworkAccess | string | no | Specifies whether to disable public network access for the endpoint. If not specified during creation, the value is inherited from the… |
| flowEndpointName | string | yes | The unique name of the workflow endpoint |
| routingConfiguration | array | no | The array of version routing configurations for the workflow endpoint, used for traffic distribution |
| targetVersion | string | no | The target version number that the workflow endpoint points to |

### Creates an IM bot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-imbot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| botBizId | string | yes | The identifier of the IM bot, which must be unique within the same account |
| botBizSecret | string | yes | The secret key of the IM bot |
| botBizType | string | yes | The type of the IM platform |
| botMode | string | no | The mode of the IM bot |
| botName | string | yes | The name of the IM bot |
| description | string | no | The description of the IM bot |
| metadata | object | no | The configuration of the IM bot |
| minInstances | integer | no | The minimum number of Function Compute instances |

### Creates a knowledge base
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| credentialName | string | no | The name of the credential |
| description | string | no | The description of the knowledge base |
| knowledgeBaseName | string | yes | The name of the knowledge base |
| provider | string | yes | The provider of the knowledge base |
| providerSettings | object | yes | The configuration of the knowledge base provider |
| retrieveSettings | object | no | The retrieval configuration |
| workspaceId | string | no | The ID of the workspace |

### Adds memory storage
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-memory-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| description | string | no | The description |
| embedderConfig | object | no | The embedding model configuration |
| enableConversationHistory | string | no | Specifies whether to enable conversation history |
| enableConversationState | string | no | Specifies whether to enable conversation state management |
| executionRoleArn | string | no | The function execution role |
| llmConfig | object | no | The large language model configuration |
| memoryCollectionName | string | no | The name of the memory store |
| networkConfiguration | object | no | The network configuration |
| type | string | no | The memory store type |
| vectorStoreConfig | object | no | The vector database configuration |
| workspaceId | string | no | The ID of the workspace to which the resource belongs |

### Creates model governance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-model-proxy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| armsConfiguration | object | no | Specifies whether to enable Application Real-Time Monitoring Service (ARMS) |
| cpu | number | yes | The number of CPU cores |
| credentialName | string | no | The name of the credential associated with the model proxy |
| description | string | no | The description |
| executionRoleArn | string | no | The ARN of the execution role |
| litellmVersion | string | no | The LiteLLM version used by the model proxy |
| logConfiguration | object | no | The Simple Log Service (SLS) configuration for the agent runtime |
| memory | integer | yes | The memory size |
| modelProxyName | string | yes | The name of the model proxy |
| modelType | string | no | The model type. Valid values: system: Built-in system model. deployment: Custom-deployed model |
| networkConfiguration | object | no | The network mode |
| proxyConfig | object | yes | The proxy configuration of the model proxy |
| proxyMode | string | yes | The proxy mode of the model proxy |
| serviceRegionId | string | no | The region ID where the model proxy service is located |
| workspaceId | string | no | The ID of the workspace to which the resource belongs |

### Initiates model creation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-model-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| credentialName | string | no | The name of the credential |
| description | string | no | The description |
| modelInfoConfigs | array | no | The list of model information configurations |
| modelServiceName | string | yes | The service name of the model |
| modelType | string | yes | The model type. Valid values: system: system built-in model deployment: custom-deployed model |
| networkConfiguration | object | no | The network configuration information |
| provider | string | yes | The cloud provider. Currently, only Alibaba Cloud is supported |
| providerSettings | object | yes | The model provider configuration |
| workspaceId | string | no | The ID of the workspace to which the resource belongs |

### Creates a sandbox
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-sandbox` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| nasConfig | object | no | The NAS configuration |
| ossMountConfig | object | no | The OSS mount configuration |
| polarFsConfig | object | no | The group ID |
| sandboxId | string | no | The sandbox instance ID |
| sandboxIdleTimeoutInSeconds | integer | no | The sandbox idle timeout in seconds |
| sandboxIdleTimeoutSeconds | integer | no | The sandbox idle timeout in seconds |
| templateName | string | yes | The template name |

### Creates a template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| allowAnonymousManage | string | no | Specifies whether the data link is allowed to call the create, stop, and delete sandbox operations |
| armsConfiguration | object | no | The ARMS configuration |
| containerConfiguration | object | no | The container configuration. Only images based on Browser or Code Interpreter base images are allowed |
| cpu | number | yes | The CPU resource configuration, in cores |
| credentialConfiguration | object | no | The credential configuration |
| description | string | no | The template description |
| disablePublicNetworkAccess | string | no | Specifies whether public network access is disabled |
| diskSize | integer | no | The disk size |
| enableAgent | string | no | Specifies whether Sandbox Agent is enabled |
| enablePreStop | string | no | Specifies whether the pre-stop callback is enabled before an instance is destroyed |
| environmentVariables | object | no | The environment variables |
| executionRoleArn | string | no | The execution role ARN |
| logConfiguration | object | no | The log configuration |
| memory | integer | yes | The memory resources configuration, in MB |
| nasConfig | object | no | The NAS mount configuration |
| networkConfiguration | object | yes | The network configuration |
| ossConfiguration | array | no | The OSS configuration |
| preStopTimeoutInSeconds | integer | no | The timeout period for the pre-stop callback before an instance is destroyed, in seconds |
| sandboxIdleTimeoutInSeconds | integer | no | The sandbox idle timeout period, in seconds |
| sandboxTTLInSeconds | integer | no | The sandbox time-to-live (TTL), in seconds |
| scalingConfig | object | no | The elastic scaling configuration |
| templateConfiguration | object | no | The template configuration. This is a flexible object structure that varies based on the templateType value |
| templateName | string | yes | The template name. The name must be unique within the account |
| templateType | string | yes | The templatetype |
| workspaceId | string | no | The ID of the associated workspace |

### Creates a tool
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-tool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentIdentityConfig | object | no | The agent identity configuration |
| agentIdentityEnabled | string | no | Specifies whether to enable the agent identity capability |
| artifactType | string | no | The artifact type for tool deployment. Valid values: Code (code package) and Container (container image) |
| codeConfiguration | object | no | The configuration information of the code package tool, including the code location, entry function, and runtime. This parameter is… |
| containerConfiguration | object | no | The configuration information of the container tool, including the image address, startup command, and port mapping. This parameter is… |
| cpu | number | no | The number of CPU cores for the tool instance. Unit: cores. Decimals are supported. For example, 0.5 indicates half a core |
| createMethod | string | yes | The creation method of the tool. This parameter is required. Valid values: MCP_REMOTE (remote MCP server), MCP_LOCAL_STDIO (local MCP… |
| credentialName | string | no | The name of the credential used to access external services. The credential must be created in advance |
| description | string | no | The description of the tool |
| environmentVariables | object | no | The environment variables of the tool, in key-value pairs |
| executionRoleArn | string | no | The ARN of the RAM role used for permission control when the tool is executed. Format: acs:ram::123456789:role/AliyunFCDefaultRole |
| logConfiguration | object | no | The log configuration of the tool |
| mcpConfig | object | no | The configuration information of the MCP tool, including session affinity, proxy configuration, and binding configuration. This parameter… |
| memory | integer | no | The memory size of the tool instance. Unit: MB. Configure this parameter based on the actual requirements of the tool |
| nasConfig | object | no | The NAS mount configuration of the tool |
| networkConfiguration | object | no | The network configuration of the tool |
| ossMountConfig | object | no | The OSS mount configuration of the tool |
| port | integer | no | The listening port of the tool |
| protocolSpec | string | no | The protocol specification of the tool, which is a JSON string |
| timeout | integer | no | The timeout period for tool execution. Unit: seconds. If this period is exceeded, the tool invocation is terminated |
| toolName | string | yes | The name of the tool. This parameter is required and must be unique within the workspace |
| toolType | string | yes | The type of the tool. This parameter is required. Valid values: MCP (Model Context Protocol tool), FUNCTIONCALL (function calling tool),… |
| workspaceId | string | no | The identifier of the workspace to which the tool belongs. This parameter is optional. If you do not specify this parameter, the default… |

### Creates a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/create-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| description | string | no | The description of the workspace |
| enablePresetModel | string | no | Specifies whether to enable preset models |
| name | string | no | The name of the workspace |
| resourceGroupId | string | no | The ID of the resource group to which the resource belongs |

### Deletes an agent runtime
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-agent-runtime` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentRuntimeId | string | yes | The ID of the agent runtime |

### Deletes an agent access endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-agent-runtime-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentRuntimeId | string | yes | The agent runtime ID |
| agentRuntimeEndpointId | string | yes | The agent runtime endpoint ID |

### Deletes a browser sandbox
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-browser` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| browserId | string | yes | The browser ID |

### Deletes a code interpreter
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-code-interpreter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| codeInterpreterId | string | yes | The ID of the code interpreter |

### Deletes the specified credential
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| credentialName | string | yes | credentialName |

### Deletes a custom domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-custom-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| domainName | string | yes | The custom domain name |

### Deletes a workflow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | The workflow ID |

### Deletes a workflow endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-flow-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | The workflow ID |
| flowEndpointName | string | yes | The workflow endpoint ID |

### Deletes a workflow version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-flow-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | The name of the workflow |
| flowVersion | string | yes | The version number |

### Deletes an IM bot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-imbot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| imBotId | string | yes | The ID of the IM bot to delete, in UUID format |

### Deletes a knowledge base
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| knowledgeBaseName | string | yes | The name of the knowledge base |

### Deletes a memory store
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-memory-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| memoryCollectionName | string | yes | The name of the memory store |

### Deletes a model
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-model-proxy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| modelProxyName | string | yes | A short description of struct |

### Deletes a model
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-model-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| modelServiceName | string | yes | A short description of struct |

### Deletes a sandbox instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-sandbox` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| sandboxId | string | yes | The sandbox ID |

### Deletes a template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| templateName | string | yes | The template name |

### Deletes a tool
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-tool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| toolName | string | yes | The name of the tool |

### Deletes a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/delete-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |

### Retrieves an access token
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-access-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| resourceName | string | no | The resource name of the agent runtime |
| resourceType | string | no | The resource type |
| resourceId | string | no | The resource ID |

### Retrieves the agent runtime
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-agent-runtime` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentRuntimeId | string | yes | The agent runtime ID |
| agentRuntimeVersion | string | no | The agent runtime version |

### Retrieves the access endpoint of an agent runtime
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-agent-runtime-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentRuntimeId | string | yes | The agent runtime ID |
| agentRuntimeEndpointId | string | yes | The agent runtime endpoint ID |

### Retrieves a browser sandbox
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-browser` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| browserId | string | yes | The browser ID |

### Retrieves a code interpreter
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-code-interpreter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| codeInterpreterId | string | yes | The ID of the code interpreter |

### Retrieves credential information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| credentialName | string | yes | credentialName |

### Retrieves the custom domain name configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-custom-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| domainName | string | yes | The custom domain name |

### Retrieves the details of a workflow
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | The workflow ID |

### Retrieves a workflow draft
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-flow-draft` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | The workflow ID |

### Retrieves the details of a workflow endpoint
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-flow-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | The workflow ID |
| flowEndpointName | string | yes | The workflow endpoint ID |

### Retrieves the details of a workflow version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-flow-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | The workflow name |
| flowVersion | string | yes | The version number |

### Retrieves an IM bot
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-imbot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| imBotId | string | yes | The primary key UUID of the bot |

### Retrieves a knowledge base
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| knowledgeBaseName | string | yes | The name of the knowledge base |

### Queries the details of the memory storage
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-memory-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| memoryCollectionName | string | yes | The name of the memory storage |

### Retrieves model governance information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-model-proxy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| modelProxyName | string | yes | modelProxyName |

### Retrieves model information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-model-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| modelServiceName | string | yes | modelServiceName |

### Retrieves the details of a specific sandbox
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-sandbox` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| sandboxId | string | yes | The unique identifier of the sandbox |

### Retrieves a template
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| templateName | string | yes | The template name |

### Gets a tool
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-tool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| toolName | string | yes | The tool name |

### Retrieves the details of a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |

### Gets the discovery endpoints for a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/get-workspace-discovery-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |

### Retrieves the list of access endpoints for an agent runtime
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-agent-runtime-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentRuntimeId | string | yes | The agent runtime ID |
| endpointName | string | no | Filters results by endpoint name |
| pageNumber | integer | no | The page number |
| pageSize | integer | no | The page size |
| searchMode | string | no | The search mode |

### Retrieves agent runtime versions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-agent-runtime-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentRuntimeId | string | yes | The agent runtime ID |
| pageNumber | integer | no | The page number |
| pageSize | integer | no | The page size |

### Retrieves a list of agent runtimes
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-agent-runtimes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentRuntimeName | string | no | Filters the results by agent runtime name |
| status | string | no | Filters the results by status |
| systemTags | string | no | Filters the results by system tags |
| pageNumber | integer | no | The page number |
| pageSize | integer | no | The number of entries per page |
| searchMode | string | no | The search mode |
| resourceGroupId | string | no | The ID of the resource group to which the resource belongs |
| workspaceId | string | no | The workspace ID |
| discoveryResourceGroupId | string | no | The ID of the service discovery resource group |
| workspaceIds | string | no | Filters the results by multiple workspace IDs. Separate multiple IDs with commas (,) |

### List Browser Sandboxes
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-browsers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| browserName | string | no | Filter by browser name |
| pageSize | integer | no | Page size |
| pageNumber | integer | no | Page number |
| status | string | no | Filter by status |

### List Code Interpreters
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-code-interpreters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| codeInterpreterName | string | no | Filter by code interpreter name |
| pageNumber | integer | no | Page number |
| pageSize | integer | no | Page size |

### Lists all credentials
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| pageSize | integer | no | The page size |
| pageNumber | integer | no | The page number |
| credentialAuthType | string | no | The credential type |
| credentialSourceType | string | no | The credential source type |
| credentialName | string | no | The credential name |
| provider | string | no | The third-party credential provider |
| enabled | string | no | Specifies whether the credential is enabled |
| workspaceId | string | no | The unique identifier of the workspace |
| workspaceIds | string | no | The identifiers of multiple workspaces |

### Lists custom domains
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-custom-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| pageSize | integer | no | The number of entries per page |
| pageNumber | integer | no | The page number |
| domainName | string | no | The custom domain name |
| resourceName | string | no | The name of the resource associated with the custom domain |
| resourceType | string | no | The type of the resource associated with the custom domain |
| domainType | string | no | The domain type used for filtering. Valid values: STANDARD and SANDBOX |

### Lists workflow endpoints
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-flow-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowId | string | yes | The workflow ID |
| pageNumber | integer | no | The page number |
| pageSize | integer | no | The page size |

### Lists the versions of a flow
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-flow-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | The flow ID |
| pageNumber | integer | no | The page number |
| pageSize | integer | no | The page size |

### List flows
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-flows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | no | Filter by flow name |
| workspaceId | string | no | Workspace ID |
| workspaceIds | string | no | List of workspace IDs |
| pageNumber | integer | no | Page number |
| pageSize | integer | no | Page size |

### Lists IM bots by page
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-imbots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| pageNumber | integer | no | The page number. Default value: 1. Minimum value: 1 |
| pageSize | integer | no | The number of entries per page. Default value: 20. Valid values: 1 to 100 |
| botName | string | no | Filters by bot name by using case-insensitive substring matching |
| agentRuntimeId | string | no | Filters by the associated agent runtime ID |
| botBizType | string | no | Filters by the bot business type |
| status | string | no | The IM bot status. Valid values: running and stopped |

### Lists knowledge bases
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-knowledge-bases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| provider | string | no | The knowledge base provider |
| pageNumber | integer | no | The page number. Pages start from 1. Default value: 1 |
| pageSize | integer | no | The number of entries per page. Default value: 20 |
| workspaceId | string | no | The workspace ID |
| workspaceIds | string | no | The workspace IDs |

### Queries a list of memory storages
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-memory-collections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries per page. Default value: 20 |
| status | string | no | The status |
| type | string | no | The type |
| memoryCollectionName | string | no | The name of the memory storage |
| workspaceId | string | no | The ID of the workspace to which the resource belongs |
| workspaceIds | string | no | The workspace IDs. Separate multiple IDs with commas |

### Lists all model providers
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-model-providers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| modelType | string | no | The model type. Valid values: system: built-in model. deployment: custom deployed model |
| provider | string | no | The cloud provider. Only Aliyun is supported |
| modelName | string | no | The model name |
| pageNumber | string | no | The page number |
| pageSize | string | no | The page size |

### Lists all Model Proxies
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-model-proxies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| proxyMode | string | no | Specifies the proxy mode |
| status | string | no | Filters the list by Model Proxy status |
| pageNumber | integer | no | The page number for pagination |
| pageSize | integer | no | The number of entries per page. The default is 20 |
| workspaceId | string | no | The ID of the workspace |
| workspaceIds | string | no | A comma-separated list of workspace IDs to query |

### Lists all models
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-model-services` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| modelType | string | yes | The model type. Valid values: system: Built-in system model. deployment: Custom deployed model |
| provider | string | no | The cloud provider. Only Aliyun is supported |
| providerType | string | no | The provider type |
| pageNumber | integer | no | The page number |
| pageSize | integer | no | The page size |
| workspaceId | string | no | The ID of the workspace to which the resource belongs |
| workspaceIds | string | no | The list of workspace IDs. Separate multiple values with commas |

### Lists sandboxes
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-sandboxes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| templateName | string | no | The template name |
| templateType | string | no | The templatetype |
| maxResults | integer | no | The maximum number of results |
| nextToken | string | no | The pagination cursor. If this field is not empty, more data is available |
| status | string | no | The status |
| sandboxId | string | no | The ID of the sandbox instance |

### Lists templates
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| templateType | string | no | The templatetype |
| pageNumber | integer | no | The page number |
| pageSize | integer | no | The page size |
| status | string | no | The status |
| templateName | string | no | The template name |
| workspaceId | string | no | The workspace ID used for filtering |
| workspaceIds | string | no | The workspace IDs used for filtering |

### Lists tools
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-tools` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| pageSize | integer | no | The number of entries per page |
| pageNumber | integer | no | The page number |
| toolType | string | no | The tool type. Valid values: MCP: MCP tool. A tool based on Model Context Protocol. FUNCTIONCALL: Function call tool. A tool implemented… |
| toolName | string | no | The tool name. Fuzzy match is supported |
| workspaceId | string | no | The workspace ID |
| workspaceIds | string | no | The list of workspace IDs, separated by commas |

### Retrieves a list of workspaces
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/list-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| pageSize | string | no | The page size |
| pageNumber | string | no | The page number. Default value: 1 |
| name | string | no | The name |
| resourceGroupId | string | no | The ID of the resource group |

### Pauses the sandbox, retains memory and file system snapshots, and transitions the sandbox to the PAUSED…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/pause-sandbox` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| sandboxId | string | yes | The sandbox ID |

### Publishes a workflow version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/publish-flow-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | The workflow ID |
| description | string | no | The description of the workflow version |

### Publishes a new version of an agent runtime
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/publish-runtime-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentRuntimeId | string | yes | The ID of the agent runtime |
| description | string | no | The description of the version |
| publisher | string | no | The user or system identity that published the version |

### Resumes a paused sandbox and restores it from the PAUSED state to the READY state
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/resume-sandbox` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| sandboxId | string | yes | The ID of the sandbox instance |

### Stops a sandbox
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/stop-sandbox` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| sandboxId | string | yes | The sandbox ID |

### Stops a TemplateMCP service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/stop-template-mcp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| templateName | string | yes | The template name |

### Updates an agent runtime
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-agent-runtime` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentRuntimeId | string | yes | The agent runtime ID |
| agentIdentityConfig | object | no | The agent identity configuration |
| agentIdentityEnabled | string | no | Specifies whether to enable the agent identity capability |
| agentRuntimeName | string | no | The name of the agent runtime |
| armsConfiguration | object | no | 应用实时监控服务（ARMS）的配置信息 |
| artifactType | string | no | The artifact type |
| codeConfiguration | object | no | The code configuration |
| containerConfiguration | object | no | The container configuration |
| cpu | number | yes | The CPU configuration |
| credentialName | string | no | The name of the credential used to access the agent runtime |
| description | string | no | The description |
| disableOndemand | string | no | Specifies whether to disable on-demand scaling. Default value: false. Set to true to disable on-demand scaling |
| disableSessionAffinity | string | no | Specifies whether to disable session affinity. Default value: false, which means session affinity is enabled by default. Set to true to… |
| diskSize | integer | no | The disk size |
| edition | string | no | The runtime version specifications |
| enableSessionIsolation | string | no | Specifies whether to enable session isolation. If enabled, each session runs in an isolated environment |
| environmentVariables | object | no | The environment variables |
| executionRoleArn | string | no | The ARN of the execution role that grants the agent runtime permissions to access cloud services |
| externalAgentEndpointUrl | string | no | The access endpoint URL of the external agent |
| forceEvictInstances | string | no | Specifies whether to make a best effort to evict active Function Compute (FC) sessions after the runtime configuration is updated, so that… |
| headerFieldName | string | no | The name of the request header used for session affinity when sessionAffinityType is set to HEADER_FIELD |
| healthCheckConfiguration | object | no | The health check configuration for the agent runtime |
| logConfiguration | object | no | The Simple Log Service (SLS) configuration |
| memory | integer | no | The memory configuration |
| nasConfig | object | no | The NAS mount configuration |
| networkConfiguration | object | no | The network configuration |
| ossMountConfig | object | no | The OSS mount configuration |
| port | integer | no | The port |
| protocolConfiguration | object | no | The protocol configuration |
| sessionAffinityType | string | no | The session affinity mode. Valid values: NONE: Disables session affinity. HEADER_FIELD: Enables session affinity based on request headers.… |
| sessionConcurrencyLimitPerInstance | integer | no | The maximum number of concurrent sessions allowed per runtime instance |
| sessionIdleTimeoutSeconds | integer | no | The idle timeout period for a session, in seconds. When an instance has no session requests, it enters an idle state and is billed in idle… |
| systemTags | array | no | The system tags for the agent runtime |
| workspaceId | string | no | The ID of the workspace to which the resource belongs |

### Updates an agent runtime access endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-agent-runtime-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| agentRuntimeId | string | yes | The agent runtime ID |
| agentRuntimeEndpointId | string | yes | The agent runtime endpoint ID |
| agentRuntimeEndpointName | string | no | The name of the agent runtime endpoint |
| deleteScalingConfig | string | no | Specifies whether to delete the scaling configuration of the endpoint. If this parameter is set to true, the scaling configuration is… |
| description | string | no | The description |
| disablePublicNetworkAccess | string | no | Specifies whether to disable public network access for the endpoint |
| routingConfiguration | object | no | The routing configuration of the agent runtime endpoint. Multi-version weight allocation is supported |
| scalingConfig | object | no | The elastic scaling configuration of the endpoint, including the minimum number of instances and scheduled scale-out policies. This reuses… |
| targetVersion | string | no | The target version of the agent runtime |

### Updates a credential
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| credentialName | string | yes | credentialName |
| credentialPublicConfig | object | no | The public configuration of the credential |
| credentialSecret | string | no | The credential secret |
| description | string | no | The description text for the credential update input |
| enabled | string | no | Specifies whether it is enabled |
| workspaceId | string | no | The ID of the workspace to which the resource belongs |

### Updates a custom domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-custom-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| domainName | string | yes | The custom domain name |
| certConfig | object | no | The HTTPS certificate information |
| description | string | no | The description |
| protocol | string | no | The protocol types supported by the domain name. Valid values: HTTP: Only the HTTP protocol is supported. HTTPS: Only the HTTPS protocol… |
| routeConfig | object | no | The route table that maps the path to the resource when the custom domain name is accessed |
| tlsConfig | object | no | The TLS configuration information |

### Updates a workflow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | The workflow ID |
| definition | string | no | The definition content of the workflow, in JSON or YAML format |
| description | string | no | The description of the workflow, used to explain its purpose and functionality |
| disablePublicNetworkAccess | string | no | Whether to disable public network access for the workflow, serving as the default policy at the workflow level. When FlowEndpoint is not… |
| environmentConfiguration | object | no | The environment variable configuration of the workflow, containing a list of named variables |
| executionRoleArn | string | no | The execution role ARN that grants the workflow access permissions to cloud services |
| externalStorageLocation | string | no | The external storage location of the workflow, such as an OSS path |
| loggingConfiguration | object | no | The logging configuration of the workflow |
| resourceGroupId | string | no | The resource group identifier to which the workflow belongs |
| tracingConfiguration | object | no | The distributed tracing configuration of the workflow |
| workspaceId | string | no | The workspace identifier to which the workflow belongs, used for resource isolation and permission management |

### Update a flow draft
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-flow-draft` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | Flow ID |
| definition | string | no | The Flow Definition Language (FDL) definition of the workflow |
| description | string | no | The description of the workflow |
| environmentConfiguration | object | no | The environment variable configurations accessible during workflow execution, including a list of named variables |
| executionRoleArn | string | no | The ARN of the RAM role used for workflow execution |
| externalStorageLocation | string | no | The external storage location for the workflow execution history |

### Updates a workflow endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-flow-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| flowName | string | yes | The workflow ID |
| flowEndpointName | string | yes | The workflow endpoint ID |
| description | string | no | The description of the workflow endpoint |
| disablePublicNetworkAccess | string | no | Specifies whether to disable public network access for the endpoint |
| routingConfiguration | array | no | The list of version routing configurations for the workflow endpoint, used for traffic distribution |
| targetVersion | string | no | The target version number that the workflow endpoint points to |

### Updates an IM bot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-imbot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| imBotId | string | yes | The ID of the IM bot to update, in UUID format |
| botBizId | string | no | The identifier of the IM bot. It must be unique within the same account |
| botBizSecret | string | no | The secret of the IM bot |
| botBizType | string | no | The type of the IM platform |
| botMode | string | no | The mode of the IM bot |
| botName | string | no | The name of the IM bot |
| description | string | no | The description of the IM bot |
| metadata | object | no | The configuration of the IM bot. It is merged with the existing configuration |
| minInstances | integer | no | The minimum number of Function Compute instances |
| status | string | no | The status of the IM bot |

### Updates a knowledge base
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| knowledgeBaseName | string | yes | The name of the knowledge base |
| credentialName | string | no | The credential name |
| description | string | no | The knowledge base description |
| providerSettings | object | no | The knowledge base provider configuration |
| retrieveSettings | object | no | The retrieval configuration |
| workspaceId | string | no | The workspace ID |

### Updates the memory store information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-memory-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| memoryCollectionName | string | yes | The name of the memory store |
| description | string | no | The description |
| embedderConfig | object | no | The embedding model configuration |
| enableConversationHistory | string | no | Specifies whether to enable conversation history |
| enableConversationState | string | no | Specifies whether to enable conversation state management |
| executionRoleArn | string | no | The ARN of the execution role |
| llmConfig | object | no | The large language model configuration |
| networkConfiguration | object | no | The network configuration |
| vectorStoreConfig | object | no | The vector database configuration |
| workspaceId | string | no | The ID of the workspace to which the resource belongs |

### Updates model governance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-model-proxy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| modelProxyName | string | yes | modelProxyName |
| armsConfiguration | object | no | The configuration information for Application Real-Time Monitoring Service (ARMS) |
| credentialName | string | no | The name of the credential associated with the model proxy input |
| description | string | no | The description text for the model proxy input |
| executionRoleArn | string | no | The ARN of the execution role |
| logConfiguration | object | no | The log configuration |
| networkConfiguration | object | no | The network configuration |
| proxyConfig | object | no | The proxy configuration |
| workspaceId | string | no | The ID of the workspace to which the resource belongs |

### Updates a model
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-model-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| modelServiceName | string | yes | modelServiceName |
| credentialName | string | no | The name of the credential associated with the model service |
| description | string | no | The description text in the request to update a model service |
| modelInfoConfigs | array | no | The list of model information configurations |
| networkConfiguration | object | no | The network configuration |
| providerSettings | object | no | The model provider configuration |
| status | string | no | The current status of the model service |
| statusReason | string | no | The reason for the current status of the model service |
| workspaceId | string | no | The ID of the workspace to which the resource belongs |

### Updates a template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| templateName | string | yes | The template name |
| clientToken | string | no | The client token |
| allowAnonymousManage | string | no | Specifies whether the data link is allowed to invoke the create, stop, and delete sandbox operations |
| armsConfiguration | object | no | The configuration information for Application Real-Time Monitoring Service (ARMS) |
| containerConfiguration | object | no | The container configuration. Built-in configurations cannot be modified |
| cpu | number | no | The CPU resource configuration, in cores |
| credentialConfiguration | object | no | The credential configuration |
| description | string | no | The template description |
| disablePublicNetworkAccess | string | no | Specifies whether to disable public network access |
| enableAgent | string | no | The Sandbox Agent switch |
| enablePreStop | string | no | Specifies whether to enable the pre-stop callback before an instance is destroyed |
| environmentVariables | object | no | The environment variables |
| executionRoleArn | string | no | The ARN of the execution role |
| logConfiguration | object | no | The log configuration |
| memory | integer | no | The memory resources configuration, in MB |
| nasConfig | object | no | The NAS mount configuration |
| networkConfiguration | object | no | The network configuration |
| ossConfiguration | array | no | The OSS mount configuration |
| preStopTimeoutInSeconds | integer | no | The timeout period for the pre-stop callback before an instance is destroyed, in seconds |
| sandboxIdleTimeoutInSeconds | integer | no | The sandbox idle timeout period, in seconds |
| sandboxTTLInSeconds | integer | no | The sandbox time-to-live (TTL), in seconds |
| scalingConfig | object | no | The elastic scaling configuration |
| templateConfiguration | object | no | The template configuration. This is a flexible object structure that varies based on the templatetype value |
| workspaceId | string | no | The ID of the associated workspace |

### Updates a tool
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-tool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| toolName | string | yes | The name of the tool |
| agentIdentityConfig | object | no | The agent identity configuration |
| agentIdentityEnabled | string | no | Specifies whether to enable the agent identity capability |
| artifactType | string | no | The artifact type for tool deployment. Valid values: Code (code package) and Container (container image) |
| codeConfiguration | object | no | The configuration information for code package type tools |
| containerConfiguration | object | no | The configuration information for container type tools |
| cpu | number | no | The number of CPU cores for the tool instance, in cores |
| createMethod | string | no | The creation method of the tool. Valid values: MCP_REMOTE, MCP_LOCAL_STDIO, MCP_BUNDLE, CODE_PACKAGE, and OPENAPI_IMPORT |
| credentialName | string | no | The name of the credential used by the tool |
| description | string | no | The description of the tool |
| environmentVariables | object | no | The environment variable configuration for the tool runtime |
| executionRoleArn | string | no | The ARN of the RAM role used when the tool is executed |
| logConfiguration | object | no | The log configuration of the tool |
| mcpConfig | object | no | The configuration information of the MCP tool, including session affinity and proxy configuration |
| memory | integer | no | The memory size for the tool instance, in MB |
| nasConfig | object | no | The configuration information for File Storage NAS |
| networkConfiguration | object | no | The network configuration of the tool |
| ossMountConfig | object | no | The mount configuration for Object Storage Service (OSS) |
| port | integer | no | The port number that the tool service listens on |
| protocolSpec | string | no | The protocol specification definition used by the tool |
| timeout | integer | no | The timeout period for tool execution, in seconds |
| workspaceId | string | no | The identifier of the workspace to which the tool belongs |

### Updates a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| description | string | no | The description of the workspace. The original description is overwritten after the update |
| workspaceId | string | yes | The workspace ID |

### Updates the discovery endpoint configuration for a specified workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/update-workspace-discovery-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |
| credentialName | string | no | The name of the credential associated with the input for updating discovery endpoints |
| discoveryEndpoints | array | no | The list of discovery endpoints |
| workspaceId | string | yes | The unique identifier for the workspace |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentrun.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/activate-template-mcp" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud AgentRun API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-agentrun/activate-template-mcp with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud AgentRun API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud AgentRun itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud AgentRun API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-agentrun.

### What is the status of the Alibaba Cloud AgentRun API?
Needs your own provider key (bring your own key)