# Alibaba Cloud AgentLoop API

> Alibaba Cloud AgentLoop API on Apizie: 76 endpoints (Appends structured data rows to a specified dataset without requiring the client to construct SQL statements, Cancels a pipeline run, Creates an AgentSpace, Creates a context library, …) 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-agentloop/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for AgentLoop (agentloop, version 2026-05-20). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Appends structured data rows to a specified dataset without requiring the client to construct SQL statements
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/add-dataset-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the agent space |
| datasetName | string | yes | The name of the dataset |
| dataArray | array | no | The array of data rows to append. The array cannot be empty. The server reads the data in streaming mode. The maximum request body size is… |
| clientToken | string | no | The idempotency token. This is a unique string generated by the client to ensure the idempotence of the create operation |

### Cancels a pipeline run
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/cancel-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| pipelineName | string | yes | The pipeline name |
| runId | string | yes | The ID of the run to cancel. Only runs in the Pending state can be canceled |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| cmsWorkspace | string | no | The CMS workspace |
| description | string | no | The description |
| mseNamespaceId | string | no | The MSE namespace ID |
| trajectoryStoreEnabled | string | no | Specifies whether to enable trajectory cleaning |
| clientToken | string | no | The idempotency token. A unique string generated by the client to ensure the idempotence of the create operation |

### Creates a context library
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/create-context-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace. The name must be 2 to 64 characters in length |
| config | object | no | The context library configuration, including data sources and metadata field mappings |
| contextStoreName | string | yes | The name of the context store. The name must be globally unique within AgentSpace and 2 to 64 characters in length |
| contextType | string | yes | The type of the context store. Valid values include experience (experience store) and memory (memory store) |
| description | string | no | The description of the context store, which helps business users understand its purpose |
| clientToken | string | no | The idempotency token. This is a unique string generated by the client to ensure the idempotency of the creation operation |

