# Alibaba Cloud AIRec API

> Alibaba Cloud AIRec API on Apizie: 145 endpoints (Uses a dataset of a specified version of a specified instance to provide online services, Brings a specified index version online, Checks the network connectivity of a ranking model, Clones an experiment, …) 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-airec/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for AIRec (airec, version 2020-11-26). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Uses a dataset of a specified version of a specified instance to provide online services
`POST https://apizie.tech/v1/cloud:aliyun-airec/attach-dataset` (byok)

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

### Brings a specified index version online
`POST https://apizie.tech/v1/cloud:aliyun-airec/attach-index-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| algorithmId | string | yes | The retrieval configuration ID |
| versionId | string | yes | The index version ID |

### Checks the network connectivity of a ranking model
`GET https://apizie.tech/v1/cloud:aliyun-airec/check-ranking-model-reachable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| rankingModelId | string | yes | The ID of the ranking model |

### Clones an experiment
`POST https://apizie.tech/v1/cloud:aliyun-airec/clone-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scene ID |
| dryRun | string | no | true: verifies experiment information. false (default): creates an experiment |
| experimentId | string | yes | The experiment ID |

### Clones a sample
`POST https://apizie.tech/v1/cloud:aliyun-airec/clone-sample` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sampleId | string | yes | The sample ID |

### Creates a custom analysis task
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-custom-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| type | string | yes | The query type. For example, ITEM_CUSTOM is a custom analysis of the item dimension |
| instanceId | string | yes | The instance ID |

### Creates a custom sample
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-custom-sample` (byok)

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

### Creates a data diagnostic task
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-data-diagnose-task` (byok)

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

### Creates a data source
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-extra-data-source` (byok)

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

### Creates a filtering table. After the filtering table is trained on Machine Learning Platform for AI (PAI),…
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-filtering-algorithm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The state of the filtering table |
| dryRun | string | no | xxx |

### Creates a throttling task
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-flow-control-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| dryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request |

### Creates an Artificial Intelligence Recommendation (AIRec) instance
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-instance` (byok)

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

### Creates a ranking model
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-ranking-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| dryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Checks the request parameters. The model is not created. false: The default… |

### Creates a ranking model template
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-ranking-model-template` (byok)

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

### Creates a ranking service
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-ranking-system` (byok)

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

### Creates a rule
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-rule` (byok)

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

### Creates a sample format configuration
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-sample-format-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sampleId | string | yes | The sample ID |
| body | object | no | The request body parameters |

### Verify the information for scenario creation
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| dryRun | string | no | Specifies whether to perform a dry run. \true:\ Checks whether the scenario ID exists. \false:\ Creates the scenario. This is the default… |

### Creates a Umeng authorization token
`POST https://apizie.tech/v1/cloud:aliyun-airec/create-umeng-token` (byok)

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

### Queries the information of a ranking model
`GET https://apizie.tech/v1/cloud:aliyun-airec/decribe-ranking-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| rankingModelId | string | yes | The ID of the ranking model |

### Deletes a dataset of a specified version for an instance
`POST https://apizie.tech/v1/cloud:aliyun-airec/delete-data-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| versionId | string | yes | The version number of the dataset |

### Deletes an experiment
`POST https://apizie.tech/v1/cloud:aliyun-airec/delete-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scene ID |
| experimentId | string | yes | The experiment ID |

### Deletes a data source
`POST https://apizie.tech/v1/cloud:aliyun-airec/delete-extra-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| type | string | yes | The type of the data source. Valid values: UserCustomDataSource: The user data source. ItemCustomDataSource: The item data source.… |
| dataSourceId | string | yes | The data source ID |

### Deletes the configurations of a specified filtering table and the information about the related index table
`POST https://apizie.tech/v1/cloud:aliyun-airec/delete-filtering-algorithm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| algorithmId | string | yes | The ID of the specified filtering table |

### Deletes a throttling task
`POST https://apizie.tech/v1/cloud:aliyun-airec/delete-flow-control-task` (byok)

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

### Deletes a ranking model
`POST https://apizie.tech/v1/cloud:aliyun-airec/delete-ranking-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| rankingModelId | string | yes | The ranking model ID |

### You can delete a model
`POST https://apizie.tech/v1/cloud:aliyun-airec/delete-ranking-model-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| templateId | string | yes | The ID of the ranking model template |

