# Alibaba Cloud Platform for Artificial Intelligence PAI - AutoML API

> Alibaba Cloud Platform for Artificial Intelligence PAI - AutoML API on Apizie: 19 endpoints (CreateAutofeExperiment, calling HPO CreateExperiment, Creates a service-linked role, Deletes a hyperparameter optimization (HPO) experiment. After you delete the experiment, you cannot obtain…, …) 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://apizie.tech/v1/cloud:aliyun-paiautoml/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-paiautoml`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/paiautoml
- Page: https://apizie.tech/api/cloud/aliyun-paiautoml
- OpenAPI: https://apizie.tech/api/cloud/aliyun-paiautoml/openapi.json

Alibaba Cloud OpenAPI for Platform for Artificial Intelligence PAI - AutoML (paiautoml, version 2022-08-28). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### CreateAutofeExperiment
`POST https://apizie.tech/v1/cloud:aliyun-paiautoml/create-autofe-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Accessibility | string | no | The visibility of the experiment in the workspace. Valid values: PRIVATE: The experiment is visible only to you and the administrator of… |
| AutofeExperimentConfiguration | object | no | The AutoFE experiment required configurations |
| Description | string | no | The description of the experiment |
| Name | string | yes | The name of the experiment |
| Tag | array | no | The list of tags. You can specify a maximum of 20 tags |
| WorkspaceId | string | no | The workspace ID |

### calling HPO CreateExperiment
`POST https://apizie.tech/v1/cloud:aliyun-paiautoml/create-hpo-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Accessibility | string | no | The visibility of the code configuration. Valid values: PUBLIC: The configuration is public in the workspace. PRIVATE: The configuration… |
| Description | string | no | The description of the experiment |
| HpoExperimentConfiguration | object | no | The parameter struct of the HPO experiment configuration |
| Name | string | no | The name of the experiment |
| Tag | array | no | Tag information |
| WorkspaceId | string | no | The workspace ID |

### Creates a service-linked role
`POST https://apizie.tech/v1/cloud:aliyun-paiautoml/create-service-identity-role` (byok)

### Deletes a hyperparameter optimization (HPO) experiment. After you delete the experiment, you cannot obtain…
`POST https://apizie.tech/v1/cloud:aliyun-paiautoml/delete-hpo-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | The ID of the experiment |

### Get AutoFE Experiment
`GET https://apizie.tech/v1/cloud:aliyun-paiautoml/get-autofe-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | Experiment ID |

### Queries the information about a hyperparameter optimization (HPO) experiment, including the status and…
`GET https://apizie.tech/v1/cloud:aliyun-paiautoml/get-hpo-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | The ID of the HPO experiment |

### Queries information about a trial in a hyperparameter optimization (HPO) experiment
`GET https://apizie.tech/v1/cloud:aliyun-paiautoml/get-hpo-trial` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | The ID of the experiment |
| TrialId | string | yes | trial id |

### GetServiceIdentityRole, return role name if SLR exists, empty otherwise
`GET https://apizie.tech/v1/cloud:aliyun-paiautoml/get-service-identity-role` (byok)

### Queries the content of a log file for a hyperparameter optimization (HPO) experiment
`GET https://apizie.tech/v1/cloud:aliyun-paiautoml/list-hpo-experiment-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | The ID of the HPO experiment |
| LogName | string | no | The name of the log. Valid values: nnimanager.log and dispatcher.log |
| PageNumber | integer | no | The page number. Page start from page 1. If you leave this parameter empty, all content in the log file is returned |
| PageSize | integer | no | The number of entries per page. If you leave this parameter empty, all content in the log file is returned |

### Queries information about a hyperparameter optimization (HPO) experiment that meets specific requirements
`GET https://apizie.tech/v1/cloud:aliyun-paiautoml/list-hpo-experiments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | no | The keyword of the name of the experiment |
| Creator | string | no | The ID of the user who created the experiment |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page |
| MinCreateTime | string | no | The earliest experiment creation time |
| MaxCreateTime | string | no | The latest experiment creation time |
| Status | string | no | The status of the experiment |
| WorkspaceId | string | no | The workspace ID |
| Accessibility | string | no | The visibility of the workspace. PRIVATE: The workspace is visible only to you and the administrator of the workspace. PUBLIC: The… |
| IncludeConfigData | string | no | Specifies whether to include experiment configuration data in the response |
| SortBy | string | no | The filter that is used to sort experiments |
| Order | string | no | The sorting order. Specify this parameter together with the SortBy parameter. Valid values: DESC: in descending order. This is the default… |
| Tag | string | no | Resource tags (JSON-encoded) |

