# Alibaba Cloud BrainIndustrial API

> Alibaba Cloud BrainIndustrial API on Apizie: 14 endpoints (Activates a license, Calls an AICS OpenAPI, Creates a stored energy operation optimization task, Creates an electricity load forecasting task with historical data from a file URL, …) 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-brain-industrial/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for BrainIndustrial (brain-industrial, version 2020-09-20). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Activates a license
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/activate-license` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| Id | string | no | The ID |
| InstanceId | string | no | The instance ID |
| Fingerprint | string | no | The machine fingerprint |
| OrderId | string | no | The order ID |

### Calls an AICS OpenAPI
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/aics-open-api-invoke` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| ServiceId | string | yes | The service ID of the OpenAPI |
| NodeId | string | no | The node ID |
| Type | string | no | The type |
| Param | string | no | The input parameter (JSON-encoded) |
| JobId | string | no | The job ID. This parameter is used to query the results of an asynchronous canvas call |

### Creates a stored energy operation optimization task
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/create-ess-opt-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| Freq | string | no | The data frequency. The value must match the data frequency of historyData. Default value: FIFTEEN_MIN. Valid values: FIFTEEN_MIN: 15… |
| Duration | integer | no | The prediction duration in days, starting from the run date (inclusive). This parameter is optional. Default value: 1 |
| RunDate | string | no | The run date, accurate to the day, in the "yyyy-MM-dd" format |
| TimeZone | string | no | The time zone. Default value: Asia/Shanghai |
| ModelVersion | string | no | The model version number. Default value: latest |
| TopoType | string | no | The resource topology type within the site. Valid values: LOAD_ESS: Grid power + stored energy. LOAD_ESS_SOLAR: Grid power + stored energy… |
| SystemData | string | no | The system data, including the parameters and historical data of each system within the site (JSON-encoded) |
| ElecPrice | string | no | The time-of-use grid electricity price changes for the target date. The time granularity is consistent with freq (JSON-encoded) |
| GenPrice | string | no | The time-of-use feed-in tariff changes for the target date. The time granularity is consistent with freq (JSON-encoded) |
| Location | string | no | The location information, including longitude and latitude (JSON-encoded) |
| BusinessKey | string | no | The business key |

### Creates an electricity load forecasting task with historical data from a file URL
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/create-load-forecast-by-file-url-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| DeviceType | string | no | The device type. The device types supported by each system type are as follows: load: electricityMeter (utility meter) hvac: gateway-hvac… |
| HistoryUrl | string | no | The URL of the historical data CSV file. The URL must be publicly accessible during the call |
| Freq | string | no | The data frequency. The value must match the frequency of the historical data. Valid values: FIFTEEN_MIN: 15 minutes. FIVE_MIN: 5 minutes.… |
| Duration | integer | no | The forecast duration in days, starting from the run date (inclusive). Optional. Default value: 1 |
| SystemType | string | no | The system type. Valid values: load: utility power. hvac: air conditioner. flexible: lighting. charge: charging station |
| RunDate | string | no | The run date, accurate to the day, in the "yyyy-MM-dd" format |
| TimeZone | string | no | The time zone. Default value: Asia/Shanghai |
| ModelVersion | string | no | The model version number. Default value: latest. You can query the version number from the documentation to call a historical snapshot… |
| BusinessKey | string | no | The business key, such as a site name or ID |
| TimeColumn | string | no | The time column in the historical data CSV file. The time column must be in the yyyy-MM-dd HH:mm:SS format, and the data frequency must… |
| ValueColumn | string | no | The value column in the historical data CSV file. The value must be of a numeric type |
| ForecastHorizon | string | no | The forecast time horizon. Valid values: DAY_AHEAD: day-ahead forecast. INTRADAY: intraday forecast |
| DataMode | string | no | The data mode for this call. Valid values: FULL: full data. Only the data passed in this call is used. INCREMENTAL: incremental data. Data… |

### Creates an electricity load forecasting task
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/create-load-forecast-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| DeviceType | string | no | The device type. The device types supported by each systemType are as follows: System type: Device type load: electricityMeter -- mains… |
| HistoryData | string | no | The historical load data. 90 days of historical data is required (JSON-encoded) |
| Freq | string | no | The data frequency. Default value: FIFTEEN_MIN. The value must be consistent with the data frequency of historyData. Valid values:… |
| Duration | integer | no | The forecast duration in days, starting from the run date (inclusive). Optional. Default value: 1 |
| SystemType | string | no | The system type. Valid values: load: mains electricity hvac: air conditioner flexible: lighting charge: charging station |
| RunDate | string | no | The run date, accurate to the day, in the "yyyy-MM-dd" format |
| TimeZone | string | no | The time zone. Default value: Asia/Shanghai |
| ModelVersion | string | no | The version number of the model. Default value: latest |
| BusinessKey | string | no | The business key, such as the site name or ID |
| ForecastHorizon | string | no | The forecast time horizon. Valid values: DAY_AHEAD: day-ahead forecast INTRADAY: intraday forecast |
| DataMode | string | no | The data mode for this call. Valid values: FULL: full data (uses only the data passed in this call). INCREMENTAL: incremental data… |

