Skip to main content
POST
/
tasks
/
categorization
Categorization Task
curl --request POST \
  --url https://ai.getlynks.io/api/tasks/categorization \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-OpenAI-Key: <api-key>' \
  --data '
{
  "product_description": "<string>"
}
'
{
  "message": "<string>",
  "product_description": "<string>",
  "sales_channel": "galaxus",
  "context_language": "en",
  "best_prediction": {
    "identifier": "<string>",
    "languages": {}
  },
  "predicted_categories": [
    {
      "identifier": "<string>",
      "languages": {}
    }
  ]
}

Authorizations

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

Query Parameters

​
sales_channel
enum<string>
required

The name of the sales channel for which the categorization is being performed. This is a required field.

Available options:
galaxus,
manor
​
use_rag
boolean
default:true

A boolean value indicating whether the categorization should be performed precisely or not. This is an optional field with a default value of True.

​
results_limit
integer
default:10

The maximum number of category suggestions to return. It's an optional field with a default value of 10.

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

Product with predicted category.

​
message
string
required
​
product_description
string
required
​
sales_channel
enum<string>
required
Available options:
galaxus,
manor
​
context_language
enum<string>
required
Available options:
en,
de,
fr,
it
​
best_prediction
PredictedCategory · object
required
​
predicted_categories
PredictedCategory · object[]
required