Endpoint for automatic generation of SEO tags
This endpoint allows automatic generation of SEO content (such as meta title, description and keywords) for products or pages, based on the data provided. The result is generated using AI and delivered in the specified language.
Endpoint URL
https://api.ovesio.com/v1/ai/generate-seo
Method
POST
Data format
{
"workflow": null,
"to": "en",
"callback_url": "https://example.com/callback-url",
"data": [
{
"ref": "1234ABC",
"content": {
"name": "Apple iPhone 15 Pro Max",
"categories": ["Smartphones", "Apple", "Electronics"],
"description": "High-end smartphone with advanced camera and performance",
"additional": [
"Color: Silver",
"Storage: 256GB",
"Chip: A17 Pro"
]
}
}
]
}
Request parameters
Parameter | Type | compulsory | Description |
---|---|---|---|
workflow | integer | not | If not specified, the default workflow is used. |
to | thong | not | The language in which the result will be generated. If not defined, it will be automatically detected. |
callback_url | thong | not | The URL to which the response with the generated result will be sent. |
date | array | Yes | List of requests for which you want to generate SEO tags. |
data
field structure
Field | Type | compulsory | Description |
---|---|---|---|
ref | thong | not | Unique reference for further identification (e.g. product ID). |
content | object | Yes | Object containing descriptive information for AI. |
content
field structure
Field | Type | compulsory | Description |
---|---|---|---|
name | thong | Yes | Product name or page title. |
categories | array | not | List of associated categories. |
description | thong | not | General description. |
additional | array | not | List of additional details (e.g. technical specifications). |
Possible answers
Successful response (HTTP 200)
{
"success": true,
"data": [
{
"id": 789123,
"ref": "1234ABC"
}
]
}
The request has been registered and will be processed in the background. You can use id
to check the status.
Error response (HTTP 400)
{
"success": false,
"errors": []
}
In case of an error, the response includes the key success: false
and a list of messages in errors
explaining the problem.
Integration examples
You can check out integration examples available on the official Ovesio GitHub page .