### Deletes a model version
`POST https://apizie.tech/v1/cloud:aliyun-airec/delete-ranking-model-version` (byok)

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

### Deletes a sorting service
`POST https://apizie.tech/v1/cloud:aliyun-airec/delete-ranking-system` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| name | string | yes | The name of the sorting service |

### Deletes a sample
`POST https://apizie.tech/v1/cloud:aliyun-airec/delete-sample` (byok)

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

### Deletes a scenario
`POST https://apizie.tech/v1/cloud:aliyun-airec/delete-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scenario ID |

### Deploys or redeploys a ranking service. For a ranking service that has been deployed, you need to redeploy…
`POST https://apizie.tech/v1/cloud:aliyun-airec/deploy-ranking-system` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The name of the ranking service |
| name | string | yes | The configuration that you want to modify |
| body | object | no | The schema of the response parameters |

### Retrieves the base experiment
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-base-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scene ID |

### Queries the results of a custom analysis task for a specified instance
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-custom-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instanceId |
| type | string | yes | The type |
| taskId | string | yes | The taskId |

### Queries the details of data errors for a specific dataset version in a specific instance
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-data-set-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| versionId | string | yes | The version ID |

### Queries the information of default algorithms
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-default-algorithms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scene ID |

### Queries the details of an experiment
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scenario ID |
| experimentId | string | yes | The experiment ID |

### Queries information about an experiment scenario
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-experiment-env` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scenario ID |

### Queries the activation status of an experiment scenario
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-experiment-env-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scenario ID |

### Queries the configurations of a filtering table based on the ID of the filtering table
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-filtering-algorithm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The name of the filtering algorithm |
| algorithmId | string | yes | The delimiter that is used to separate items |

### Queries the details about an instance based on the instance ID
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-instance` (byok)

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

### Retrieves the most recent build task
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-latest-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| algorithmId | string | yes | The specified recall ID |

### Queries the quotas of an instance based on a specified instance ID
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-quota` (byok)

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

### Queries available Alibaba Cloud regions
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| acceptLanguage | string | no | The language of the response. Default value: zh-cn |

### Queries detailed information about a rule
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the rule |
| ruleId | string | yes | The ID of the scene |
| sceneId | string | yes | The type of the rule. Valid values: selection and operation |
| ruleType | string | yes | The returned result |

### Queries the details of a scenario
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scenario ID |

### Queries the experiment bucket distribution in a scenario
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-scene-bucket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scene ID |

### Queries the traffic of a scenario
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-scene-throughput` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scenario ID |

### Retrieves the details of hourly real-time data reports
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-sync-report-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| startTime | integer | yes | The start time as a UNIX timestamp in seconds |
| endTime | integer | yes | The end time as a UNIX timestamp in seconds |
| type | string | yes | The table type. Valid values: \`behavior\`, \`item\`, and \`user\` |
| levelType | string | yes | The severity level. Valid values: \`error\`, \`warn\`, and \`info\` |

### Retrieves outlier details from a real-time data sync report
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-sync-report-outliers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| startTime | integer | yes | The start time. This is a UNIX timestamp in seconds |
| key | string | yes | itemBhv Indicates whether the item ID from the real-time behavior record exists in the item database. userBhv Indicates whether the user… |
| type | string | yes | The name of the data table. Valid values: behavior, item, and user |
| endTime | integer | yes | The end time. This is a UNIX timestamp in seconds |
| levelType | string | yes | The level of the outlier. Valid values: error, warn, and info |

### Queries user metrics related to the conversion rate
`GET https://apizie.tech/v1/cloud:aliyun-airec/describe-user-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| startTime | integer | yes | The start time. The value is a timestamp in seconds |
| endTime | integer | yes | The end time. The value is a timestamp in seconds |
| metricType | string | yes | The type of the user metric that you want to query. Valid values: pvCtr and uvCtr |
| instanceId | string | yes | The instance ID |

### Decreases the quotas of a specified instance
`POST https://apizie.tech/v1/cloud:aliyun-airec/downgrade-instance` (byok)

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

### Enables an experiment
`POST https://apizie.tech/v1/cloud:aliyun-airec/enable-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scenario ID |

### Generates a sample. This operation is applicable only to samples created by replication
`POST https://apizie.tech/v1/cloud:aliyun-airec/generate-sample` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sampleId | string | yes | The sample ID |