### Creates an API key
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/create-context-store-apikey` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| contextStoreName | string | yes | The name of the context store |
| name | string | yes | The display name of the API key, which is used to identify its purpose |
| clientToken | string | no | The client token. This is a unique string generated by the client to ensure the idempotency of the creation operation |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the agent space |
| datasetName | string | yes | The name of the dataset |
| description | string | no | The description of the dataset |
| schema | object | yes | The schema of the dataset |
| clientToken | string | no | The idempotency token. A unique string generated by the client to ensure that the create operation is idempotent |

### Creates an evaluation task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/create-evaluation-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| channel | string | no | The task source. If not specified, the backend defaults to `default` |
| config | object | no | The data source and execution configuration. When `dataType=trace`, the backend automatically populates the SLS Project and… |
| dataFilter | string | no | The evaluation data filter conditions. Supports a JSON object or JSON string. Common fields include `query`, `provided`, `maxRecords`, and… |
| dataType | string | no | The data source type of the evaluation object. Use `trace` for trace-based evaluation |
| description | string | no | The description of the evaluation task |
| evaluators | array | no | The list of evaluator configurations. This parameter cannot be empty. Within the same task, `evaluatorRef` takes precedence. Otherwise,… |
| runStrategies | object | no | The task execution strategies. Supports a JSON object or JSON string. `backfill` is used for historical data backfill. `continuous` is… |
| tags | object | no | The task tag key-value pairs. No tags need to be specified by default. Specify tags only when you need to associate or filter tasks by… |
| taskMode | string | no | The evaluation task mode. `batch` creates a persistent evaluation task |
| taskName | string | no | The task name. The name must be unique among non-deleted tasks under the same user and AgentSpace. The name can be up to 256 characters in… |
| agentSpace | string | yes | The AgentSpace name |
| clientToken | string | no | The idempotency token. CloudSpec declares this query parameter, but the backend does not currently perform idempotency comparison |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| annotations | array | no | The list of annotation tags |
| config | object | no | The evaluator configuration. LLM/AGENT types typically include prompt, variables, and outputSchema. CODE types typically include codeType,… |
| description | string | no | The description of the evaluator. Maximum length: 256 characters |
| displayName | string | no | The display name. Maximum length: 128 characters |
| metricName | string | yes | The evaluation metric name |
| name | string | yes | The evaluator name. The name cannot start with a system-reserved prefix. Maximum length: 128 characters |
| properties | object | no | The evaluator properties |
| type | string | yes | The evaluator type. Valid values: LLM: an inner join large language model evaluation evaluator. AGENT: a StarOps digital worker evaluator.… |
| version | string | yes | The initial version number |
| versionDescription | string | no | The version description |
| clientToken | string | no | The idempotency token. This is a unique string generated by the client to ensure idempotence of the create operation. CloudSpec declares… |

### Creates an evaluator skill
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/create-evaluator-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| name | string | yes | The evaluator name |
| agentSpace | string | yes | The AgentSpace name |
| description | string | no | The skill description |
| displayName | string | no | The display name of the skill |
| enable | string | no | Specifies whether to enable the skill |
| files | array | yes | The list of skill files |
| skillName | string | yes | The skill name |
| clientToken | string | no | The idempotency token. CloudSpec declares this query parameter, but the backend does not currently perform idempotency comparison |

### Creates an experiment plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/create-experiment-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| datasetId | string | no | The ID of the associated dataset. If not specified, the execution phase processes in simple mode |
| description | string | no | The description of the experiment plan |
| evaluators | array | no | The list of evaluators. When configured, evaluation can be automatically triggered upon experiment completion |
| experimentType | string | yes | The experiment type. Set this parameter to `OFFLINE` or `ONLINE` |
| experiments | array | yes | The list of experiment configurations. A maximum of 5 entries are supported. For offline experiments, this parameter can be omitted or set… |
| input | object | no | Optional |
| pipelineName | string | no | The name of the associated data processing pipeline (optional). After association, when experiment runs under this plan finish writing… |
| planName | string | yes | The name of the experiment plan. The name must be unique within the same AgentSpace and account |
| querySql | string | no | The custom query SQL clause for partial dataset mode. This parameter can be used when `selectedItemIds` is empty |
| selectedItemIds | array | no | The list of selected data item IDs for partial dataset mode. This parameter must be used together with `datasetId` |

### Executes an experiment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/create-experiment-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| clientToken | string | no | Optional |
| completedAt | integer | no | The completion time. The value is a millisecond-level UNIX timestamp |
| completedTasks | integer | no | The number of completed tasks. Default value: 0 |
| executedAt | integer | no | The execution time. The value is a millisecond-level UNIX timestamp |
| experimentPlanId | string | yes | The experiment plan ID |
| failedTasks | integer | no | The number of failed tasks. Default value: 0 |
| offlineExperiments | array | no | The list of offline experiment configurations. This parameter is required when the plan type is offline. You can specify 1 to 5… |
| recordName | string | no | The experiment record name. If not specified, the default value is the plan name followed by a timestamp |
| status | string | no | The initial status. Default value: `pending` |
| totalTasks | integer | no | The total number of tasks. For online experiments, if not specified, the value is calculated based on the number of generated tasks |

### Creates a run for the specified optimization task and returns the run ID. When preview is set to true, an…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/create-optimize-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| optimizeTaskName | string | yes | The name of the optimization task |
| clientToken | string | no | The idempotency token. Use the same value when you retry the same creation request |
| input | string | yes | The JSON input defined by the task type, preserving the original object or array structure. ExperienceMining accepts a… |
| preview | string | no | Specifies whether to execute an independent pre-run of the complete algorithm. The pre-run generates candidate results and evidence… |

### Creates an optimization task in a specified AgentSpace, and configures the task type, status, and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/create-optimize-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| config | object | no | The type-specific configurations. Optional prompts for ExperienceMining and SkillOptimize only support inline Markdown. The main text is… |
| optimizeTaskName | string | no | The name of the optimization task. The name of a new service task is specified by the caller and must be unique within the same AgentSpace |
| status | string | no | The status of the task. Valid values: Enabled, Disabled |
| type | string | no | The type of the optimization task. Valid values: ExperienceMining, SkillOptimize, EfficiencyAnalysis, SOPGeneration, EvalMining,… |
| clientToken | string | no | The idempotency token |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace. The pipeline will be created under this AgentSpace |
| description | string | no | The description of the pipeline. Maximum length: 256 characters |
| executePolicy | object | no | The scheduling method |
| pipeline | object | no | The pipeline configuration, including node orchestration |
| pipelineName | string | no | The name of the pipeline. The name must be 3 to 63 characters in length and can contain only lowercase letters, digits, and hyphens (-) |
| sink | object | no | The pipeline sink, which is the data write destination |
| source | object | no | The data source for the pipeline |
| clientToken | string | no | The idempotency token. This is a unique string generated by the client to ensure the idempotency of the create operation |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| deleteMseNamespace | string | no | Specifies whether to delete the associated MSE namespace |
| deleteSlsProject | string | no | Specifies whether to delete the associated SLS project |
| deleteCmsWorkspace | string | no | Specifies whether to delete the associated Hybrid Cloud Monitoring workspace |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace. The length must be 2 to 64 characters |
| contextStoreName | string | yes | The name of the context store to be deleted. The length must be 2 to 64 characters |
| deleteOutputDataset | string | no | Specifies whether to simultaneously delete the memory output dataset (memory type). Default value: false |

### Deletes an API key
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/delete-context-store-apikey` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| contextStoreName | string | yes | The name of the context store |
| name | string | yes | The display name of the API key to be deleted |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The agent workspace name |
| datasetName | string | yes | The dataset name |

