Skip to main content
POST
/
tasks
/
optimization
/
description
Optimize Product Description
curl --request POST \
  --url https://ai.getlynks.io/api/tasks/optimization/description \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-OpenAI-Key: <api-key>' \
  --data '
{
  "product_description": "<string>"
}
'
{
  "message": "<string>",
  "old_description": "<string>",
  "new_description": "<string>"
}

Authorizations

​
X-Api-Key
string
header
required
​
X-OpenAI-Key
string
header
required

Query Parameters

​
tone_adjustment
enum<string>

The tone of the description to be adjusted. This is an optional field.

Available options:
professional,
casual,
playful
​
style_target_audience
enum<string>

The style of the description to be adjusted to the target audience. This is an optional field.

Available options:
men,
women,
children
​
length_adjustment
integer

The length of the description to be adjusted in character count. This is an optional field.

​
use_bullet_points
boolean

The use of bullet points in the description. This is an optional field.

​
seo_optimization
boolean

The optimization of the description for SEO. This is an optional field.

​
translation_language
enum<string>

The language to which the description should be translated. This is an optional field.

Available options:
en,
de,
fr,
it

Body

application/json
​
product_description
string
required

A textual description of the item being categorized. This description is utilized to extract the available attributes.

Response

Successfully optimized the product description.

​
message
string
required
​
old_description
string
required
​
new_description
string
required