### Retrieves the details of an extra data source
`GET https://apizie.tech/v1/cloud:aliyun-airec/get-extra-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| type | string | yes | The type of the data source. Valid values: UserCustomDataSource ItemCustomDataSource BehaviorCustomDataSource SampleCustomDataSource |
| dataSourceId | string | yes | The data source ID |

### Obtains the details of a throttling task
`GET https://apizie.tech/v1/cloud:aliyun-airec/get-flow-control-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| taskId | string | yes | The task ID |

### Retrieves the status of the latest diagnostic task
`GET https://apizie.tech/v1/cloud:aliyun-airec/get-latest-data-diagnose-task-status` (byok)

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

### Queries the details of a ranking model configuration
`GET https://apizie.tech/v1/cloud:aliyun-airec/get-ranking-model-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| templateId | string | yes | The ranking model template ID |

### Retrieves the details of a ranking model version, including its evaluation and training results
`GET https://apizie.tech/v1/cloud:aliyun-airec/get-ranking-model-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| versionId | string | yes | The model version ID |

### Retrieves the details of a sorting service
`GET https://apizie.tech/v1/cloud:aliyun-airec/get-ranking-system` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| name | string | yes | The service name |

### Queries a sorting service for its operation records
`GET https://apizie.tech/v1/cloud:aliyun-airec/get-ranking-system-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| name | string | yes | The name of the sorting service |
| operateId | string | yes | The ID of the operation record |

### Retrieves the details of a sample
`GET https://apizie.tech/v1/cloud:aliyun-airec/get-sample` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sampleId | string | yes | The sample ID |
| withExtendParmas | string | no | Specifies whether to return extended parameters. true: Extended parameters are returned. false: Extended parameters are not returned |

### Initializes a computing resource
`POST https://apizie.tech/v1/cloud:aliyun-airec/init-computing-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| type | string | no | The type of the computing resource. The value must be MAX_COMPUTE |
| key | string | no | The name of the MaxCompute workspace. This parameter is required when type is set to MAX_COMPUTE |

### Queries detailed metrics for a specified instance
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-dashboard-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| startTime | integer | yes | The start time. This is a UNIX timestamp in seconds |
| endTime | integer | yes | The end time. This is a UNIX timestamp in seconds |
| traceIds | string | yes | The trace ID. This must be consistent with the data specifications |
| sceneIds | string | yes | The scene ID |
| metricType | string | yes | The metric to query. This is an enumeration. USER_ACTION_PV_COUNT: The total traffic volume in page views (PVs). USER_ACTION_UV_COUNT: The… |
| experimentIds | string | no | A list of experiment IDs. Set this parameter to \`all\` to query the overall effect at the scene level. The default value is \`all\` |
| matchTypes | string | no | A list of match types |

### Queries the traffic metrics details for a specified instance
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-dashboard-details-flows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| startTime | integer | yes | The UNIX timestamp in seconds |
| endTime | integer | yes | The UNIX timestamp in seconds |
| traceIds | string | yes | The trace ID |
| sceneIds | string | yes | The scene ID |
| metricType | string | yes | The metric to query. Valid values: USER_ACTION_PV_COUNT: The total number of page views (PVs). USER_ACTION_UV_COUNT: The total number of… |
| experimentIds | string | no | A list of experiment IDs. Set this parameter to \`all\` to query the overall data at the scene level. The default value is \`all\` |

### Queries the dashboard metrics for a specified instance
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-dashboard-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| startTime | integer | yes | The start time. This is a UNIX timestamp in seconds |
| endTime | integer | yes | The end time. This is a UNIX timestamp in seconds |
| metricType | string | no | The metric type. Valid values: USER_ACTION_PV_COUNT: Total page views (PVs). USER_ACTION_UV_COUNT: Total unique visitors (UVs).… |
| metricView | string | no | The dimension of the query. This parameter is used with \`metricQuery\`. The default value is \`USER\`. Valid values are \`USER\` (the… |
| metricQuery | string | no | The query condition. The format is k1:v1;k2:v2 |

### Queries the traffic data of a specified instance from the dashboard
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-dashboard-metrics-flows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| startTime | integer | yes | The UNIX timestamp in seconds |
| endTime | integer | yes | The UNIX timestamp in seconds |
| metricType | string | yes | The metric type. USER_ACTION_PV_COUNT: The total number of page views (PVs). USER_ACTION_UV_COUNT: The total number of unique visitors… |

### Retrieves data diagnostic reports. These reports include manually triggered diagnostics, daily reports, and…
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-data-diagnose-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| taskCreateTime | integer | no | The time when the task was created |

### Retrieves the sample details of a data diagnostic report
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-data-diagnose-sample-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| taskCreateTime | integer | yes | The time when the diagnostic task was created. This is a timestamp in milliseconds |
| startTime | integer | yes | The start time of the query. This is a UNIX timestamp that is accurate to the second |
| endTime | integer | yes | The end time of the query. This is a UNIX timestamp that is accurate to the second |
| taskSource | string | yes | The task type. Valid values: firstRun, manual, and cycle |
| key | string | yes | The diagnostic item |

### Queries datasets of a specified instance
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-data-set` (byok)

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

