API overview-AgentLoop(AgentLoop)-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (AgentLoop/2026-05-20) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Context library

API	Title	Description
CreateContextStore	Create a context store	Creates a context store.
DeleteContextStore	Delete a context store	Deletes a context store.
SearchContext	Search context	Searches the context.
GetContextStore	Query context store	Queries the context store.
GetContextStoreAPIKey	Retrieve an API key	Retrieves an API key.
ListContextStoreAPIKeys	List API keys	Retrieves a list of API keys.
ListContextStores	List context stores	Queries the list of context stores.
CreateContextStoreAPIKey	Create an API key	Creates an API key.
DeleteContextStoreAPIKey	Delete an API key	Deletes an API key.

Data processing

API	Title	Description
TerminatePipeline	Terminate a pipeline	Terminates a pipeline.
RunPipeline	Manually trigger a pipeline execution	Manually triggers a pipeline execution.
ResumePipeline	Resume pipeline	Resumes a pipeline.
PreviewPipeline	Preview a pipeline	Previews a pipeline. Runs a trial query based on the specified data source, node orchestration, and time range without creating pipeline resources, and returns a small amount of sample data to authenticate parameter settings and preview processing results.
PausePipeline	Pause a pipeline	Pauses a pipeline.
ListPipelineRuns	Query pipeline run history	Queries the run history. Supports filtering by status, trigger type, and time range, and cursor-based pagination.
GetPipelineStats	Query pipeline run statistics	Queries the pipeline run statistics.
GetPipelineRun	Retrieve pipeline run details	Queries the details of a single run, including the data window, execute status, retry information, run statistics, and fault message.
CreatePipeline	Create a pipeline	Creates a pipeline.
DeletePipeline	Delete a pipeline	Deletes a pipeline.
CancelPipelineRun	Cancel a pipeline run	Cancels a pipeline run.
UpdatePipeline	Update a pipeline	Updates a pipeline.
GetPipeline	Query a pipeline	Queries a pipeline.
ListPipelines	List pipelines	Queries a list of pipelines. Supports filtering by name, schedule type, and schedule status, and cursor-based pagination.

Regions

API	Title	Description
DescribeRegions	Query region information	Queries regions.

Datasets

API	Title	Description
AddDatasetData	Append data to a dataset	Appends structured data rows to a specified dataset without requiring the client to construct SQL statements.
ExecuteQuery	Execute a statement	Executes a query statement.
UpdateDataset	Update a dataset	Updates a dataset.
CreateDataset	Create a dataset	Creates a dataset.
DeleteDataset	Delete a dataset	Deletes a dataset.
ListDatasets	List datasets	Queries a list of datasets.
GetDataset	Get dataset	Queries a dataset.

Agent space

API	Title	Description
CreateAgentSpace	Create an agentSpace	Creates an AgentSpace.
UpdateAgentSpace	Update an agentSpace	Updates an AgentSpace.
ListAgentSpaces	List agentSpaces	Queries a list of AgentSpaces.
GetAgentSpace	Query agentSpace information	Queries the AgentSpace.
DeleteAgentSpace	Delete an agentSpace	Deletes an AgentSpace.

Evaluation

