When you query structured resources in AISearch, you must specify a resource type. The supported types are Mini Program (miniapp) and product. If you provide a resource ID, the query returns the specified resource. If you do not provide a resource ID, the query returns all resources of that type by paging.
Try it now
Test
RAM authorization
Request syntax
GET /api/v1/aiSearch/resource/list HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| type |
string |
Yes |
Structured element type Valid values:
|
miniapp |
| resourceIds |
array |
No |
Resources to query. If empty, the API returns all resources of the specified type using paging. |
|
|
string |
No |
Structured element resource ID. This is the unique and immutable identifier for the resource in the database. |
WzMGQZwB7nQEs3Qk3ajH |
|
| pageSize |
integer |
No |
Paging size. Default is 20. |
20 |
| currentPage |
integer |
No |
Paging page number. Starts from 1. |
1 |
The type field is an enumeration. Only the listed values are valid. Using any other value will cause the API call to fail. More structured content types may be added in the future.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Response schema |
||
| requestId |
string |
Request ID |
A8AEC6D9-A359-5169-BD1A-BD848BA60D65 |
| data |
object |
Response data |
|
| total |
integer |
Total number of resources |
68 |
| currentPage |
string |
Current page number |
1 |
| pageSize |
string |
Paging size |
20 |
| items |
array |
Resource list |
|
|
any |
Resource details |
{"type":"miniapp","score":0.4571971,"resourceId":"1512004139024243527680","miniappId":"","title":"Electronic Invoice","version":"1.0.0","description":"The E-Invoice mini-app supports setting up email/SMS delivery, querying issuance records, requesting and reissuing invoices, and downloading or printing PDF files.","slogan":"E-Invoice mini-app","icon":"https://gw.alicdn.com/6000000000498-2-tps-200-200.png","url":"https://app-intl.com/release/6592_v1.6.16_poc.zip","detailDescription":null} |
Examples
Success response
JSON format
{
"requestId": "A8AEC6D9-A359-5169-BD1A-BD848BA60D65",
"data": {
"total": 68,
"currentPage": "1",
"pageSize": "20",
"items": [
" {\"type\":\"miniapp\",\"score\":0.4571971,\"resourceId\":\"1512004139024243527680\",\"miniappId\":\"\",\"title\":\"Electronic Invoice\",\"version\":\"1.0.0\",\"description\":\"The E-Invoice mini-app supports setting up email/SMS delivery, querying issuance records, requesting and reissuing invoices, and downloading or printing PDF files.\",\"slogan\":\"E-Invoice mini-app\",\"icon\":\"https://gw.alicdn.com/6000000000498-2-tps-200-200.png\",\"url\":\"https://app-intl.com/release/6592_v1.6.16_poc.zip\",\"detailDescription\":null}"
]
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.