### Retrieves a list of data sources for a specified instance
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-data-source` (byok)

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

### Lists experiments and returns only their basic information, not their algorithm configurations. Paging is…
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-experiments` (byok)

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

### Lists the data sources for features and samples
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-extra-data-sources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| type | string | no | The type of the data source. Valid values: UserCustomDataSource: A user data source. ItemCustomDataSource: An item data source.… |

### Retrieves a list of feature tables
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-feature-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The feature table ID |
| type | string | no | The type of the feature table |
| updateFrequency | string | no | The update frequency of the feature |
| dataSourceId | string | no | The data source ID |

### Lists information about all recall tables
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-filtering-algorithms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| status | string | no | The status of the recall table. Valid values: Draft: The recall table is a draft. Running: The recall table is running. Offline: The… |
| algorithmId | string | no | The ID of the recall table |
| page | integer | no | The page number |
| size | integer | no | The number of entries in the recall table |

### Lists flow control tasks
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-flow-control-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| taskId | string | no | The flow control task ID |
| status | string | no | The task status. Valid values: DRAFT: The task is a draft. READY: The task is ready to take effect. RUNNING: The task is running. ENDED:… |
| page | integer | no | The page number |
| size | integer | no | The number of entries to return on each page. Default value: 10. Valid values: 1 to 50 |

### Queries the checklist of invalid items for a traffic control task and returns the item ID (ItemId) and item…
`POST https://apizie.tech/v1/cloud:aliyun-airec/list-flow-control-task-invalid-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| taskId | string | yes | The ID of the traffic control task |
| body | array | no | The request body parameters |

### Queries a traffic control task to retrieve its highest-exposure items or invalid items
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-flow-control-task-item-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| taskId | string | yes | The ID of the traffic control task |
| selectTimeType | string | no | The time range to query. If selectType is set to invalidItem, only yesterDay is supported. Valid values: yesterDay: Yesterday.… |
| selectType | string | no | The type of data to query. Valid values: topExposeItem: Items with the highest exposure. invalidItem: Invalid items |
| count | string | no | The number of items to query. The default value is 10. If selectType is topExposeItem, this parameter specifies the number of top items.… |

### Previews the items in a traffic control task
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-flow-control-task-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| taskId | string | yes | The ID of the traffic control task |
| page | integer | no | The page number |
| size | integer | no | The number of entries to return on each page for a paged query. The maximum value is 500 |

### Queries reference data for throttling
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-flow-control-task-reference` (byok)

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

### Lists exposure reports for traffic control tasks
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-flow-control-task-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| taskId | string | yes | The ID of the traffic control task |
| startTime | string | no | The start timestamp for the query, in seconds. The format is YYYYMMDD. If you do not specify this parameter, data is queried from the… |
| endTime | string | no | The end timestamp for the query, in seconds. The format is YYYYMMDD. The latest possible end time is the previous day (t-1) |

### Lists the index versions for a specified instance and recall table. This operation returns up to 10 entries,…
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-index-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| algorithmId | string | yes | The specified table ID |

