This guide helps you activate the service and make your first API call in under five minutes.
Step 1: Prepare your account
Register an Alibaba Cloud account and complete real-name verification. For instructions on how to set up an enterprise account, see Enterprise Account Quick Start.
Step 2: Activate the service
Sign in to the IQS console and click Free Trial to activate the service.
After activation, you automatically receive a free trial quota.
The service is ready to use in about five minutes.
We recommend activating the service with your main account. If you plan to use a RAM user, you must grant the necessary RAM authorization: Create a RAM user and grant permissions
Step 3: Get credentials
IQS provides two authentication methods. Choose one based on your access method:
Method | Access method | Instructions | Usage |
API key |
| Go to IQS console - API key and click Create API Key. | HTTP Header: |
AccessKey (AK/SK) |
| Create a RAM user and grant permissions → Create an AccessKey for a RAM user | Configure access_key_id and access_key_secret in your SDK code. |
Step 4: Send your first request
1. WebSearch
curl -X POST https://cloud-iqs.aliyuncs.com/search/unified \
--header "Authorization: Bearer $API_KEY" \
--header "Content-Type: application/json" \
--data '{
"query": "Hangzhou food",
"engineType": "LiteAdvanced",
"contents": {
"mainText": true,
"markdownText":false,
"summary": false,
"rerankScore": true
},
"advancedParams":{
"numResults": 5
}
}'2. Parse a web page
curl --location 'https://cloud-iqs.aliyuncs.com/readpage/basic' \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"url": "https://help.aliyun.com/document_detail/2837301.html",
"maxAge": 0
}'Next steps
Learn about the differences between the four types of search engines: Overview
Learn about billing: WebSearch billing
Integrate with Skills: IQS Skills Quick Start