### Deletes an evaluation run
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/delete-evaluation-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| taskId | string | yes | The evaluation task ID |
| runId | string | yes | The evaluation run ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| taskId | string | yes | The model evaluation task ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| name | string | yes | The evaluator name |
| version | string | no | The version to delete. If this parameter is not specified, the entire evaluator is deleted |

### Deletes an evaluator skill
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/delete-evaluator-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| name | string | yes | The evaluator name |
| skillName | string | yes | The skill name |
| agentSpace | string | yes | The AgentSpace name |

### Deletes an experiment plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/delete-experiment-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| planId | string | yes | The experiment plan ID |

### Deletes an experiment record
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/delete-experiment-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| recordId | string | yes | The experiment record ID |

### Deletes an optimization task in a specified AgentSpace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/delete-optimize-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| optimizeTaskName | string | yes | The name of the optimization task |
| clientToken | string | no | The idempotency token |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace where the pipeline to be deleted is located |
| pipelineName | string | yes | The name of the pipeline to be deleted |

### Queries regions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| language | string | yes | The language. Valid values: zh: Chinese en: English |
| maxResults | integer | no | The maximum number of entries to return in a single request |
| nextToken | string | no | The pagination token |

### Executes a query statement
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/execute-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The agent space name |
| datasetName | string | yes | The dataset name |
| annotationFilter | object | no | The annotation filter |
| from | integer | no | The start time of the query |
| length | integer | no | The page size |
| maxOutputLength | integer | no | The maximum output length |
| offset | integer | no | The pagination offset |
| query | string | yes | The query entered by the user |
| to | integer | no | The end time of the query |
| type | string | yes | The statement type. Currently, only SQL is supported |
| version | string | no | The dataset version |

### Queries the AgentSpace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-agent-space` (byok)

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

### Queries a context store
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-context-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace. The name must be 2 to 64 characters in length |
| contextStoreName | string | yes | The name of the context store. The name must be 2 to 64 characters in length |

### Retrieves an API key
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-context-store-apikey` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| contextStoreName | string | yes | The name of the context store |
| name | string | yes | The display name of the API key |

### Queries a dataset
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the agent space |
| datasetName | string | yes | The name of the dataset |

### Retrieves the details of an evaluation run
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-evaluation-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| taskId | string | yes | The evaluation task ID |
| runId | string | yes | The evaluation run ID |

### Retrieves the details of an evaluation task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-evaluation-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| taskId | string | yes | The evaluation task ID |

### Retrieves the details of an evaluator
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-evaluator` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| name | string | yes | The evaluator name |
| version | string | no | The target version number. If not specified, the latest version is used |

### Retrieves the details of an evaluator skill
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-evaluator-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| name | string | yes | The evaluator name |
| skillName | string | yes | The skill name |
| agentSpace | string | yes | The AgentSpace name |
| version | string | no | The skill version |

### Queries an experiment plan
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-experiment-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| planId | string | yes | The experiment plan ID |

### Queries the details of an experiment run record
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-experiment-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| recordId | string | yes | The experiment run record ID |

### Queries the status, errors, execution progress, type-related results, and artifact references of a specified…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-optimize-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| optimizeTaskName | string | yes | The name of the optimization task |
| optimizeRunId | string | yes | The ID of the execution instance |

### Queries the type, status, configuration, and scheduling checkpoint of a specified optimization task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-optimize-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| optimizeTaskName | string | yes | The optimization task name |

