API Documentation
General API documentation on how to integrate your software with Convi.io
POST https://app.convi.io/api/v1/videos/createOne
Create a single Convi video from a video template
Headers
x-api-key*
String
Company API Key
Request Body
videoName*
String
Name of the video to generate
videoTemplateId*
String
ID of the video template to use to generate the video (navigate to your video template to find the ID)
websiteUrl*
String
URL of the website to show in the video
webhookUrl
String
(Optional) Webhook URL for integrations. Called when the video is completed.
videoVariables
String[]
(Only required if video template uses AI)
List of strings representing the text you wish to use to replace the words you say in the video. Must be ordered from start to finish of the video.
Example:
For a video template that looks like this:
"Hello @firstName. I saw that you work at @companyName, and thought to reach out".
And with the following input for this field: ["Tim", "Apple"]
The output video will be:
"Hello Tim. I saw that you work at Apple, and thought to reach out".
Last updated