[P070]Keyword Assistant
The Keyword Helper helps expand your search by recommending synonyms of the words entered. Add content to the Type field in the interface documentation： Synonyms refer to words with the same or very similar meaning. Hyponyms are words that represent more specific terms. Similar keywords are words that share a similar concept or theme.
Request Parameters
List of parameters supported by this API endpoint
| Name | Type | Example | Description |
|---|---|---|---|
Required | array | [
"car"
] | keyword |
Required | array | [
"cn",
"en"
] | language(cn/en) |
Required | array | [
"synonym",
"related"
] | language: synonym : synonym related : related words hypernym : hypernym |
Response Schema
Structure of the API response data
| Field Name | Type | Example | Description |
|---|---|---|---|
data | object | - | response data |
items | array | [
{
"input": "car",
"keyword_list": [
{
"keyword": "car"
},
{
"keyword": "automobile"
},
{
"keyword": "motor vehicle"
},
{
"keyword": "sedan"
},
{
"keyword": "SUV"
},
{
"keyword": "truck"
},
{
"keyword": "van"
},
{
"keyword": "driving"
},
{
"keyword": "road trip"
},
{
"keyword": "vehicle registration"
},
{
"keyword": "car maintenance"
},
{
"keyword": "汽车"
},
{
"keyword": "车辆"
},
{
"keyword": "机动车"
},
{
"keyword": "交通工具"
},
{
"keyword": "轿车"
},
{
"keyword": "跑车"
},
{
"keyword": "越野车"
},
{
"keyword": "货车"
},
{
"keyword": "客车"
},
{
"keyword": "驾驶"
},
{
"keyword": "油门"
},
{
"keyword": "刹车"
},
{
"keyword": "轮胎"
},
{
"keyword": "发动机"
}
]
}
] | Return data |
input | string | car | Input |
keyword_list | array | [
{
"keyword": "car"
},
{
"keyword": "automobile"
},
{
"keyword": "motor vehicle"
},
{
"keyword": "sedan"
},
{
"keyword": "SUV"
},
{
"keyword": "truck"
},
{
"keyword": "van"
},
{
"keyword": "driving"
},
{
"keyword": "road trip"
},
{
"keyword": "vehicle registration"
},
{
"keyword": "car maintenance"
},
{
"keyword": "汽车"
},
{
"keyword": "车辆"
},
{
"keyword": "机动车"
},
{
"keyword": "交通工具"
},
{
"keyword": "轿车"
},
{
"keyword": "跑车"
},
{
"keyword": "越野车"
},
{
"keyword": "货车"
},
{
"keyword": "客车"
},
{
"keyword": "驾驶"
},
{
"keyword": "油门"
},
{
"keyword": "刹车"
},
{
"keyword": "轮胎"
},
{
"keyword": "发动机"
}
] | Keyword list |
keyword | string | automobile | keyword |
statusRequired | boolean | false | Status |
error_msg | string | The request parameter format is incorrect！ | Error Message |
error_codeRequired | integer | 0 | Error Code |
Success Response Example
Example of a successful API response
JSON
{
"data": {
"items": [
{
"input": "car",
"keyword_list": [
{
"keyword": "automobile"
}
]
}
]
},
"status": true,
"error_code": 0
}Error Codes
List of possible error codes returned by this endpoint
Business Errors
| Error Code | Description |
|---|---|
68300004 | Invalid parameter! |
68300005 | Search api failure! |
68300006 | Analytic basic access error! |
68300007 | Bad request! |
68300008 | Service error, please try again later! |
68300010 | The file does not comply with upload specifications! |
Platform Errors
| Error Code | Description |
|---|---|
67200000 | API call exceeds the total limit set by the platform! |
67200001 | API call exceeds the total limit set by the platform! |
67200002 | The current call rate is too fast, exceeding the current configuration limit QPS! |
67200003 | The key and secret parameters for applying for the token are incorrect or the client has been disabled! |
67200004 | The requested api does not have permission. Please contact our support personnel! |
67200005 | Insufficient account balance/number of calls! |
67200006 | The client has exceeded the activation validity period! |
67200007 | The current call exceeds the configured usage limit of the day! |
67200008 | Please check if the required apikey in the query parameter has been transmitted! |
67200009 | The apikey does not match the passed bearerToken. Please check if a valid token is being used! |
67200012 | The request is illegal! |
67200100 | The current server status is busy, request response timeout! |
67200101 | The API requested currently does not exist. Please check the request path! |
HTTP Status Codes
| Status Code | Description |
|---|---|
0 | Success |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Performance Metrics
Expected performance characteristics for this endpoint
Normal Response Time
5000 ms
Max Response Time
10000 ms