### Queries a pipeline
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace where the pipeline is located |
| pipelineName | string | yes | The name of the pipeline to query |

### Queries the details of a single pipeline run
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| pipelineName | string | yes | The name of the pipeline |
| runId | string | yes | The ID of the run |

### Queries the pipeline run statistics
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/get-pipeline-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| pipelineName | string | yes | The name of the pipeline |
| startTime | integer | no | The start time of the statistical window in UNIX seconds. Default value: now - 86400 |
| endTime | integer | no | The end time of the statistical window in UNIX seconds. Default value: now |
| granularity | string | no | The statistical granularity. Valid values: Hour, Day, Week, and Month. Default value: automatically inferred |

### Queries a list of AgentSpaces
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-agent-spaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | no | The AgentSpace name |
| regionId | string | no | The region ID |
| maxResults | integer | no | The maximum number of results to return |
| nextToken | string | no | The pagination token |

### Retrieves a list of API keys
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-context-store-apikeys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| contextStoreName | string | yes | The name of the context store |
| nextToken | string | no | The pagination token. Pass the nextToken value from the previous response to retrieve the next page. Do not specify this parameter for the… |
| maxResults | integer | no | The maximum number of API keys to return in the current request. Default value: 20. Maximum value: 100 |

### Queries the list of context stores
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-context-stores` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace. The name must be 2 to 64 characters in length |
| contextStoreName | string | no | The name of the context store used for filtering. Exact match is supported. If this parameter is not specified, no filtering is performed |
| contextType | string | no | The type of the context store used for filtering, such as experience or memory. If this parameter is not specified, no filtering is… |
| sourceType | string | no | The memory data source type used for filtering, such as manual, trajectory, or dataset. If this parameter is not specified, no filtering… |
| maxResults | integer | no | The maximum number of context stores to return in the current request. Default value: 20. Maximum value: 100 |
| nextToken | string | no | The pagination token. To retrieve the next page, pass the nextToken value from the previous response. Do not specify this parameter for… |

### Queries a list of datasets
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-datasets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the agent workspace |
| datasetName | string | no | The name of the dataset |
| maxResults | integer | no | The maximum number of results to return |
| nextToken | string | no | The next token. You do not need to set this parameter for the first request. For subsequent requests, pass the nextToken value returned in… |
| labels | string | no | Filters datasets by labels (JSON-encoded) |

### Queries the list of evaluation runs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-evaluation-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| taskId | string | yes | The evaluation task ID |
| status | string | no | The run status filter condition |
| runType | string | no | The run type filter condition |
| nextToken | string | no | The pagination token for the next page |
| maxResults | integer | no | The number of entries per page. Default value: 20. Maximum value: 100 |

### Queries a list of evaluation tasks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-evaluation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | no | The AgentSpace name |
| taskName | string | no | The fuzzy match condition for the task name |
| taskMode | string | no | The evaluation task mode. If this parameter is not specified, the default value is `batch` |
| dataType | string | no | The data source type of the evaluation object. Set this parameter to `trace` for trace-based evaluation |
| status | string | no | The filter condition for the evaluation task status |
| nextToken | string | no | The pagination token for the next page, obtained from the previous response |
| maxResults | integer | no | The number of entries per page. Default value: 20. Maximum value: 100 |
| channel | string | no | The filter condition for the task source. If this parameter is not specified, tasks from the default source are queried |

### Queries the list of skills for an evaluator
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-evaluator-skills` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| name | string | yes | The evaluator name |
| agentSpace | string | yes | The AgentSpace name |
| maxResults | integer | no | The number of entries per page |
| nextToken | string | no | The pagination token for the next page |