### Queries the details of one or more instances
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| page | integer | no | The page number. Default value: 1 |
| size | integer | no | The number of entries to return on each page. Default value: 10. Valid values: 1 to 50 |
| status | string | no | The running status of the instances to filter. Valid values: Initializing: The instance is being initialized. Ready: The instance is ready… |
| name | string | no | The name of the instances to filter. Fuzzy matching is supported |
| expiredTime | string | no | A UNIX timestamp in seconds. Use this parameter to filter for instances that are about to expire. Specify a time that is later than the… |
| instanceId | string | no | The ID of the instances to filter. Fuzzy matching is supported |

### Queries all asynchronous tasks of a specified instance by using the instance ID
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-instance-task` (byok)

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

### Lists the items in the item pool of an instance
`POST https://apizie.tech/v1/cloud:aliyun-airec/list-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| strategyUsed | string | no | The default value is false. Set this parameter to true to use the logic for pinning items to the top or to a fixed position. If you set… |
| withInvalidDetail | string | no | Specifies whether to include InvalidDetail in the response for pinning or fixed-position logic. This parameter is used for queries of the… |
| page | integer | no | The page number. The default value is 1 |
| size | integer | no | The number of entries per page. The default value is 10 |

### Queries the logs of a specified instance from the last seven days
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| queryParams | string | no | The query conditions. Format: key1:value1;key2:value. For example: requestId:xxxx;requestUri:xxx |
| startTime | integer | yes | The start time. This is a UNIX timestamp in seconds |
| endTime | integer | yes | The end time. This is a UNIX timestamp in seconds |
| page | integer | no | The page number. The default value is 1 |
| size | integer | no | The number of entries to return on each page. The default value is 10. The valid range is 1 to 50 |

### Queries the content types supported in the diversity rule configurations of an instance
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-mix-categories` (byok)

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

### Queries a list of offline storages
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-offline-storages` (byok)

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

### Returns a list of sorting model templates in descending order by creation time
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-ranking-model-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| page | integer | no | The page number. The default is 1 |
| size | integer | no | The number of entries per page. The default is 10. The valid range is 1 to 50 |

### Queries a list of versions for a ranking model
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-ranking-model-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| templateId | string | yes | The ranking model ID |
| page | integer | no | The number of the page to return |
| size | integer | no | The number of entries to return on each page |
| status | string | no | The state of the version. Valid values: DRAFT: The version is in the draft state. EFFECTIVE: The version is effective. PUBLISHING: The… |

### Retrieves a list of models
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-ranking-models` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| rankingModelId | string | no | The model ID |
| page | integer | no | The page number. The default value is 1 |
| size | integer | no | The number of entries to return on each page. The default value is 10. The value must be in the range of [1, 50] |

### Queries operation records for a ranking service
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-ranking-system-histories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The name of the ranking service |
| name | string | yes | The type of the operation. Valid values: CONF_CHANGE: configuration changes. DEPLOY_CHANGE: changes in deployment methods |
| operateType | string | no | The number of the page to return |
| page | integer | no | The number of entries to return on each page |
| size | integer | no | The schema of the response parameters |

### Queries a list of ranking services
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-ranking-systems` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | Queries the list of ranking services |
| name | string | no | The ID of the instance |
| deployStatus | string | no | The name of the ranking service |
| page | integer | no | The state of the deployment. Valid values: NOT_DEPLOYED: The ranking service is not deployed. DEPLOY_SUCCESS: The ranking service is… |
| size | integer | no | The number of the page to return |

### Queries item selection rules of an instance
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-rule-conditions` (byok)

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

### Queries the status of a rule-specific task
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-rule-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the scene |
| sceneId | string | yes | The completion rate of the task |

### Queries a list of rules
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The ID of the scenario to which the rule belongs. Enter global to modify a global rule |
| ruleType | string | yes | selection: Product selection rule. operation: Operational rule |
| status | string | no | DRAFT: Draft EFFECTIVE: Effective PUBLISHING: Publishing INEFFECTIVE: Invalid FAILED: Failed |
| page | integer | no | The page number. The default value is 1 |
| size | integer | no | The number of entries per page. The default value is 10. The value must be in the range of 1 to 50 |
| startTime | integer | no | The start time. This is a UNIX timestamp in seconds |
| endTime | integer | no | The end time. This is a UNIX timestamp in seconds |

### Retrieves a list of sample format configurations
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-sample-format-configs` (byok)

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

