Product Description Generation API Reference

Product Description Generation

GET/POST /ai/product/description/generation

Description

Product Description Generation is designed for overseas e-commerce products can generate rich, precise, and attractive product descriptions through simple inputs. This helps address issues such as missing textual information, unclear key points, and other inefficiencies in product detail information, ultimately improving product conversion rates.

Request Parameters

Parameter	Type	Required	Description
productTitle	String	Yes	Product title. You can fill in the original name or title of the product, with a total character length not exceeding 500. Sample: 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)
targetLanguage	String	Yes	Target languages, you can refer to supported language pairs and language code in the appendix. Sample: es
productCategory	String	Yes	The category of product. You can refer to the category structure of any platform and input the product category name. The more detailed the category information, the more accurate the generated product description will be. Sample: ["Clothes"]
itemSpecs	String	No	Product specification and features, such as materials. Enter the product attribute names and attribute contents (Key1: Value1, Key2: Value2) to make the generated product description more detailed and accurate. Sample: Number: 12 cans, Brand: Coca Cola;
productKeyWords	String[]	No	Product keywords, which are usually SEO-related keywords or selling points of the product. Fill in the keywords that need to be added in the generated product description. Sample: sweet
productDescription	String	No	Product description. Input the original product description to make the generated product description more detailed and accurate. Sample: Ergonomic Comfort Design: The wireless ergonomic keyboard features with curved and split key-frame design, which helps to position your wrist and forearm in a more natural, relaxed posture.Scooped keys perfectly match the shape of your fingertips, offering quick response with every keystroke. Premium comfort for all-day typing.Cushioned Palm Rest: Curved palm rest with soft memory foam layer offers typing comfort with more wrist support, less wrist bending compared to standard keyboard without palm rest. Adjustable tilt design positions the keyboard at a perfect angle to keep your wrist relaxed and comfortable whether seated or standing.2.4G Wireless keyboard and Mouse comb : The keyboard and mouse share the same one USB receiverColoful keyboard and mouse !

Sample Request

Java

IopClient client = new IopClient(url, appkey, appSecret);
IopRequest request = new IopRequest();
request.setApiName("/ai/product/description/generation");
request.addApiParameter("targetLanguage", "en");
request.addApiParameter("productTitle", "Vintage Black Printing Blazer Women Jacket High Street Fashion 2024 Spring Plus Size Elegant Office Lady Coat American Stylish");
request.addApiParameter("productCategory", "Blazers");
request.addApiParameter("productKeyWords", "["female blazers jacket"]");
request.addApiParameter("itemSpecs", "[\"service:dropshippingClothing\", \"style\":Europe and America\",\"pattern:Printing\",\"season:spring\"]");
request.addApiParameter("productDescription", "Sleeve Type, style, Sleeve Length, distinctive features, category terms, benefits.");
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.
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

Java

{
  "data": {
    "usage": 1,
    "generatedDescription": [
      "Vintage Style:This blazer jacket features a vintage black printing design, perfect for those who love high street fashion and want to stand out in 2024 spring.",
      "Plus Size Availability:Catering to various body types, this jacket is available in plus sizes, ensuring everyone can enjoy its stylish design and comfortable fit.",
      "Elegant Office Lady Coat:This jacket is not just another piece of clothing, but an elegant office lady coat that adds a touch of sophistication to your daily outfit.",
      "High Quality Printing:The high-quality printing of the jacket ensures durability and longevity, maintaining its vibrant black color and distinctive design over time.",
      "Versatile High Street Fashion:As a versatile piece of high street fashion, this jacket can be paired with a variety of outfits, making it suitable for different occasions."
    ],
    "class": "com.aidc.service.api.client.text.dto.ProductDescGenerationResponse"
  },
  "requestId": "212c940e17192233277796296e0da7",
  "success": true,
  "resCode": 200,
  "resMessage": "success",
  "code": "0",
  "request_id": "212a664f17192233281552842",
  "_trace_id_": "212c940e17192233277796296e0da7"
}

Errors

Error Code	Error Message	Description
501	rate limit exceed	The current interface has reached the current limit. Please contact us via navigation bar or email us ([e-mail]) to increase the current limit value.
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 navigation bar or email us ([e-mail]) for troubleshooting.
1000	content has sensitive data, please try other input	Content has sensitive data and cannot be handled now. Please try other input.
1001	content control failed, please retry	Content control failed, please try other input. If an error persists, please contact us via navigation bar or email us ([e-mail]).
1002	content risk filter failed, please contact us	Content risk filter failed, please contact us via navigation bar or email us ([e-mail]).

Appendix

Supported Language Pairs

The Product Description Generation API supports generation between the language pairs listed in the following table. More language pairs are continuously being added. Please contact us via navigation bar or email us ([e-mail]) if you have any specific requirements.

Source Language	Target Language
Chinese	English
Chinese	Spanish
Chinese	French
Chinese	Portuguese
Chinese	Korean
Chinese	Japanese
Chinese	Vietnamese
Chinese	Thai
Chinese	Turkish
Chinese	Indonesian
Chinese	German
Chinese	Italian
Chinese	Malay
Chinese	Russian
Chinese	Dutch
English	English
English	Spanish
English	French
English	Portuguese
English	Korean
English	Japanese
English	Vietnamese
English	Thai
English	Turkish
English	Indonesian
English	German
English	Italian
English	Malay
English	Russian
English	Dutch

Language Code

The language code uses ISO 639-1 two-digit language codes. For a country/region variant of a language, the table follows the RFC 5646 format of appending a dash followed by an ISO 3166 2-digit country code. For example, the language code for Traditional Chinese is zh-tw.

Language	Language Code
Arabic	ar
Chinese (Simplified)	zh
Chinese (Traditional)	zh-tw
Danish	da
Dutch	nl
English	en
Persian	fa
Filipino/Tagalog	tl
Finnish	fi
French	fr
German	de
Hungarian	hu
Icelandic	is
Indonesian	id
Italian	it
Japanese	ja
Korean	ko
Lithuanian	lt
Malay	ms
Polish	pl
Portuguese (Portugal)	pt
Romanian	ro
Russian	ru
Sinhala	si
Spanish	es
Thai	th
Turkish	tr
Ukrainian	uk
Urdu	ur
Uzbek	uz
Vietnamese	vi