Form
The
FORM endpoint
allows you to create a video from a form input with pictures. To use this endpoint, you must provide a video title, text, and at least one image that you have uploaded through the/v1/api/assets/media
endpoint. You can also optionally provide 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/form
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 |
text | string | The text to display in the video. | Yes |
media | string | An array of asset identifiers corresponding to the images to include in the video. | Yes |
"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/form
curl -X 'POST'
'https://api.oxolo.com/v1/api/videos/create/form'
-H 'accept: application/json'
-H 'authorization: YOUR_API_KEY'
-H 'content-type: application/json'
-d '{
"template_id": "42b69075-952e-42fe-81d4-dbf8ed35120f",
"title": "string",
"text": "string",
"media": [
"{MEDIA_IDENTIFIER}"
]
}'"
}'
{"results": {"identifier": "{VIDEO_IDENTIFIER}"}}