Skip to main content
POST
/
tasks
/
attribution
Attribution Task
curl --request POST \
  --url https://ai.getlynks.io/api/tasks/attribution \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-OpenAI-Key: <api-key>' \
  --data '
{
  "product_description": "<string>"
}
'
{
  "message": "<string>",
  "category_identifier": "<string>",
  "product_description": "<string>",
  "context_language": "<string>",
  "extraction": [
    {
      "attribute_identifier": "<string>",
      "requirement_level": "<string>",
      "value_identifier": "<string>",
      "value_raw": "<string>",
      "value_unit": "<string>",
      "value_source": "PROVIDED_VALUES",
      "reasoning": "<string>",
      "confidence": "LOW"
    }
  ],
  "attribute_count": 123,
  "attributes": [
    {
      "identifier": "<string>",
      "requirement_level": "<string>",
      "languages": {
        "en": {
          "name": "<string>"
        },
        "de": {
          "name": "<string>"
        },
        "fr": {
          "name": "<string>"
        },
        "it": {
          "name": "<string>"
        }
      },
      "value_count": 123,
      "values": [
        {
          "identifier": "<string>",
          "languages": {
            "en": {
              "name": "<string>"
            },
            "de": {
              "name": "<string>"
            },
            "fr": {
              "name": "<string>"
            },
            "it": {
              "name": "<string>"
            }
          }
        }
      ]
    }
  ]
}

Authorizations

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

Query Parameters

category_identifier
string
required

The category assigned to the item

Flag indicating if to add recommended attributes to the process

add_optional
boolean
default:false

Flag indicating if to add optional attributes to the process

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 extracted attributes.

message
string
required
category_identifier
string
required
product_description
string
required
context_language
string
required
extraction
ExtractedAttributeValue · object[]
required
attribute_count
integer
required
attributes
AttributeWithValues · object[]
required