{ "openapi": "3.0.0", "info": { "title": "Ovesio API", "description": "Default endpoint URL is https://api.ovesio.com/, please read all the API documentation provided in the [Docs section of the website](https://docs.ovesio.com)", "version": "v1" }, "servers": [ { "url": "https://api.ovesio.com/v1" } ], "paths": { "/v1": {}, "/ai/generate-description": { "post": { "tags": [ "AI Content Machine - Description" ], "summary": "Generate Articles or Product descriptions using AI Content Machine", "description": "This endpoint is used to generate articels and product description based on given parameters.", "operationId": "17a5f20f21b59e5e1339685f99a29fa8", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "to": { "description": "Force the results to be in the specified language. If not set, it will be auto-detected from the input.", "type": "string", "example": "en", "nullable": true }, "workflow": { "description": "If not set, the default configured workflow will be used.", "type": "integer", "example": null, "nullable": true }, "callback_url": { "description": "The Url where we will send the results. If not set, the default callback url will be used.", "type": "string", "example": "https://example.com/callback-url", "nullable": true }, "data": { "description": "Array of objects representing individual requests", "type": "array", "items": { "properties": { "ref": { "description": "Customer referrence ID", "type": "string", "example": "1234ABC", "nullable": true }, "content": { "description": "Key-value pairs representing the parameters for the request", "properties": { "name": { "description": "Product name", "type": "string", "example": "SAMSUNG QN32Q60D 32 Inch QLED 4K Smart TV Bundle with Deco Gear 2X 4K HDMI 2.0" }, "categories": { "description": "Array of product categories", "type": "array", "items": { "type": "string" }, "example": [ "Smart TV", "Samsung", "Home Entertainment" ], "nullable": true }, "description": { "description": "Product description", "type": "string", "example": "Smart TV", "nullable": true }, "additional": { "description": "Additional parameters as array", "type": "array", "items": { "type": "string" }, "example": [ "Display Technology: LED", "Special Technology: QLED", "Image Quality: 4K" ], "nullable": true } }, "type": "object" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Indicates whether the operation was successful.", "type": "boolean", "example": true }, "data": { "description": "Array of objects containing all the languages iso code and name.", "type": "array", "items": { "properties": { "id": { "description": "The id of the registerd request", "type": "integer", "example": "320126" }, "ref": { "description": "Customer referrence ID", "type": "string", "example": "1234ABC" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "errors": { "description": "List of errors", "type": "object", "example": [] } }, "type": "object" } } } } }, "security": [ { "api_key_security": [] } ] } }, "/cost-estimation/ai/generate-description": { "post": { "tags": [ "Cost Estimation Calculator" ], "summary": "Check estimated costs, keep in mind that values are approximate.", "operationId": "1897b4d098ab9fd715f8a028096926fd", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "workflow": { "description": "If not set, the default configured workflow will be used.", "type": "integer", "example": null, "nullable": true }, "data": { "description": "Array of objects representing individual requests", "type": "array", "items": { "properties": { "content": { "description": "Key-value pairs representing the parameters for the request", "type": "array", "items": { "properties": { "name": { "description": "Product name", "type": "string", "example": "SAMSUNG QN32Q60D 32 Inch QLED 4K Smart TV Bundle with Deco Gear 2X 4K HDMI 2.0" }, "categories": { "description": "Array of product categories", "type": "array", "items": { "type": "string" }, "example": [ "Smart TV", "Samsung", "Home Entertainment" ], "nullable": true }, "description": { "description": "Product description", "type": "string", "example": "Smart TV", "nullable": true }, "additional": { "description": "Additional parameters as array", "type": "array", "items": { "type": "string" }, "example": [ "Display Technology: LED", "Special Technology: QLED", "Image Quality: 4K" ], "nullable": true } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Indicates whether the operation was successful.", "type": "boolean", "example": true }, "data": { "type": "array", "items": { "properties": { "credits": { "description": "Credit costs", "type": "integer", "example": "10" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "errors": { "description": "List of errors", "type": "object", "example": [] } }, "type": "object" } } } } }, "security": [ { "api_key_security": [] } ] } }, "/ai/generate-description/status/{id}": { "get": { "tags": [ "AI Content Machine - Description" ], "summary": "Get status of a Generate-Description Ai Request", "description": "This endpoint lists the status of an Generate-Description Ai Request", "operationId": "5a61602008ad0552115c854214613993", "parameters": [ { "name": "id", "in": "path", "description": "Numeric ID of the request", "required": true, "schema": { "type": "integer", "example": 348363 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "properties": { "id": { "type": "integer", "example": 11 }, "ref": { "type": "string", "example": "123" }, "to": { "type": "string", "example": "en" }, "status": { "type": "string", "example": "completed" }, "credits": { "type": "integer", "example": 0 }, "callback_url": { "type": "string", "example": "https://example.com/callback-url", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2025-02-20T13:22:19.000000Z" }, "data": { "properties": { "description": { "description": "Product description in HTML format", "type": "string", "format": "html", "example": "

Discover the Laptop Second Hand HP MT43

\\n

Experience powerful performance...

" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "errors": { "description": "List of errors", "type": "object", "example": [] } }, "type": "object" } } } } }, "security": [ { "api_key_security": [] } ] } }, "/ai/generate-seo": { "post": { "tags": [ "AI Content Machine - SEO" ], "summary": "SEO Meta Tags Meta Tags using AI Content Machine - generate Meta Tags for products & articles", "description": "This endpoint is used to generate product & article SEO Meta Tags based on given parameters.", "operationId": "2ef389cc5e5958e218fc0df615b8dde3", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "to": { "description": "Force the results to be in the specified language. If not set, it will be auto-detected from the input.", "type": "string", "example": "en", "nullable": true }, "workflow": { "description": "If not set, the default configured workflow will be used.", "type": "integer", "example": null, "nullable": true }, "callback_url": { "description": "The Url where we will send the results. If not set, the default callback url will be used.", "type": "string", "example": "https://example.com/callback-url", "nullable": true }, "data": { "description": "Array of objects representing individual requests", "type": "array", "items": { "properties": { "ref": { "description": "Customer referrence ID", "type": "string", "example": "1234ABC", "nullable": true }, "content": { "description": "Key-value pairs representing the parameters for the request.", "properties": { "name": { "description": "Product name", "type": "string", "example": "SAMSUNG QN32Q60D 32 Inch QLED 4K Smart TV Bundle with Deco Gear 2X 4K HDMI 2.0" }, "categories": { "description": "Array of product categories", "type": "array", "items": { "type": "string" }, "example": [ "Smart TV", "Samsung", "Home Entertainment" ], "nullable": true }, "description": { "description": "Product description", "type": "string", "example": "Smart TV", "nullable": true }, "additional": { "description": "Additional parameters as array", "type": "array", "items": { "type": "string" }, "example": [ "Display Technology: LED", "Special Technology: QLED", "Image Quality: 4K" ], "nullable": true } }, "type": "object" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Indicates whether the operation was successful.", "type": "boolean", "example": true }, "data": { "description": "Array of objects containing all the languages iso code and name.", "type": "array", "items": { "properties": { "id": { "description": "The id of the registerd request", "type": "integer", "example": "320126" }, "ref": { "description": "Customer referrence ID", "type": "string", "example": "1234ABC" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "errors": { "description": "List of errors", "type": "object", "example": [] } }, "type": "object" } } } } }, "security": [ { "api_key_security": [] } ] } }, "/cost-estimation/ai/generate-seo": { "post": { "tags": [ "Cost Estimation Calculator" ], "summary": "Check estimated costs, keep in mind that values are approximate.", "operationId": "5e56d1001ebf31f62e84f9845e18fd71", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "workflow": { "description": "If not set, the default configured workflow will be used.", "type": "integer", "example": null, "nullable": true }, "data": { "description": "Array of objects representing individual requests", "type": "array", "items": { "properties": { "content": { "description": "Key-value pairs representing the parameters for the request", "type": "array", "items": { "properties": { "name": { "description": "Product name", "type": "string", "example": "SAMSUNG QN32Q60D 32 Inch QLED 4K Smart TV Bundle with Deco Gear 2X 4K HDMI 2.0" }, "categories": { "description": "Array of product categories", "type": "array", "items": { "type": "string" }, "example": [ "Smart TV", "Samsung", "Home Entertainment" ], "nullable": true }, "description": { "description": "Product description", "type": "string", "example": "Smart TV", "nullable": true }, "additional": { "description": "Additional parameters as array", "type": "array", "items": { "type": "string" }, "example": [ "Display Technology: LED", "Special Technology: QLED", "Image Quality: 4K" ], "nullable": true } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Indicates whether the operation was successful.", "type": "boolean", "example": true }, "data": { "type": "array", "items": { "properties": { "credits": { "description": "Credit costs", "type": "integer", "example": "10" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "errors": { "description": "List of errors", "type": "object", "example": [] } }, "type": "object" } } } } }, "security": [ { "api_key_security": [] } ] } }, "/ai/generate-seo/status/{id}": { "get": { "tags": [ "AI Content Machine - SEO" ], "summary": "Get status of a Generate SEO Meta tag Ai Request", "description": "This endpoint lists the status of an Generate-Description Ai Request", "operationId": "c97a90c78a7636609676ba87b9d6dfd8", "parameters": [ { "name": "id", "in": "path", "description": "Numeric ID of the request", "required": true, "schema": { "type": "integer", "example": 348363 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "properties": { "id": { "type": "integer", "example": 15 }, "ref": { "type": "string", "example": "123" }, "to": { "type": "string", "example": "en" }, "status": { "type": "string", "example": "completed" }, "credits": { "type": "integer", "example": 0 }, "callback_url": { "type": "string", "example": "https://example.com/callback-url" }, "created_at": { "type": "string", "format": "date-time", "example": "2025-02-20T14:49:16.000000Z" }, "data": { "properties": { "seo_h1": { "type": "string", "example": "Laptop Second Hand HP MT43 - AMD Pro A8 Performance" }, "seo_h2": { "type": "string", "example": "Experience Powerful Performance with the HP MT43 Laptop" }, "seo_h3": { "type": "string", "example": "Affordable and Reliable Second Hand Laptop Option" }, "meta_title": { "type": "string", "example": "HP MT43 Second Hand Laptop - AMD Pro A8 Performance" }, "meta_description": { "type": "string", "example": "Discover the HP MT43 Second Hand Laptop with AMD Pro A8, 8GB RAM, and integrated graphics for powerful performance at an affordable price." }, "meta_keywords": { "type": "string", "example": "HP MT43, Second Hand Laptop, AMD Pro A8, 8GB RAM, Affordable Laptops" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "errors": { "description": "List of errors", "type": "object", "example": [] } }, "type": "object" } } } } }, "security": [ { "api_key_security": [] } ] } }, "/languages": { "get": { "tags": [ "Languages" ], "summary": "Get supported languages list", "description": "This endpoint will list all the avalable languages.", "operationId": "7b00e966d775cfeba6a1417439107f0c", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Indicates whether the operation was successful.", "type": "boolean", "example": true }, "data": { "description": "Array of objects containing all the languages iso code and name.", "type": "array", "items": { "properties": { "code": { "description": "ISO2 langauge code.", "type": "strig", "example": "en" }, "name": { "description": "Name of the language.", "type": "string", "example": "English" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "api_key_security": [] } ] } }, "/cost-estimation/translate/request": { "post": { "tags": [ "Cost Estimation Calculator" ], "summary": "Check estimated costs before translating.", "operationId": "9ab8f69319c0a0f9365493f1b0768c08", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "to": { "description": "the languages we need to translate the text to", "type": "object", "example": [ "en", "bg", "de", "nl", "sk" ], "additionalProperties": { "type": "string" } }, "workflow": { "description": "If not set, the default configured workflow will be used.", "type": "integer", "example": null, "nullable": true }, "data": { "description": "Array of objects containing content to be translated.", "type": "array", "items": { "properties": { "content": { "description": "Array of key-value pairs representing the content to be translated.", "type": "array", "items": { "properties": { "key": { "description": "Unique key for the content item.", "type": "string", "example": "name" }, "value": { "description": "Value of the content item.", "type": "string", "example": "SAMSUNG QN32Q60D 32 Inch QLED 4K Smart TV Bundle with Deco Gear 2X 4K HDMI 2.0" }, "context": { "description": "Optional context for the translation. This will be sent but not translated.", "type": "string", "example": "Smart TV", "nullable": true } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Indicates whether the operation was successful.", "type": "boolean", "example": true }, "data": { "type": "array", "items": { "properties": { "credits": { "description": "Credit costs", "type": "integer", "example": "10" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "errors": { "description": "List of errors", "type": "object", "example": [] } }, "type": "object" } } } } }, "security": [ { "api_key_security": [] } ] } }, "/translate/request": { "post": { "tags": [ "Translate" ], "summary": "Translate content based on the provided languages", "description": "This endpoint processes translation requests and returns translated content.", "operationId": "4145549a8d1809454233674b0e1e075d", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "from": { "description": "Language code of the source text.", "type": "string", "example": "ro" }, "delta_mode": { "description": "If true, only returns results that have changed since the last request.", "type": "boolean", "example": true, "nullable": true }, "use_existing_translation": { "description": "If true, it will search if there is a translation already made for the given content, and if there is, it will serve that one.", "type": "boolean", "example": true, "nullable": true }, "to": { "description": "the languages we need to translate the text to", "type": "object", "example": [ "en", "bg", "de", "nl", "sk" ], "additionalProperties": { "type": "string" } }, "conditions": { "description": "in case we need the translations to be based on other languages instead of the default one", "type": "object", "example": { "de": "en", "nl": "en", "sk": "en" }, "nullable": true, "additionalProperties": { "type": "string" } }, "workflow": { "description": "If not set, the default configured workflow will be used.", "type": "integer", "example": 1, "nullable": true }, "callback_url": { "description": "The Url where we will send the translated content. If not set, the default callback url will be used.", "type": "string", "example": "https://example.com/callback-url", "nullable": true }, "data": { "description": "Array of objects containing content to be translated.", "type": "array", "items": { "properties": { "ref": { "description": "Customer referrence ID", "type": "strig", "example": "1234ABC", "nullable": true }, "content": { "description": "Array of key-value pairs representing the content to be translated.", "type": "array", "items": { "properties": { "key": { "description": "Unique key for the content item.", "type": "string", "example": "name" }, "value": { "description": "Value of the content item.", "type": "string", "example": "SAMSUNG QN32Q60D 32 Inch QLED 4K Smart TV Bundle with Deco Gear 2X 4K HDMI 2.0" }, "context": { "description": "Optional context for the translation. This will be sent but not translated.", "type": "string", "example": "Smart TV", "nullable": true } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Indicates whether the operation was successful.", "type": "boolean", "example": true }, "data": { "type": "array", "items": { "properties": { "id": { "description": "The id of the registerd request", "type": "integer", "example": "320126" }, "ref": { "description": "Customer referrence ID", "type": "strig", "example": "1234ABC" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "errors": { "description": "List of errors", "type": "object", "example": [] } }, "type": "object" } } } } }, "security": [ { "api_key_security": [] } ] } }, "/translate/request/status/{id}": { "get": { "tags": [ "Translate" ], "summary": "Get status of a translate request", "description": "This endpoint lists the status of translation request", "operationId": "86551c773abbf25817bf248e123294ae", "parameters": [ { "name": "id", "in": "path", "description": "ID-ul numeric al cererii de traducere", "required": true, "schema": { "type": "integer", "example": 348363 } } ], "responses": { "200": { "description": "Data was successfully obtained", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "properties": { "id": { "type": "integer", "example": 348363 }, "ref": { "description": "Customer referrence ID", "type": "string", "example": "1234ABC", "nullable": true }, "from": { "type": "string", "example": "es" }, "to": { "type": "string", "example": "en" }, "status": { "type": "string", "example": "completed" }, "credits": { "type": "integer", "example": "5" }, "callback_url": { "type": "string", "example": "https://example.com/callback-url" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-08-13T13:12:41.000000Z" }, "data": { "type": "array", "items": { "properties": { "from": { "type": "string", "example": "en" }, "to": { "type": "string", "example": "de" }, "status": { "type": "string", "example": "completed" }, "content": { "type": "array", "items": { "properties": { "key": { "type": "string", "example": "name" }, "value": { "type": "string", "example": "SAMSUNG QN32Q60D 32 Zoll QLED 4K Smart TV-Paket mit Deco Gear 2X 4K HDMI 2.0" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "errors": { "description": "List of errors", "type": "object", "example": [] } }, "type": "object" } } } } }, "security": [ { "api_key_security": [] } ] } }, "/workflows": { "get": { "tags": [ "Workflows" ], "summary": "Get the list of workflows", "description": "This endpoint lists all the workflows", "operationId": "37c2af0991a98318cffa9f19417b174f", "responses": { "200": { "description": "Data was successfully obtained", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "description": "Array of objects containing all the languages iso code and name.", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "type": { "description": "Type of workflow: translate, generate_description, generate_seo", "type": "string", "example": "translate" }, "name": { "description": "Name of the workflow", "type": "string", "example": "Default" }, "is_default": { "description": "Is true if the workflow is default", "type": "boolean", "example": "1" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "errors": { "description": "List of errors", "type": "object", "example": [] } }, "type": "object" } } } } }, "security": [ { "api_key_security": [] } ] } } }, "tags": [ { "name": "Translate", "description": "Endpoints related to text translation." }, { "name": "AI Content Machine - Description", "description": "Generates Product Descriptions according to received data set." }, { "name": "AI Content Machine - SEO", "description": "Generates Product SEO according to received data set." }, { "name": "Workflows", "description": "Get workflows list" }, { "name": "Languages", "description": "Get supported languages list" }, { "name": "Cost Estimation Calculator", "description": "Estimate your costs based on the number of words and characters." } ], "components": { "securitySchemes": { "api_key_security": { "type": "apiKey", "description": "You need to use the token provided in settings page of your project", "name": "X-Api-Key", "in": "header" } } }, "security": [ { "api_key_security": [] } ] }