API Documentation
Get a template
Read one template by its id, with all of its layers. Send the layer names in modifications to change the text, images, and data in a render.
GET https://api.bannerify.co/v1/templates/:id
Return one template with its layers. Use the layer names as the name of a modification.
Query parameters
| Name | Type | Description |
|---|---|---|
apiKey (required) | string | Your API key. Create one on the API Keys page of the dashboard, and keep it on the server. |
Responses
200: The template and its layers.400: The request cannot be processed. BAD_REQUEST means a field is invalid, the API key is unknown, or a signed URL has a wrong signature. FETCH_IMAGE_ERROR means Bannerify could not download an image from a src URL. A rate limit on the PDF and stored endpoints also uses status 400 with the code TOO_MANY_REQUESTS. Read error.code to tell them apart.404: The template does not exist.500: The server could not finish the request. INTERNAL_SERVER_ERROR means an unexpected failure, such as a render error or a failed upload to your S3 bucket. USAGE_EXCEEDED means your workspace reached its daily or monthly generation limit, and RATE_LIMITED means the API key sent too many requests. Read error.code to tell them apart.
GET https://api.bannerify.co/v1/templates/:id
Return one template with its layers. Use the layer names as the name of a modification.
Query parameters
| Name | Type | Description |
|---|---|---|
apiKey (required) | string | Your API key. Create one on the API Keys page of the dashboard, and keep it on the server. |
Responses
200: The template and its layers.400: The request cannot be processed. BAD_REQUEST means a field is invalid, the API key is unknown, or a signed URL has a wrong signature. FETCH_IMAGE_ERROR means Bannerify could not download an image from a src URL. A rate limit on the PDF and stored endpoints also uses status 400 with the code TOO_MANY_REQUESTS. Read error.code to tell them apart.404: The template does not exist.500: The server could not finish the request. INTERNAL_SERVER_ERROR means an unexpected failure, such as a render error or a failed upload to your S3 bucket. USAGE_EXCEEDED means your workspace reached its daily or monthly generation limit, and RATE_LIMITED means the API key sent too many requests. Read error.code to tell them apart.