Product Keyword Generation API Reference

GET/POST /ai/text/smb/product/keyword

Generate search terms based on the search habits of international consumers on various e-commerce platforms. These search terms can be used in product titles, descriptions, and more to enhance product discoverability.

Request Parameters

Parameter	Type	Required	Description
paramJson	Object	Yes	Parameter Object
title	String	Yes	Product Name: You can input the original product title or a brief description of the product. The total character length should not exceed 500. Example Value: Pen for iPad, 13 mins Fast Charging Stylus with Palm Rejection, Tilt Sensitivity, Compatible with 2018-2022 iPad Air 3/4/5, iPad Mini 5/6, iPad 6/7/8/9/10, iPad Pro 11", iPad Pro 12.9" (Black)
pcate_leaf_name	String[]	Yes	Product Category: Enter the product category name. The more detailed the category information, the more accurate the generated results will be. Example Value: ["Clothes"]
properties	String	No	Product Attributes: Describe the product's features, such as material or other attributes. Input attribute names and values (Key1: Value1, Key2: Value2) to make the generated content more detailed and accurate. Example Value: Number: 12 cans, Brand: Coca Cola;

Sample Request

/*The domain url of the API.
 *for api purchased on global site. set api_domain to "https://api.aidc-ai.com"
 *for api purchased on chinese site. set api_domain to "https://cn-api.aidc-ai.com"*/
IopClient client = new IopClientImpl("domain url", "your key", "your secret");
IopRequest request = new IopRequest();
request.setApiName("/ai/text/smb/product/description");
// If the formal quota is not purchased, please add a trial mark; otherwise, a "NoResource" error code will be received.
// request.addHeaderParameter("x-iop-trial","true");
request.addHeaderParameter("x-iop-trial","true");
JSONObject jsonObject = new JSONObject();
jsonObject.put("title", "不锈钢橱柜脚可调节家具沙发脚支撑腿床脚茶几支撑脚桌脚电视柜脚");
jsonObject.put("pcate_leaf_name", "紧固件");
String[] properties = {"材质不锈钢", "规格C款不锈钢可调脚（拉丝）", "规格C款不锈钢可调脚（白色）", "规格C款不锈钢可调脚（黑色）", "规格不锈钢可调脚（拉丝）", "规格不锈钢可调脚（白色）","规格不锈钢可调脚（黑色）", "规格全钢脚", "规格重型B款可调脚（拉丝）", "规格重型B款可调脚（白色）", "规格重型B款可调脚（黑色）", "货号AL-527800489897","计量单位个", "适用范围家具家装", "风格现代简约"};
jsonObject.put("properties", properties);
request.addApiParameter("paramJson", jsonObject.toString());
IopResponse response = client.execute(request);
System.out.println(response.getBody());
Thread.sleep(10);

Response Parameters

Parameter	Type	Description
resCode	Number	Response code;200 indicates a successful call, other response codes can be referred to in the error code information.
data	Object	Result data that generated.
result	Object	Specific returned results.
requestId	String	Request ID.
success	Boolean	Request successfully.
resMessage	String	Request message; if an error occurs, it will be reflected in this field.

Sample Response

{
    "data": {
        "result": {
            "data": {
                "message": [

                ],
                "structData": {
                    "error_code": 0,
                    "keyword": [
                    "cabinet and sofa support",
                    "versatile furniture accessories",
                    "heavy-duty b-type adjustable feet"
                    ]
                }
            },
            "success": true,
            "requestId": "210144ab17521555448647724e7b32"
        }
    },
    "requestId": "210144ab17521555448647724e7b32",
    "resCode": 200,
    "resMessage": "success",
    "code": "0",
    "request_id": "21010c9517521555448668114",
    "_trace_id_": "210144ab17521555448647724e7b32"
}

Errors

Error Code	Error Message	Description
700	invalid input	The format of the input parameters does not meet the requirements, and resMessage will return detailed fields that do not meet the requirements.
801	model failed	Internal call exception, please contact us via Discord or email us ([email protected]) for troubleshooting.
501	rate limit exceed	The current interface has reached the current limit. Please contact us via Discord or email us ([email protected]) to increase the current limit value.
1000	content has sensitive data, please try other input	The request parameters contain sensitive information. Please try a different input.
1001	content control failed, please retry	The risk control service failed. Please retry.
1002	content risk filter failed, please contact us	Content risk filter failed. Please contact us via Discord or email us ([email protected]) .