Video scale
https://api.repliq.co/v2/launchTemplateRequirements
On each request you need to provide your Bearer authentication token. See the Authentication section for more details.
| Authorization | Bearer Token |
|---|---|
| Token | <token> |
POST /launchTemplate
This API call launch a request to generate a video from a "Video Scale" RepliQ template. See RepliQ dashboard (opens in a new tab) about the options you have access for this type of template.
Mandatory Parameters
On each request, this endpoint requires the following parameters:
| Parameters | Type | Description |
|---|---|---|
| templateId | string | The id of the template you want to use. Id can be found on here (opens in a new tab) |
| url | string | The url of the website you want to use as background. |
Optional Parameters
Here is the list of optional parameters you can use with this endpoint to control the video generation:
| Parameters | Type | Description |
|---|---|---|
| firstName | string | The name of the person you create the video for |
| lastName | string | The lastName of the person you create the video for |
| string | The account email you want to send this the video to. | |
| webhook | string | Attach a webhook url that will trigger when the video is ready for you to use. You cannot use multiple url. Zapier, make or pabbly webhooks are automaticaly added, so no need to include them in the request. |
Response Parameters
Depending of the traffic, a video gets generated in around 1min. Following is the list of parameters you will receive in the response if you get a 200 status code:
| Parameters | Type | Description |
|---|---|---|
| id | string | The id of the video that is being generated |
| placeholder | object | Various data that you can use as placeholder before the video is ready for you to use as well as data you provided when doing your video. |
Inside the placeholder object you will receive:
| Parameters | Type | Description |
|---|---|---|
| videoLink | string | The url of your video |
| videoPreview | string | The preview image or gif url |
| htmlCode | string | The preview html code you can use in your outreach tool |
| shortHtml | string | Another preview html code which is less than 250 characters long (for tool that require this). It does not contain a title bellow with your prospects info |
| imgHtmlCode | string | The preview image html code |
| status | string | The status of the video, "pending" meaning that the video is in the creation process |
| background | string | The background use for your video |
| date | string | The date when the video process started |
| originUrl | string | The url you choose for the background of your video |
| firstName | string | The firstname you use for your video |
| lastName | string | The lastName you use for your video |
| string | The email you use for your video | |
| type | string | To help you filter automation, this variable will always be equal to "video_scale" |
| templateName | string | To help you filter automation, this variable will always be equal to your selected template name |
| data | object | Additionnals data you used for your video such as videoTitle, videoDescription, ctaLink, ctaText, calendarUrl, logo and domain used |
Webhook Response Parameters
If you have attached a webhook url to your request OR you are using Zapier / Make or Pabbly automation trigger, you will receive the following response on a successfull request:
| Parameters | Type | Description |
|---|---|---|
| id | string | The id of your process |
| videoLink | string | The url of your video |
| videoPreview | string | The preview image or gif url |
| htmlCode | string | The preview html code you can use in your outreach tool |
| shortHtml | string | Another preview html code which is less than 250 characters long (for tool that require this). It does not contain a title bellow with your prospects info |
| imgHtmlCode | string | The preview image html code |
| videoSuccess | string | If the video is generate correctly, the response will be "YES", otherwise "NO" |
| status | string | The status of the video, "pending" meaning that the video is in the creation process |
| background | string | The background use for your video |
| date | string | The date when the video process started |
| originUrl | string | The url you choose for the background of your video |
| firstName | string | The firstname you use for your video |
| lastName | string | The lastName you use for your video |
| string | The email you use for your video | |
| type | string | To help you filter automation, this variable will always be equal to "video_scale" |
| templateName | string | To help you filter automation, this variable will always be equal to your selected template name |
| data | object | Additionnals data you used for your video such as videoTitle, videoDescription, ctaLink, ctaText, calendarUrl, logo and domain used |