Generate description

Endpoint for generating AI descriptions

This endpoint allows for the generation of articles or product descriptions using artificial intelligence. You need to pass in product information in a clear structure, and the AI ​​system will return an automatically generated description.

Endpoint URL

 https://api.ovesio.com/v1/ai/generate-description

Method

 POST

Data format

 application/json

JSON request example

{
  "workflow": null,
  "to": "en",
  "callback_url": "https://example.com/callback-url",
  "data": [
    {
      "ref": "1234ABC",
      "content": {
        "name": "SAMSUNG QN32Q60D 32 Inch QLED 4K Smart TV Bundle",
        "categories": ["Smart TV", "Samsung", "Home Entertainment"],
        "description": "Smart TV",
        "additional": [
          "Display Technology: LED",
          "Special Technology: QLED",
          "Image Quality: 4K"
        ]
      }
    }
  ]
}

Request parameters

Parameter Type compulsory Description
workflow integer not If not specified, the configured default workflow will be used.
to thong not The language in which the result will be generated. If not set, it will be automatically detected.
callback_url thong not The URL to which the response will be sent. If not set, the configured default URL is used.
date array Yes The list of objects with the data for each individual request.


data field structure

Field Type compulsory Description
ref thong not The reference ID for the customer.
content object Yes Object containing product details.


content field structure

Field Type compulsory Description
name thong Yes Product name.
categories array not List of categories associated with the product.
description thong not Product description.
additional array not List of specifications or additional information.


Possible answers

Successful response (HTTP 200)

{
  "success": true,
  "data": [
    {
      "id": 320126,
      "ref": "1234ABC"
    }
  ]
}

The request has been registered, and the system has returned its ID along with your reference.

Error response (HTTP 400)

{
  "success": false,
  "errors": []
}

The response indicates that the request was not valid. The errors field will contain a list of details about what went wrong.

Integration examples

You can check out integration examples available on the official Ovesio GitHub page .