# Alibaba Cloud Energy Expert API

> Alibaba Cloud Energy Expert API on Apizie: 60 endpoints (Adds a structured element to an AISearch project. Supported element types include miniapp and product, Delete a structured element from an AISearch project by specifying the resource type and resource ID, When you query structured resources in AISearch, you must specify a resource type. The supported types are…, Updates structured elements in an AISearch project. Supported element types include miniapps (miniapp) and…, …) 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-energyexpertexternal/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Energy Expert (energyexpertexternal, version 2022-09-23). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a structured element to an AISearch project. Supported element types include miniapp and product
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/aisearch-resource-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| data | string | no | The information about the structured element that corresponds to the `type` parameter. Pass the value for this parameter in the specified… |
| type | string | yes | The type of the structured element |

### Delete a structured element from an AISearch project by specifying the resource type and resource ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/aisearch-resource-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| type | string | yes | Structured element type |
| resourceId | string | yes | Structured element resource ID. This is the unique and immutable identifier for the resource in the database |

### When you query structured resources in AISearch, you must specify a resource type. The supported types are…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/aisearch-resource-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| type | string | yes | Structured element type |
| resourceIds | string | no | Resources to query. If empty, the API returns all resources of the specified type using paging (JSON-encoded) |
| pageSize | integer | no | Paging size. Default is 20 |
| currentPage | integer | no | Paging page number. Starts from 1 |

### Updates structured elements in an AISearch project. Supported element types include miniapps (miniapp) and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/aisearch-resource-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| data | string | no | Updates the information for the specified resource. Pass the fields to update in this parameter in JSON format. Fields that are not… |
| resourceId | string | yes | The resource ID of the structured element. This ID is a unique and immutable identifier for the resource in the database |
| type | string | yes | The type of the structured element |

