API Documentation
Get workspace info
Check that an API key works. The info endpoint answers with the workspace that owns the key: its id, its name, and the date it was created.
GET https://api.bannerify.co/v1/info
Return the id, name, and creation date of the workspace that owns the API key. This is useful to check that a key works.
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 workspace of the API key.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/info
Return the id, name, and creation date of the workspace that owns the API key. This is useful to check that a key works.
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 workspace of the API key.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.