AI img
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 an image from a "AI img" 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) |
| firstName | string | The firstName of the person you are reaching out to. |
Optional Parameters
Here is the list of optional parameters you can use with this endpoint to control the image generation:
| Parameters | Type | Description |
|---|---|---|
| lastName | string | The lastName of the person you create an image for |
| jobTitle | string | The jobTitle of the person you create an image for |
| companyName | string | The companyName of the company you create an image for |
| yourCustomVariable | string | The yourCustomVariable you use for your image |
| string | The account email you want to send this image to. | |
| webhook | string | Attach a webhook url that will trigger when the image 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, an image 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 image that is being generated |
| placeholder | object | Various data that you can use as placeholder before the image is ready for you to use as well as data you provided when doing your image |
Inside the placeholder object you will receive:
| Parameters | Type | Description |
|---|---|---|
| imageLink | string | The url of your image |
| htmlCode | string | The preview html code you can use in your outreach tool |
| prompt | string | The prompt you input for your image |
| status | string | The status of the image, "pending" meaning that the image is in the creation process |
| date | string | The date when the image process started |
| firstName | string | The firstname you use for your image |
| lastName | string | The lastName you use for your image |
| jobTitle | string | The jobTitle you use for your image |
| companyName | string | The companyName you use for your image |
| yourCustomVariable | string | The yourCustomVariable you use for your image |
| string | The email you use for your image | |
| type | string | To help you filter automation, this variable will always be equal to "ai_image" |
| data | object | Additionnals data you used for your image, such as 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 |
| imageLink | string | The url of your image |
| htmlCode | string | The preview html code you can use in your outreach tool |
| imgSuccess | string | If the image is generate correctly, the response will be "YES", otherwise "NO" |
| prompt | string | The prompt you input for your image |
| status | string | The status of the image, "pending" meaning that the image is in the creation process |
| date | string | The date when the image process started |
| firstName | string | The firstname you use for your image |
| lastName | string | The lastName you use for your image |
| jobTitle | string | The jobTitle you use for your image |
| companyName | string | The companyName you use for your image |
| yourCustomVariable | string | The yourCustomVariable you use for your image |
| string | The email you use for your image | |
| type | string | To help you filter automation, this variable will always be equal to "ai_image" |
| 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 image, such as domain used |