### Creates a power generation forecast task with historical data from a file URL
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/create-power-forecast-by-file-url-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| DeviceType | string | no | The device type. The device types supported by each system type are as follows: solar: solarInverter (solar inverter) wind: windTurbine… |
| HistoryUrl | string | no | The URL of the historical data CSV file. The URL must be publicly accessible during the call |
| Freq | string | no | Default value: FIFTEEN_MIN. The value must match the data frequency of the historical data. Valid values: FIFTEEN_MIN: 15 minutes… |
| Duration | integer | no | The forecast duration in days, starting from the run date (inclusive). Optional. Default value: 1 |
| SystemType | string | no | The system type. Valid values: solar: photovoltaic wind: wind power |
| RunDate | string | no | The run date, accurate to the day, in the "yyyy-MM-dd" format |
| TimeZone | string | no | The time zone. Default value: Asia/Shanghai |
| ModelVersion | string | no | The version number of the model. Default value: latest. You can query the version number in the documentation to call a historical… |
| Location | string | no | The location information, including longitude and latitude (JSON-encoded) |
| BusinessKey | string | no | The business key, such as a station name or ID |
| TimeColumn | string | no | The time column in the historical data CSV file. The time column must be in the yyyy-MM-dd HH:mm:SS format. The data frequency must match… |
| ValueColumn | string | no | The value column in the historical data CSV file. The value must be a numeric type |
| ForecastHorizon | string | no | The forecast time horizon. Valid values: DAY_AHEAD: day-ahead forecast INTRADAY: intraday forecast |
| DataMode | string | no | The data mode for this call. Valid values: FULL: full data (uses only the data passed in this call) INCREMENTAL: incremental data… |

### Create a power generation prediction job.
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/create-power-forecast-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| DeviceType | string | no | Device type. The supported device types for each systemType are: System Type: Device Type solar: solarInverter -- Photovoltaic inverter… |
| HistoryData | string | no | Historical load data. Requires 90 days of historical data. (JSON-encoded) |
| Freq | string | no | Default is 15 min; must match the frequency of the historyData; enumeration values: FIFTEEN_MIN: 15 minutes FIVE_MIN: 5 minutes ONE_HOUR:… |
| Duration | integer | no | Prediction duration in days, starting from and including the run date. Optional. Default value is 1 day. |
| SystemType | string | no | System type. Supported system types include: solar: Photovoltaic wind: Wind power |
| RunDate | string | no | Run date, accurate to the day, in "yyyy-MM-dd" format. |
| TimeZone | string | no | Time zone. The default is Asia/Shanghai (Shanghai time zone). |
| ModelVersion | string | no | Version number of the model. Default is latest. |
| Location | string | no | Location information, including latitude and longitude. (JSON-encoded) |
| BusinessKey | string | no | Business key, such as a site name or ID |
| ForecastHorizon | string | no | Forecast time horizon, enumeration values: DAY_AHEAD: Day-ahead forecast INTRADAY: Intraday forecast |
| DataMode | string | no | Data mode for this invocation, enumeration values: FULL: Full data (uses only the data passed in this invocation) INCREMENTAL: Incremental… |

### Queries an AIVPP algorithm job
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/get-aivpp-algo-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| JobId | string | no | The JobId returned by the task creation operation. You can use this ID to query real-time details of the task generated by the… |

### Queries the details of a license
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/get-license` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| Id | integer | no | The ID |
| InstanceId | string | no | The instance ID |

### Retrieves the list of AIVPP resources for a user
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/list-aivpp-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| MaxResults | integer | no | The number of entries to return per page. Default value: 20 |
| CurrentPage | integer | no | The current page number. Default value: 1 |
| InstanceType | string | no | The instance type. Valid values: API: API type. DATA: time series data type |

### Queries the list of licenses
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/list-licenses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| CurrentPage | integer | no | The current page number |
| PageSize | integer | no | The number of entries per page |
| QueryStr | string | no | The keyword of the commodity name. You can perform a fuzzy match based on this keyword |

### Retrieves the resources of a user
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/list-user-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| CommodityCode | string | no | The commodity code |

### Updates the authorization description
`POST https://apizie.tech/v1/cloud:aliyun-brain-industrial/update-license-description` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| Description | string | no | The authorization description |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://brain-industrial.cn-hangzhou.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-brain-industrial/activate-license" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

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

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

### Can AI agents use the Alibaba Cloud BrainIndustrial 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-brain-industrial.

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