POST /chatgptApi
https://api.repliq.co/chatgptApiRequirements
On each request you need to provide your Bearer authentication token. See the Authentication section for more details.
| Authorization | Bearer Token |
|---|---|
| Token | <token> |
POST /chatgptApi
Mandatory Parameters
On each request, this endpoint requires the following parameters:
| Parameters | Type | Description |
|---|---|---|
| companyName | string | The name of the company you want to use as variable (You can put "NA" if you don't want to use this) |
| string | Your RepliQ account email. | |
| previewTitle | string | The title you want to use for your video and preview. |
| videoUrl | string | The video you are gonna use with your background (Must be an url pointing to a video file) |
| prompt | string | The prompt you are gonna use as chatgpt message. You can you variable such as {CompanyName}, {FirstName}, {LastName}, {JobTitle}, {Competitor} {YourCustomVariable}. These variable must be written exactly as shown. |
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 |
| jobTitle | string | The job title you want to use in your variable {JobTitle} |
| competitor | string | The competitor you want to use in your variable {Competitor} |
| yourCustomVariable | string | The yourCustomVariable you want to use in your variable {yourCustomVariable} |
| ctaText | string | The call to action button text |
| ctaLink | string | The call to action button link |
| logo | string | The url of your logo file that will display instead of RepliQ in the video page |
| mouse | boolean | Either true will show a mouse moving on the video, false will not display it (default to true) |
| videoBubble | string | Choose between "Big", "Small", "Fullscreen" to control your video bubble display after X seconds |
| expandBubbleTime | number | Time where your video switch to your video bubble option (Default is 10) |
| secondVideoUrl | string | If you want to switch to another video after your Introduction |
| previewDescription | string | This control the meta data description of your video (Default is "Intro") |
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 |
|---|---|---|
| videoSuccess | string | Let you know if the video provided was successfull |
| videoPageUrl | string | The url of your video |
| originUrl | string | The url of the site you wanted to use as background |
| htmlEmailCode | string | The preview html code you can use in your outreach tool |
| htmlEmailCodeShort | 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 |
| img | string | The preview image url |
| imgHtmlCode | string | The preview image html code |
| jobTitle | string | The jobTitle you choose as variable for your video |
| competitor | string | The competitor you choose as variable for your video |
| yourCustomVariable | string | The yourCustomVariable you choose as variable for your video |
| firstName | string | The firstName you choose as variable for your video |
| lastName | string | The lastName you choose as variable for your video |
| prompt | string | The prompt you use to generate your video |
| resultPrompt | string | The resulting AI message you got from chatgpt depending of your prompt and variables |
| data | string | The data you send RepliQ to generate the video as well as the id of this video |