### Queries a list of evaluators
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-evaluators` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| type | string | no | The evaluator type filter |
| name | string | no | The fuzzy match condition for the evaluator name |
| source | string | no | The evaluator source filter |
| maxResults | integer | no | The number of entries per page. Default value: 20. Maximum value: 100 |
| nextToken | string | no | The pagination token for the next page |

### Queries the list of experiment plans
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-experiment-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| planName | string | no | Fuzzy matches experiment plans by plan name |
| status | string | no | Filters experiment plans by exact status |
| offset | integer | no | The offset. Default value: 0 |
| limit | integer | no | The number of entries to return. Default value: 20 |
| maxResults | integer | no | Optional. Use `offset` and `limit` for pagination instead |
| nextToken | string | no | Optional. Use `offset` and `limit` for pagination instead |

### Queries a list of experiment run records
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-experiment-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| page | integer | no | The page number, starting from 0. Default value: 0 |
| pageSize | integer | no | The number of entries per page. Default value: 20 |
| status | string | no | Filters results by status |
| datasetId | string | no | Filters results by exact dataset ID |
| planName | string | no | Filters results by fuzzy match on the experiment plan name |
| experimentName | string | no | Filters results by fuzzy match on the experiment configuration name |
| maxResults | integer | no | Optional. Use `page` and `pageSize` for pagination instead |
| nextToken | string | no | Optional. Use `page` and `pageSize` for pagination instead |

### Performs a paging query on the run records of a specified optimization task. To obtain complete result…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-optimize-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| optimizeTaskName | string | yes | The name of the optimization task |
| status | string | no | The status used to filter results |
| windowStartTimeBegin | integer | no | The lower bound of the window start time in UNIX seconds |
| windowStartTimeEnd | integer | no | The upper bound of the window start time in UNIX seconds |
| nextToken | string | no | The pagination token |
| maxResults | integer | no | The maximum number of entries to return. Default value: 20. Maximum value: 100 |

### Queries optimization tasks in a specified AgentSpace by using paging and returns the task status,…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-optimize-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| type | string | no | The task type |
| status | string | no | The task status |
| nextToken | string | no | The pagination token |
| maxResults | integer | no | The maximum number of results to return. Default value: 20. Maximum value: 100 |

### Queries the run history. Supports filtering by status, trigger type, and time range, and cursor-based…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-pipeline-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| pipelineName | string | yes | The name of the pipeline |
| status | string | no | Filters runs by status. Valid values: Pending, Running, Succeeded, Failed, and Cancelled. If you do not specify this parameter, no… |
| triggerType | string | no | Filters runs by trigger type. Valid values: Continuous, RunOnce, and Scheduled. If you do not specify this parameter, no filtering is… |
| startTime | integer | no | The lower bound for filtering by trigger time (triggered_at >= startTime), in UNIX seconds |
| endTime | integer | no | The upper bound for filtering by trigger time (triggered_at <= endTime), in UNIX seconds |
| nextToken | string | no | The pagination token. Pass the nextToken value from the previous response to retrieve the next page. Do not specify this parameter for the… |
| maxResults | integer | no | The maximum number of entries to return in the current request. Default value: 50. Maximum value: 200 |

### Queries a list of pipelines. Supports filtering by name, schedule type, and schedule status, and…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/list-pipelines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace whose pipelines you want to list |
| pipelineName | string | no | The name of the pipeline. Supports exact matching. If not specified, the results are not filtered by pipeline name |
| scheduleType | string | no | The schedule type. Valid values: RunOnce (single execution), Scheduled (periodic scheduling), and Continuous (continuous execution driven… |
| scheduleStatus | string | no | The schedule status. Valid values: None (no schedule), Active (active), Paused (paused), and Terminated (terminated). If not specified,… |
| nextToken | string | no | The pagination token. Pass the nextToken value from the previous response to retrieve the next page of results. Do not specify this… |
| maxResults | integer | no | The maximum number of pipelines to return in the current request. Default value: 20. Maximum value: 100 |
| sinkName | string | no | The name of the output dataset. Supports exact matching and applies to standard sinks, conditional branch sinks, and default sinks. If not… |

### Pauses a pipeline
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/pause-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace where the pipeline is located |
| pipelineName | string | yes | The name of the pipeline to pause |
| reason | string | no | The reason for pausing the pipeline |

### Previews a pipeline. Runs a trial query based on the specified data source, node orchestration, and time…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/preview-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace where the pipeline is located |
| fromTime | integer | no | The start time of the preview data window. The value is a UNIX timestamp in seconds |
| pipeline | object | no | The pipeline configuration, including node orchestration |
| source | object | no | The data source of the pipeline |
| toTime | integer | no | The end time of the preview data window. The value is a UNIX timestamp in seconds |

### Resumes a pipeline
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/resume-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace where the pipeline is located |
| pipelineName | string | yes | The name of the pipeline to be resumed |

### Manually triggers a pipeline execution
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/run-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace where the pipeline is located |
| pipelineName | string | yes | The name of the pipeline to be triggered |
| fromTime | integer | no | The start time of the data processing window in UNIX seconds. This parameter is required for SQL pipelines and time window-based WorkItem… |
| output | object | no | The output control settings. SQL pipelines support overriding these settings. WorkItem pipelines use the saved sink configurations and… |
| toTime | integer | no | The end time of the data processing window in UNIX seconds. It must be provided together with fromTime and must be greater than fromTime.… |

### Searches the context
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/search-context` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace. The length must be 2 to 64 characters |
| contextStoreName | string | yes | The name of the context store. The length must be 2 to 64 characters |
| filter | object | no | The structured filter conditions. The key is the field name, and the value is the expected match value |
| formatted | string | no | Specifies whether to apply structured formatting to the returned results |
| includeInactive | string | no | Specifies whether to include memories whose sourceState is inactive. Default value: false |
| limit | integer | no | The maximum number of returned results, which corresponds to the top N results by similarity |
| query | string | yes | The retrieval query text. Natural language is supported |
| retrievalOption | string | no | The retrieval options used to control the retrieval strategy |
| scope | object | no | The recall scope. If a field with the same name conflicts with the filter, a 400 ScopeFilterConflict error is returned |
| strategyIds | array | no | Filters results by extraction strategy ID. Multiple IDs in the list are evaluated with an OR condition. If this parameter is not… |
| threshold | number | no | The similarity threshold. Results with a similarity score below this value are filtered out. Valid values: 0 to 1 |