API	Title	Description
Evaluation tasks	Evaluation tasks
ListEvaluationTasks	Query evaluation tasks	Queries a list of evaluation tasks.
GetEvaluationTask	Query evaluation task details	Retrieves the details of an evaluation task.
CreateEvaluationTask	Create an evaluation task	Creates an evaluation task.
UpdateEvaluationTask	Update an evaluation task	Updates an evaluation task.
DeleteEvaluationTask	Delete a model evaluation task	Deletes a model evaluation task.
ListEvaluationRuns	Query evaluation runs	Queries the list of evaluation runs.
GetEvaluationRun	Get evaluation run details	Retrieves the details of an evaluation run.
UpdateEvaluationRun	Update an evaluation run	Updates an evaluation run.
DeleteEvaluationRun	Delete an evaluation run	Deletes an evaluation run.
Evaluators	Evaluators
ListEvaluators	Query evaluator list	Queries a list of evaluators.
GetEvaluator	Get evaluator details	Retrieves the details of an evaluator.
CreateEvaluator	Create an evaluator	Creates an evaluator.
UpdateEvaluator	Update an evaluator	Updates an evaluator.
DeleteEvaluator	Delete an evaluator	Deletes an evaluator.
ListEvaluatorSkills	Query evaluator skill list	Queries the list of skills for an evaluator.
GetEvaluatorSkill	Retrieve evaluator skill details	Retrieves the details of an evaluator skill.
CreateEvaluatorSkill	Create an evaluator skill	Creates an evaluator skill.
UpdateEvaluatorSkill	Update evaluator skill	Updates an evaluator skill.
DeleteEvaluatorSkill	Delete an evaluator skill	Deletes an evaluator skill.

Others

API	Title	Description
CreateExperimentPlan	Create an experiment plan	Creates an experiment plan.
CreateExperimentRun	Execute an experiment	Executes an experiment.
DeleteExperimentPlan	Delete an experiment plan	Deletes an experiment plan.
DeleteExperimentRun	Delete an experiment record	Deletes an experiment record.
GetExperimentPlan	Query an experiment plan	Queries an experiment plan.
GetExperimentRun	Query experiment run details	Queries the details of an experiment run.
ListExperimentPlans	List experiment plans	Queries the list of experiment plans.
ListExperimentRuns	List experiment runs	Queries a list of experiment runs.
UpdateExperimentPlan	Update experiment plan	Updates an experiment plan.
UpdateExperimentRun	Update an experiment run	Updates an experiment run.
CreateDatasetVersion	Create a dataset version	Creates a named historical version for a dataset in a specified agent workspace to preserve the historical state of the dataset. You can call ListDatasetVersions to query version information. If a version is no longer needed, you can call DeleteDatasetVersion to delete the version.
DeleteDatasetVersion	Delete a dataset version	Deletes a historical version of a dataset in a specified agent workspace. After deletion, the version no longer appears in the list returned by ListDatasetVersions. This operation does not delete the dataset itself, the current data, or other historical versions.
ListDatasetVersions	List dataset versions	Performs a paged query to retrieve the historical versions of a dataset in a specified agent workspace and returns the version names, descriptions, and creation time. Deleted versions are not included in the list. Do not specify nextToken in the first request. For subsequent requests, use the nextToken value from the previous response for paging to retrieve the next page.
CreateOptimizeRun	Create an optimization task run	Creates a run for the specified optimization task and returns the run ID. When preview is set to true, an independent pre-run is executed to generate candidate results and evidence. The pre-run does not publish candidate artifacts or advance the formal run history.
CreateOptimizeTask	Create an optimization task	Creates an optimization task in a specified AgentSpace, and configures the task type, status, and type-specific parameters. Optional prompts only support inline Markdown.
DeleteOptimizeTask	Delete an optimization task	Deletes an optimization task in a specified AgentSpace.
GetOptimizeRun	Query an optimization task run	Queries the status, errors, execution progress, type-related results, and artifact references of a specified run.
GetOptimizeTask	Query optimization task	Queries the type, status, configuration, and scheduling checkpoint of a specified optimization task.
ListOptimizeRuns	List optimization task runs	Queries the run records of a specified optimization task by using paging. Complete result references and frozen outputs are queried by calling GetOptimizeRun.
ListOptimizeTasks	List optimization tasks	Performs a paging query on the optimization tasks in a specified AgentSpace and returns the task status, configurations, and scheduling checkpoints.
UpdateOptimizeRun	Cancel a run or retry an artifact application	Cancels a run or retries a failed artifact application. To cancel a run, set status to Cancelled. To retry a failed artifact application, set extra.application.action to retry and do not specify status.
UpdateOptimizeTask	Update an optimization task	Updates the status and type-related configurations of a specified optimization task.