### Queries the command output of a trial in a hyperparameter optimization (HPO) experiment. A trial of an HPO…
`GET https://apizie.tech/v1/cloud:aliyun-paiautoml/list-hpo-trial-commands` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | The ID of the HPO experiment |
| TrialId | string | yes | The ID of the trial |

### Lists the names of all log files of the specific trial in a specific hyperparameter optimization (HPO)…
`GET https://apizie.tech/v1/cloud:aliyun-paiautoml/list-hpo-trial-log-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | The ID of the HPO experiment |
| TrialId | string | yes | Trial id |

### Lists the content of a specific log file of a hyperparameter optimization (HPO) trial by pages
`GET https://apizie.tech/v1/cloud:aliyun-paiautoml/list-hpo-trial-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | The ID of the HPO experiment |
| TrialId | string | yes | The ID of the trial |
| LogName | string | no | The name of the log. Valid values: stderr, stdout, and trial.log |
| PageNumber | integer | no | The page number. Pages start from page 1. If you leave this parameter empty, all content in the log file is returned |
| PageSize | integer | no | The number of log entries returned on each page. The value must be a positive integer. If you leave this parameter empty, all content in… |

### Returns all the trials for the specified experiment ID
`GET https://apizie.tech/v1/cloud:aliyun-paiautoml/list-hpo-trials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | The ID of the HPO experiment |
| PageNumber | integer | no | The page number to return. Pages start from 1. You can use this parameter to search for HPO experiments |
| PageSize | integer | no | The number of entries per page |
| SortBy | string | no | The basis for sorting |
| Order | string | no | The order of specific fields of results in a paged query (ascending or descending). Default value: ASC. ASC Ascend DESC Descend |

### Restarts failed trials in an hyperparameter optimization (HPO) experiment. The system extracts the…
`POST https://apizie.tech/v1/cloud:aliyun-paiautoml/restart-hpo-trials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | The ID of the experiment |
| TrialHyperParameters | string | no | A new hyperparameter configuration of a trial. The system starts a new trial by using this configuration |
| TrialIds | array | no | The IDs of the trials that you want to restart |

### Stops a hyperparameter optimization (HPO) experiment, including its trials and the backend tasks
`POST https://apizie.tech/v1/cloud:aliyun-paiautoml/stop-hpo-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | The ID of the experiment that you want to stop |

### Stops specific trials in a hyperparameter optimization (HPO) experiment and the backend tasks of the trials
`POST https://apizie.tech/v1/cloud:aliyun-paiautoml/stop-hpo-trials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | The ID of the experiment |
| TrialIds | array | no | The IDs of the trials that you want to stop. If you leave this parameter empty, no trial is stopped |

### Updates the configurations of a running hyperparameter optimization (HPO) experiment. After you update the…
`POST https://apizie.tech/v1/cloud:aliyun-paiautoml/update-hpo-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExperimentId | string | yes | The ID of the HPO experiment |
| Accessibility | string | no | The visibility of the experiment in the workspace. Valid values: PRIVATE: The experiment is visible only to you and the administrator of… |
| Description | string | no | The description of the experiment |
| HpoExperimentConfiguration | object | no | The parameter struct of the HPO experiment configuration |
| Name | string | no | The name of the experiment |
| Tag | array | no | Tag information |
| WorkspaceId | string | no | The workspace ID |

### version
`POST https://apizie.tech/v1/cloud:aliyun-paiautoml/version` (byok)

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-paiautoml/create-autofe-experiment" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Platform for Artificial Intelligence PAI - AutoML API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-paiautoml/create-autofe-experiment with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Platform for Artificial Intelligence PAI - AutoML API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-paiautoml.

### What is the status of the Alibaba Cloud Platform for Artificial Intelligence PAI - AutoML API?
Needs your own provider key (bring your own key)