Product
The
PRODUCT endpoint
allows you to create a video from product information, often found in e-commerce shop systems. To use this endpoint, you must provide product information as well as any optional parameters such as a template, voice, actor, or music track. The request should be sent as a JSON payload in the body of a POST request to the /v1/api/videos/create/product
endpoint, with the necessary authorization and content-type headers included.If you're unsure about the available options for the optional parameters, you can refer to the Catalogue section of the API documentation to retrieve information about actors, voices, templates, and music tracks.
| Parameter | Type | Description | Required |
|---|---|---|---|
| template_id | string | The identifier of the template to use for the video creation. | Yes |
| voice_id | string | The identifier of the voice to use for the video creation. | |
| actor_id | string | The identifier of the actor to use for the video creation. | |
| music_id | string | The identifier of the music track to use for the video creation. | |
| title | string | The title of the video. | Yes |
| short_description | string | A short description of the product. | Yes |
| long_description | string | A long description of the product. | Yes |
| price | number | The price of the product. | |
| recommended_retail_price | number | The recommended retail price of the product. | |
| product_category | string | The category of the product. | |
| reviews | array | An array of reviews for the product. Each review should be a string. | |
| media | array | An array of media identifiers for images of the product. | Yes |
| shop_url | string | The URL of the product page on the shop's website. | |
| data | object | An object containing any additional data to include in the video creation. | |
| metadata | object | An object containing any additional metadata to include in the video creation. | |
"global": {
"spec": {
"target_platform": "Amazon",
"target_language": "it",
"target_age_group": {
"min": 6,
"max": 12
},
"target_gender":"Female"
}
} | object | The section specifies the target platform, target language, and target age group for content specifications. Available target platform is 'Amazon', 'Etsy', 'YouTube (Ads)', 'Snap', 'Tik Tok', 'Instagram', 'Facebook', 'LinkedIn'. Available target gender is 'Female', 'Male', 'Male|Female' |
HTTP Request
POST https://api.oxolo.com/v1/api/videos/create/productcurl -X 'POST'
'https://api.oxolo.com/v1/api/videos/create/product'
-H 'accept: application/json'
-H 'authorization: YOUR_API_KEY'
-H 'content-type: application/json'
-d '{
"template_id": "42b69075-952e-42fe-81d4-dbf8ed35120f",
"title": "string",
"short_description": "string",
"long_description": "string",
"price": 0,
"recomended_retail_price": 0,
"product_category": "string",
"reviews": [
"string"
],
"media": [
"{MEDIA_IDENTIFIER}"
],
"shop_url": "string",
"data": {},
"metadata": {}
}'{"results": {"identifier": "{VIDEO_IDENTIFIER}"}}