# Alibaba Cloud AnalyticDB for MySQL AI Service API

> Alibaba Cloud AnalyticDB for MySQL AI Service API on Apizie: 16 endpoints (Creates a metric analysis platform, Creates an embodied intelligence multimodal data platform, Creates an AnalyticDB for MySQL multimodal knowledge base, Deletes a metrics platform, …) 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-adbai/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for AnalyticDB for MySQL AI Service (adbai, version 2025-08-12). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a metric analysis platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/create-agent-platform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition cluster |
| DBClusterId | string | yes | The instance cluster ID |
| Name | string | yes | The name of the metric analysis platform |
| AiPlatformConfig | string | yes | The parameters required to create the metric analysis platform (JSON-encoded) |

### Creates an embodied intelligence multimodal data platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/create-embodied-aiplatform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition cluster |
| DBClusterId | string | yes | The instance cluster ID |
| PlatformName | string | yes | The name of the embodied intelligence multimodal data platform. The name can contain lowercase letters, digits, and underscores. It must… |
| WebserverSpecName | string | no | The Webserver specification of the platform |
| RayConfig | string | no | The Ray specification information of the platform (JSON-encoded) |
| DeviceCount | integer | no | The device count |
| RayTrainConfig | string | no | The development and training resource configuration (JSON-encoded) |

### Creates an AnalyticDB for MySQL multimodal knowledge base
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/create-multi-model-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition cluster |
| DBClusterId | string | no | The ID of the cluster |
| AdbInstanceName | string | no | [Deprecated] |
| VpcId | string | no | The ID of the VPC |
| VSwitchId | string | no | The ID of the vSwitch |
| ZoneId | string | no | The ID of the zone to which the instance belongs |
| LakeStorageBucketName | string | no | [Deprecated] |
| ResourceAcuMin | integer | no | The minimum number of ACUs for the multimodal knowledge base resources |
| ResourceAcuMax | integer | no | The maximum number of ACUs for the multimodal knowledge base resources |
| DbClusterAcu | integer | no | The number of ACUs for the AnalyticDB for MySQL instance resources |
| Description | string | no | The description of the multimodal knowledge base instance |

### Deletes a metrics platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/delete-agent-platform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition cluster |
| DBClusterId | string | yes | The instance cluster ID |
| Name | string | yes | The name of the intelligent alert event recording. The name must be fewer than 48 characters in length and can contain letters, digits,… |

### Deletes an embodied intelligence platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/delete-embodied-aiplatform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition cluster |
| DBClusterId | string | yes | The instance cluster ID |
| PlatformName | string | yes | The name of the embodied intelligence multimodal data platform. The name can contain lowercase letters, digits, and underscores. It must… |

### Deletes an ADB multimodal knowledge base
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/delete-multi-modal-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition cluster |
| DBClusterId | string | no | The cluster ID |
| MmkbName | string | no | The MmkbName |

### Retrieves multi-turn conversations for instance kernel diagnostics
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/describe-chat-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The Alibaba Cloud region ID |
| Query | string | yes | The question asked by the user |
| SessionId | string | no | The session ID |
| Timezone | string | no | The time zone |
| Skill | string | no | The name of the diagnostic skill used to process the current conversation |

### Queries the resource allocation plan for devices on the embodied intelligence platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/describe-eap-device-resource-allocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition… |
| DBClusterId | string | yes | The cluster ID of the instance |
| DeviceCount | integer | no | The total number of devices |

### Queries embodied intelligence multimodal data platforms
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/describe-embodied-aiplatforms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition… |
| DBClusterId | string | yes | The cluster ID of the instance |
| State | string | no | The running status of the platform |
| StartTime | string | no | The start time of platform creation, used to filter query results. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ… |
| EndTime | string | no | The end time of platform creation, used to filter query results. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ… |
| PageSize | integer | no | The number of entries per page in a paged query. Default value: 30 |
| PageNumber | integer | no | The current page number |
| NextToken | string | no | Use PageSize and PageNumber for pagination |
| MaxResults | integer | no | Use PageSize and PageNumber for pagination |
| PlatformName | string | no | The name of the embodied intelligence multimodal data platform |

### Queries the resource usage information of the Embodied platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/get-embodied-aiplatform-resource-usage-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition… |
| DBClusterId | string | yes | The ID of the cluster |
| StartTime | string | no | The start time of the time range to query network resource usage. Format: yyyy-MM-ddTHH:mmZ |
| EndTime | string | no | The end time of the time range to query network resource usage. Format: yyyy-MM-ddTHH:mmZ |
| PlatformName | string | no | The name of the Embodied platform |

### Locks an embodied intelligence platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/lock-embodied-aiplatform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition cluster |
| DBClusterId | string | yes | The instance cluster ID |
| PlatformName | string | yes | The name of the embodied intelligence multimodal data platform. The name can contain lowercase letters, digits, and underscores. It must… |

### Upgrades or downgrades the specifications of a metric platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/modify-agent-platform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition cluster |
| DBClusterId | string | yes | The instance cluster ID |
| Name | string | yes | The name of the metric platform |
| AiPlatformConfig | string | no | The parameters required for upgrading or downgrading the metric platform (JSON-encoded) |

### Modifies the specifications of the embodied AI platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/modify-embodied-aiplatform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition cluster |
| DBClusterId | string | yes | The ID of the cluster |
| PlatformName | string | yes | The name of the embodied AI multimodal data platform. The name must be 1 to 16 characters in length and can contain lowercase letters,… |
| WebserverSpecName | string | no | The Webserver specification of the platform |
| RayConfig | string | no | The Ray specifications of the platform (JSON-encoded) |
| RayTrainConfig | string | no | The configuration of development and training resources (JSON-encoded) |
| DeviceCount | string | no | The total number of devices |

### Resets the admin password for the embodied intelligence platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/reset-embodied-aiplatform-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition… |
| DBClusterId | string | yes | The cluster ID of the instance |
| PlatformName | string | yes | The name of the embodied intelligence multimodal data platform |
| Password | string | yes | The new password for the admin user of the embodied intelligence platform |

### Unlocks an embodied intelligence platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/unlock-embodied-aiplatform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://adbai.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the region ID of a specified Data Lakehouse Edition cluster |
| DBClusterId | string | yes | The instance cluster ID |
| PlatformName | string | yes | The name of the embodied intelligence multimodal data platform. The name must start with a lowercase letter and end with a lowercase… |

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

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

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-adbai/create-agent-platform" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud AnalyticDB for MySQL AI Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-adbai/create-agent-platform with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud AnalyticDB for MySQL AI Service 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-adbai.

### What is the status of the Alibaba Cloud AnalyticDB for MySQL AI Service API?
Needs your own provider key (bring your own key)