### Terminates a pipeline
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/terminate-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace where the pipeline is located |
| pipelineName | string | yes | The name of the pipeline to be terminated |
| reason | string | no | The reason for termination |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| cmsWorkspace | string | no | The CloudMonitor 2.0 workspace |
| description | string | no | The description |
| clientToken | string | no | The idempotency token. A unique string generated by the client to ensure the idempotence of the update operation |

### Updates the context store configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/update-context-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace. The name must be 2 to 64 characters in length |
| contextStoreName | string | yes | The name of the context store to be updated. The name must be 2 to 64 characters in length |
| changeNote | string | no | The description of the policy change. A new policy version is created when policy fields in the configuration are changed |
| config | object | no | The context library configuration. If specified, the entire configuration is overwritten. If omitted, the original configuration is retained |
| contextType | string | no | The context library type. This field generally cannot be modified after creation and is provided only for exception correction |
| description | string | no | The description of the context library, which helps business users understand its purpose |
| status | string | no | The running status. Valid values: Active and Paused. For the memory type, pausing stops data source reading and extraction. For the… |
| clientToken | string | no | The idempotency token, which is a unique string generated by the client to ensure the idempotence of the update operation |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the agent space |
| datasetName | string | yes | The name of the dataset |
| description | string | no | The description of the dataset |
| renames | array | no | The field renames for the dataset |
| schema | object | no | The table schema of the dataset |
| clientToken | string | no | The idempotency token. A unique string generated by the client to ensure that the update operation is idempotent |

### Updates an evaluation run
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/update-evaluation-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| taskId | string | yes | The evaluation task ID |
| runId | string | yes | The evaluation run ID |
| status | string | no | The target status. Currently, only stop-related statuses are supported |

### Updates an evaluation task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/update-evaluation-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| taskId | string | yes | The evaluation task ID |
| config | object | no | The new task configuration. Some fields that are set during creation cannot be modified |
| dataFilter | string | no | The filter conditions for evaluation data. JSON objects and JSON strings are supported |
| description | string | no | The description of the evaluation task |
| evaluators | array | no | The new list of evaluator configurations. When specified, this list entirely replaces the existing evaluator list of the task, and the… |
| runStrategies | object | no | The new task execution strategies. JSON objects and JSON strings are supported. If the task is in the `Completed`, `Terminated`, or… |
| status | string | no | The task status. Currently, the backend only allows users to manually set this to `Terminated`. Other statuses are managed by the system |
| tags | object | no | The key-value pairs of task tags. You do not need to specify this parameter by default. Specify this parameter only when you want to… |
| clientToken | string | no | The idempotency token. CloudSpec declares this query parameter, but the backend does not currently perform idempotency checks |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| name | string | yes | The evaluator name |
| annotations | array | no | The list of annotation tags |
| config | object | no | The configuration of the new version. This parameter is typically required when `version` is specified |
| description | string | no | The evaluator description |
| displayName | string | no | The display name |
| properties | object | no | The evaluator properties |
| version | string | no | The new version number. A new version is created when this parameter is specified |
| versionDescription | string | no | The version description |
| clientToken | string | no | The idempotency token. CloudSpec declares this query parameter, but the backend does not currently perform idempotency comparison |