### The AISearch Q&A interface answers customer questions using structured element information from the database…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/aisearch-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| folderId | string | yes | Folder ID. The knowledge base retrieval feature searches for Q\&A content within the current folder and its subfolders |
| message | array | no | List of historical conversation records |
| question | string | yes | User question |
| resourceTypeNeeded | array | no | This list supports three enumeration values: "text" (for knowledge base retrieval), "miniapp" (for miniapp retrieval in structured… |

### Adds a folder and returns an entity that contains basic information about the folder
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/add-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| folderName | string | yes | The name of the folder |
| parentFolderId | string | yes | The ID of the parent folder. A value of 0 indicates the root directory |

### Extracts information from a VL in real time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/analyze-vl-realtime` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| fileUrl | string | no | Choose either fileUrl or fileUrlObject. fileUrl: The URL of a single document. The document can have up to 1,000 pages and be up to 100 MB… |
| fileName | string | no | The filename must include the file extension |
| templateId | string | no | The unique ID of the extraction template, which specifies the content to extract from the document. To obtain the ID, log on to the… |
| language | string | no | The unique ID of the extraction template, which specifies the content to extract from the document. To obtain the ID, log on to the… |

### Provides feedback on the execution status of policies
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/batch-save-instruction-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| factoryId | string | yes | The factory ID |
| pKey | string | no | The source of the call |
| statusList | string | no | The list of instructions |

### Updates the running plans for multiple air conditioner sites in a batch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/batch-update-system-running-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| controlType | integer | no | The control mode, such as automatic or manual |
| dateType | integer | no | The date type, such as weekday or holiday |
| earliestStartupTime | string | no | The earliest startup time |
| endTime | string | yes | The end time of the running plan |
| factoryId | string | yes | The factory ID |
| latestShutdownTime | string | no | The latest shutdown time |
| maxCarbonDioxide | number | no | The maximum carbon dioxide concentration |
| maxTem | number | no | The maximum target temperature |
| minTem | number | no | The minimum target temperature |
| seasonMode | integer | no | The season mode, such as summer or winter |
| startTime | string | yes | The start time of the running plan |
| systemId | string | yes | The site ID |
| workingEndTime | string | no | The end time of the target period |
| workingStartTime | string | no | The start time of the target period |

### This API provides a knowledge base service that answers questions about documents in a selected folder,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/chat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| documentIds | array | no | A list of document IDs to use for the Q\&A. If you use this parameter, the corresponding session must have been created without a folder… |
| question | string | yes | The content of the question |
| sessionId | string | yes | The Q\&A session ID. You can get previous sessions by calling the GetChatSessionList API. You can also create a new session by calling the… |

### This operation performs streaming Q&A on selected documents in a knowledge base, using the conversation…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/chat-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| documentIds | array | no | A list of document IDs for the Q\&A. If you specify document IDs, ensure the `sessionId` you provide is not associated with a folder. The… |
| question | string | yes | The question or prompt |
| sessionId | string | yes | The Q\&A session ID. Call the `GetChatSessionList` operation to retrieve the IDs of existing sessions. Alternatively, call the… |

### Creates a chat session for knowledge base question answering. Each session maintains its own Q&A history as…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/create-chat-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| folderId | string | yes | The folder ID. The knowledge base Q\&A feature retrieves Q\&A pairs from the specified folder and its subfolders. If you set this… |
| name | string | yes | The name of the current session |
| userId | string | no | The unique ID of the user. If not specified, the ID of the account that calls the SDK is used by default |

### Deletes a parsed file by task ID. Returns true on success, or false on failure
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/delete-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| taskId | string | no | The task ID of the file to delete. You can obtain this ID from the console or from other API operations |

### Deletes a folder. If the operation is successful, a Boolean value of `true` is returned. If the folder does…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/delete-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| folderId | string | no | The ID of the folder |

### Retrieves the details of a document by its task ID
`GET https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/detail-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| taskId | string | no | The task ID. Obtain this ID from the product's user interface or other API operations |

### Edits the list of prohibited devices
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/edit-prohibited-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| factoryId | string | yes | The factory ID |
| hvacDeviceConfigVOList | array | yes | The list of device configurations |
| systemId | string | yes | The site ID |

### Edits devices in unfavorable areas
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/edit-unfavorable-area-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| factoryId | string | yes | The factory ID |
| hvacDeviceConfigVOList | array | yes | The list of device configurations |
| systemId | string | yes | The site ID |

### Generates a report for a specified carbon footprint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/generate-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| productId | integer | yes | The product ID |
| productType | integer | yes | The product type. Set this to \`1\` to request a product carbon footprint, or \`5\` to request a supply chain carbon footprint |

### Retrieves analytical data for power stations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-area-elec-constitute` (byok)

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

### Queries the carbon emission trend
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-carbon-emission-trend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The organization code |
| moduleCode | string | no | The module code |
| moduleType | integer | no | The module type |
| trendType | integer | yes | The trend type |
| yearList | array | yes | The list of inventory years |

### Retrieves the list of Q&A pair folders
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-chat-folder-list` (byok)

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

### Retrieves the Q&A pair history for a session
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-chat-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| currentPage | integer | no | The page number for paging. The value starts from 1 |
| pageSize | integer | no | The number of entries per page |
| sessionId | string | yes | The ID of the Q\&A session. This ID is used to track multiple Q\&A pairs from the same user |

### Retrieves a list of a user's Q&A sessions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-chat-session-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| currentPage | integer | no | The page number for paging. The default value is 1 |
| name | string | no | The session name |
| pageSize | integer | no | The number of entries per page. The default value is 10 |
| userId | string | no | The unique ID of the user. If this parameter is left empty, the ID of the account that calls the SDK is used by default |

### Retrieves a list of data item details
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-data-item-list` (byok)

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

### Retrieves the Data Quality Rating (DQR) and Data Quality Indicator (DQI) results
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-data-quality-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| dataQualityEvaluationType | integer | yes | The type of data quality evaluation. 1 indicates DQI and 2 indicates DQR |
| productId | integer | yes | The product ID |
| productType | integer | yes | The product type. 1 indicates a product carbon footprint request. 5 indicates a supply chain carbon footprint request |

### Retrieves device information for an activated site
`GET https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-device-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| factoryId | string | yes | The site ID |
| deviceId | string | yes | The device ID |
| ds | string | yes | The date string in the YYYY-MM-DD format |

### Retrieves the list of devices for an activated site
`GET https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-device-list` (byok)

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

### For Querying Information Extraction Result. The input parameter taskId is obtained from the taskId returned…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-doc-extraction-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| taskId | string | yes | Task ID. taskId is obtained from the SubmitDocExtractionTaskAdvance and SubmitDocExtractionTask interfaces |

### For Querying Document Parsing Results. The input parameter taskId is obtained from the taskId returned by…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-doc-parsing-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| returnFormat | string | no | The document parsing result supports two formats: markdown and json. By default, the result is returned in markdown format |
| taskId | string | yes | Task ID. The taskId is obtained from the SubmitDocParsingTaskAdvance or SubmitDocParsingTask interfaces |

### Important: This API operation is no longer maintained. To obtain extraction results, use the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-document-analyze-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| jobId | string | yes | The job ID. This ID specifies the document whose parsing result you want to query. The ID is returned by the API operation that submits a… |

### Retrieves electricity composition analysis data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-elec-constitute` (byok)

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

### Retrieves electricity trend analysis data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-elec-trend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| yearList | array | yes | A list of years |

### Retrieves the composition of emission sources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-emission-source-constitute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| moduleCode | string | no | The module code |
| moduleType | integer | yes | The module type |
| year | integer | yes | The inventory year |

### Retrieves a carbon emission summary
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-emission-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The code of the enterprise |
| moduleCode | string | no | The module code |
| moduleType | integer | no | The module type |
| year | integer | yes | The inventory year |

### Retrieves the detailed results of environmental impact categories
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-epd-inventory-constitute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| productId | integer | yes | The product ID |
| productType | integer | yes | The product type. Set this to 1 for a product carbon footprint request. Set this to 5 for a supply chain carbon footprint request |

### Retrieves the total emissions for various environmental impact categories
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-epd-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| productId | integer | yes | The product ID |
| productType | integer | yes | The product type. \`1\` indicates a product carbon footprint request. \`5\` indicates a supply chain carbon footprint request |

### Retrieves a list of product carbon footprints
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-footprint-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| currentPage | integer | yes | The paging parameter. This is the page number. The value starts from 1 |
| pageSize | integer | yes | The page size |
| productType | integer | yes | The product type. A value of 1 indicates a request for a product carbon footprint. A value of 5 indicates a request for a supply chain… |

### Retrieves a gas composition analysis
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-gas-constitute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| moduleCode | string | no | The module code |
| moduleType | integer | yes | The module type |
| year | integer | yes | The year |

### Retrieves a ranked list of active carbon reduction initiatives
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-gwp-benchmark-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| productId | integer | yes | The product ID |
| productType | integer | yes | The product type. A value of 1 indicates a product carbon footprint request. A value of 5 indicates a supply chain carbon footprint request |

### Retrieves the total proactive carbon reduction
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-gwp-benchmark-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| productId | integer | yes | The product ID |
| productType | integer | yes | The product type. A value of \`1\` indicates a product carbon footprint request. A value of \`5\` indicates a supply chain carbon… |

### Retrieves the carbon emission composition analysis for a specified product. The analysis provides a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-gwp-inventory-constitute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| productId | integer | yes | The product ID |
| productType | integer | yes | The product type. A value of 1 indicates a request for a product carbon footprint. A value of 5 indicates a request for a supply chain… |

### Retrieves the total carbon footprint of a product and provides details about its top four contributors
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-gwp-inventory-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| productId | integer | yes | The product ID |
| productType | integer | yes | The product type. \`1\`: product carbon footprint. \`5\`: supply chain carbon footprint |

### Retrieves a descending list of emissions for a specified environmental impact (methodType), grouping level…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-inventory-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| emissionType | string | yes | The emission type. Valid values: \`footprint\` and \`emission\`. \`footprint\`: All inventories are included in the calculation.… |
| group | string | yes | The grouping basis. Valid values: \`resource\`, \`process\`, \`resourceType\`, and \`processType\`. \`resource\`: Groups by inventory.… |
| methodType | string | yes | The type of environmental impact. A value of \`gwp\` indicates the climate change carbon footprint. For other values, see the \`type\`… |
| productId | integer | yes | The product ID |
| productType | integer | yes | The product type. A value of \`1\` indicates a product carbon footprint request. A value of \`5\` indicates a supply chain carbon… |

### Queries the organizations and sites that are activated for an account. Sites that are not activated in the…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-org-and-factory` (byok)

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

### Retrieves analytical data for a carbon inventory organization
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-org-constitute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The organization code |
| moduleCode | string | no | The module code |
| moduleType | integer | yes | The module type |
| year | integer | yes | The year |

### Retrieves the OSS URL of a product carbon footprint PCR report
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-pcr-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| productId | string | yes | The product ID |
| productType | integer | yes | The product type. Specify `1` for product carbon footprint or `5` for supply chain carbon footprint |

### Retrieves carbon reduction suggestions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-reduction-proposal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| dataQualityEvaluationType | integer | yes | The data quality evaluation type. A value of 1 indicates Data Quality Indicator (DQI). A value of 2 indicates Data Quality Rating (DQR) |
| productId | integer | yes | The product ID |
| productType | integer | yes | The product type. A value of 1 indicates a product carbon footprint request. A value of 5 indicates a supply chain carbon footprint request |

### For Querying Qwen-VL Model Information Extraction Results. The input parameter taskId is obtained from the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/get-vlextraction-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| taskId | string | yes | taskID. The taskId is obtained from the interfaces SubmitVLExtractionTaskAdvance and SubmitVLExtractionTask |

### Checks the completion status of a report generation task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/is-completed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| productId | integer | yes | The product ID |
| productType | integer | yes | The product type. Set the value to \`1\` to request the carbon footprint of a product. Set the value to \`5\` to request the carbon… |

### Pushes data from device data points, such as voltage data from an electric meter
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/push-device-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| deviceType | string | yes | The type of the device. For more information, see Device Type Definitions… |
| devices | array | yes | A list of devices to push data for |

### This interface is used to push data items
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/push-item-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| code | string | yes | The enterprise code |
| items | object | yes | List of data to be pushed |
| year | string | yes | The year of the data created |

### Recalculates carbon emissions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/recalculate-carbon-emission` (byok)

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

### This API retrieves results for retrieval-augmented generation (RAG) from one or more folder or file IDs. You…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/retrieve` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| documentIds | array | no | Specify either documentIds or folderIds, but not both |
| folderIds | array | no | Specify either folderIds or documentIds, but not both |
| preRetrieveTopK | integer | no | The number of pre-retrieval results to return. Default: 0 |
| query | string | yes | The query statement |
| rerankerThreshold | number | no | The reranking score threshold. Results with scores below this threshold are filtered out. Default: 0.0 |
| topK | integer | no | The number of top-ranked retrieval results to return. Default: 10 |
| useReranker | string | no | Specifies whether to use the reranker. Default: true |

### null null
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/send-document-ask-question` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| folderId | string | no | Folder ID, used to specify the range of documents for the query. If it is empty, it indicates that all documents under the default folder… |
| prompt | string | yes | The question queried by the user |
| sessionId | string | no | Q\&A session ID, used to record multiple Q\&A interactions of the same user. If it is empty, it indicates that sessions are not… |

### Sets an execution plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/set-running-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| controlType | integer | no | The control mode. For example, automatic or manual |
| dateType | integer | no | The date type. For example, weekday or holiday |
| earliestStartupTime | string | no | The earliest startup time |
| endTime | string | no | The end time of the plan |
| factoryId | string | yes | The factory ID |
| latestShutdownTime | string | no | The latest shutdown time |
| maxCarbonDioxide | number | no | The maximum carbon dioxide concentration |
| maxTem | number | no | The maximum target temperature |
| minTem | number | no | The minimum target temperature |
| pKey | string | no | The source of the call |
| seasonMode | integer | no | The season mode. For example, summer or winter |
| startTime | string | no | The start time of the plan |
| statisticsTime | string | no | The date for which to set the single-day execution plan |
| systemId | string | yes | The system ID |
| workingEndTime | string | no | The end time of the target period |
| workingStartTime | string | no | The start time of the target period |

### Extracts key information from a document based on a preset key-value template or prompt template. A…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/submit-doc-extraction-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| fileUrl | string | no | Choose one of the following parameters: fileUrl or fileUrlObject. fileUrl: The URL of a single document. The document can have a maximum… |
| fileName | string | yes | The file name, including the file extension |
| templateId | string | yes | The unique ID of the extraction template. This ID specifies the content to extract from the document. To obtain a template ID, log on to… |
| folderId | string | no | The unique ID of the knowledge base folder. Use this parameter to categorize documents or to limit the scope of documents for online Q\&A… |
| extractType | string | no | The document extraction type. Supported types include rag and long-text understanding. The default value is rag |

### Parses content, such as text, tables, and images, from a document. A successful call returns a task ID. You…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/submit-doc-parsing-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| fileUrl | string | no | Specify either \`fileUrl\` or \`fileUrlObject\`. \`fileUrl\`: The URL of the document. The document can be up to 3000 pages and 500 MB in… |
| fileName | string | yes | The file name must include the file extension |
| folderId | string | no | The unique ID of the knowledge base folder. Use this ID to manage document classification and control the scope of documents for online… |
| needAnalyzeImg | string | no | Specifies whether to parse the image content in the document |

### The document parsing operation is used to extract the key content of a document and extract the key-value…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/submit-document-analyze-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| fileUrl | string | no | Choose one between fileUrl and fileUrlObject: fileUrl: Use the document URL method for a single document (supports documents with up to… |
| fileName | string | yes | The filename must include the file type extension |
| templateId | string | yes | The unique extraction template ID is used to specify the key-value pairs to be extracted from the document. You need to log in to the… |
| folderId | string | no | Unique knowledge base folder ID, used for categorizing documents and controlling the scope of online Q\&A queries. If empty, the document… |
| analysisType | string | no | The default extraction method is "doc", with the following optional values: vl: Image processing doc: Long text RAG (Retrieval-Augmented… |

### Extracts key information from documents using KV templates or prompts with the Qwen-VL model, ideal for…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/submit-vlextraction-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://energyexpertexternal.ap-southeast-1.aliyuncs.com |
| fileUrl | string | no | Choose one of fileUrl or fileUrlObject: fileUrl: Use by providing the document URL, for a single document (supports up to 1000 pages and… |
| fileName | string | yes | The filename must include the file type suffix |
| folderId | string | no | Unique knowledge base folder ID, used when you need to categorize documents and control the scope of online Q\&A queries. The folder ID… |
| templateId | string | no | Unique parsing template ID, used to specify the key-value pairs to be extracted from the document. You need to configure the template on… |

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

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

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/aisearch-resource-add" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Energy Expert API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-energyexpertexternal/aisearch-resource-add with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Energy Expert 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-energyexpertexternal.

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