### Retrieves a list of samples
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-samples` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sampleId | string | no | The sample ID |
| page | integer | no | The page number |
| size | integer | no | The page size |

### Retrieves preview results
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-scene-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| sceneId | string | yes | The ID of the scene |
| operationRuleId | string | no | The ID of the operation rule |
| selectionRuleId | string | no | The ID of the selection rule |
| page | integer | no | The page number. Default value: 1 |
| size | integer | no | The number of entries per page. Default value: 10. Valid values: 1 to 50 |
| previewType | string | no | The preview type. Valid values: PREVIEW_ITEM Preview the results of a single product selection rule PREVIEW_QUERY Previews the overall… |
| queryCount | integer | no | The number of queries |

### Retrieves a list of all channels and scenarios for a specified instance
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-scene-parameters` (byok)

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

### Queries a list of scenarios
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-scenes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| status | string | no | The status of the scenario. DRAFT: The scenario is a draft. PUBLISHING: The scenario is being published. RUNNING: The scenario is running.… |
| sceneId | string | no | The scenario ID |
| page | integer | no | The page number. Default value: 1 |
| size | integer | no | The number of entries to return on each page. Default value: 10. Valid values: 1 to 50 |

### Retrieves a list of Umeng appkeys
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-umeng-appkeys` (byok)

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

### Lists the user clusters for a specified instance
`GET https://apizie.tech/v1/cloud:aliyun-airec/list-user-clusters` (byok)

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

### Modifies the information of a single data source in a table of a specified instance
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| tableName | string | yes | The name of the table |

### Modifies a feature table by replacing its entire feature list
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-feature-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| type | string | yes | The type of the feature table. Valid values: UserFeatureTable and ItemFeatureTable |
| featureTableId | string | yes | The ID of the feature table |

### Modifies the configuration of a retrieval table
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-filtering-algorithm-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| algorithmId | string | yes | The retrieval ID |

### Modifies a throttling task
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-flow-control-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| taskId | string | yes | The ID of the task |
| TaskName | string | no | The name of the task |
| description | string | no | The description of the task |
| endTime | integer | no | The end time. The value is a timestamp in seconds |
| metaType | string | no | The type of the metadata |
| sceneIds | string | no | The ID of the scene |
| selectionParams | array | no | The parameters specified for the item selection rule |
| startTime | integer | no | The start time. The value is a timestamp in seconds |
| target | object | no | The settings for item exposure |

### Modifies the configurations of a specified instance
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-instance` (byok)

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

### Performs batch operations on an item pool
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-items` (byok)

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

### Modifies the offline storage configurations of an instance. You need to modify three tables at the same time
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-offline-storages` (byok)

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

### Modifies model information
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-ranking-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| rankingModelId | string | yes | The ranking model ID |

### Modifies a ranking model
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-ranking-model-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| templateId | string | yes | The ID of the ranking model |
| body | object | no | The request body |

### Modifies a ranking service
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-ranking-system` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| name | string | yes | The name of the ranking service |
| body | object | no | The configurations that you want to modify |

### Modifies a rule
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-rule` (byok)

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

### Modifies a sample configuration
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-sample` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sampleId | string | yes | The sample ID |
| body | object | no | The request body |

### Modifies scenario information
`POST https://apizie.tech/v1/cloud:aliyun-airec/modify-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| sceneId | string | yes | The scenario ID |

### Takes a filtering algorithm offline
`POST https://apizie.tech/v1/cloud:aliyun-airec/offline-filtering-algorithm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| algorithmId | string | yes | The ID of the filtering algorithm |

### Publishes a traffic control task
`POST https://apizie.tech/v1/cloud:aliyun-airec/publish-flow-control-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| taskId | string | yes | The ID of the traffic control task |

### Publishes a rule
`POST https://apizie.tech/v1/cloud:aliyun-airec/publish-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| ruleId | string | yes | The rule ID |
| ruleType | string | yes | The type of the rule. Example: selection and operation |
| sceneId | string | yes | The scene ID |
| instanceId | string | yes | The instance ID |

### Pushes documents to a specified table of an instance
`POST https://apizie.tech/v1/cloud:aliyun-airec/push-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://airec.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the Artificial Intelligence Recommendation instance |
| tableName | string | yes | The three industry tables are the user table, the item table, and the behavior table |

…and 25 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-airec/attach-dataset" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud AIRec API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-airec/attach-dataset with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

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

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