### Updates an evaluator skill
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/update-evaluator-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| name | string | yes | The evaluator name |
| skillName | string | yes | The skill name |
| agentSpace | string | yes | The AgentSpace name |
| description | string | no | The description of the skill |
| displayName | string | no | The display name of the skill |
| enable | string | no | Specifies whether to enable the skill |
| files | array | no | The list of skill files. When provided, the skill file content is updated |
| clientToken | string | no | The idempotency token. CloudSpec declares this query parameter, but the backend does not currently perform idempotency comparison |

### Updates an experiment plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/update-experiment-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| datasetId | string | no | The ID of the associated dataset |
| datasetProject | string | no | Optional |
| description | string | no | The description |
| evaluators | array | no | The list of evaluators. If this parameter is omitted, the list remains unchanged. If an empty array is passed, the list is cleared |
| experimentType | string | no | The experiment type. Valid values: OFFLINE (offline experiment) and ONLINE (online experiment) |
| experiments | array | no | The list of experiment configurations. When passed, the entire list is replaced. The number of items must be between 1 and 5 |
| input | object | no | Optional |
| pipelineName | string | no | The name of the associated data processing pipeline. This parameter is optional. If it is not passed, the association is not updated. If… |
| planName | string | no | The name of the experiment plan |
| querySql | string | no | The custom query SQL clause in partial dataset mode |
| selectedItemIds | array | no | The list of selected data item IDs in partial dataset mode. If an empty array is passed, the list is cleared |
| planId | string | yes | The ID of the experiment plan |

### Updates an experiment run
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/update-experiment-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The AgentSpace name |
| recordId | string | yes | The experiment record ID |
| clientToken | string | no | Optional |
| completedAt | integer | no | The experiment completion time. This value is a millisecond-level UNIX timestamp |
| completedTasks | integer | no | The number of completed tasks |
| executedAt | integer | no | The experiment execution time. This value is a millisecond-level UNIX timestamp |
| failedTasks | integer | no | The number of failed tasks |
| recordName | string | no | The experiment record name |
| status | string | no | The experiment record status. Set this parameter to cancelled to cancel the execution |
| totalTasks | integer | no | The total number of tasks |

### Cancels a run or retries a failed artifact application. To cancel a run, set status to Cancelled. To retry a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/update-optimize-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| optimizeTaskName | string | yes | The name of the optimization task |
| optimizeRunId | string | yes | The ID of the execution instance |
| extra | object | no | The extra parameters. To retry a failed artifact application, set application.action to retry and do not specify status. Do not specify… |
| status | string | no | The status. Only Cancelled is supported when canceling a run. The execution status is maintained by the server. Do not specify this field… |
| clientToken | string | no | The idempotency token |

### Updates the status and type-related configurations of a specified optimization task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/update-optimize-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace |
| optimizeTaskName | string | yes | The name of the optimization task |
| config | object | no | The type-related configurations. Optional prompts for ExperienceMining or SkillOptimize support only inline Markdown, and the body is… |
| status | string | no | The status of the task. Valid values: Enabled and Disabled |
| clientToken | string | no | The idempotency token |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://agentloop.ap-southeast-1.aliyuncs.com |
| agentSpace | string | yes | The name of the AgentSpace where the pipeline to be updated is located |
| pipelineName | string | yes | The name of the pipeline to be updated |
| description | string | no | The description of the pipeline, which helps business users understand its purpose |
| executePolicy | object | no | The scheduling policy. If this parameter is specified, the existing policy is completely overwritten |
| pipeline | object | no | The pipeline configuration, which defines node orchestration. If this parameter is specified, the existing configuration is completely… |
| sink | object | no | The pipeline sink (data write destination). Passing this parameter overwrites the entire configuration |
| source | object | no | The pipeline data source. Passing this parameter overwrites the entire configuration |
| clientToken | string | no | The idempotency token. It is a unique string generated by the client to ensure the idempotence of the update operation |

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

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

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-agentloop/add-dataset-data" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

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

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

### Can AI agents use the Alibaba Cloud AgentLoop 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-agentloop.

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