images.bannerify.co. Add an s3Config object to the request, and Bannerify writes the file to your bucket and returns the link to that copy. Use it when the files must live in your own storage or behind your own domain. Custom S3 storage is part of the Scale and Enterprise plans.
Prerequisites
- A workspace on the Scale or Enterprise plan. A request with
s3Configfrom a workspace on the Free or Automate plan fails withFORBIDDENand does not count as a generation. - An S3-compatible bucket and an access key that can upload objects to it. Bannerify only uploads files. It does not read or delete anything in the bucket.
- A Bannerify API key and a template.
Save a file to your bucket
- Add
s3Configto the body of acreateStoredImageorcreateStoredPdfrequest:
- Read the response. The
urlpoints to the file in your bucket:
s3Config. The createImage, createPdf, and signedurl endpoints do not save files.
s3Config fields
A missing required field fails with
BAD_REQUEST.
Where the file goes
- Bannerify writes the file to the root of the bucket. The name is a random id plus an extension:
.png,.jpgfor JPEG,.webp, or.pdf. You cannot choose a folder or a name. - The file lives only in your bucket. Bannerify does not keep a copy on its CDN.
- The returned link is not signed. It works only when whoever opens it can read the object, so make the object public or set
customUrlto a public address.
Use Cloudflare R2
Cloudflare R2 uses the same fields. SetendPoint to ACCOUNT_ID.r2.cloudflarestorage.com with your account id, and set region to auto. R2 serves public files from a custom domain, so set customUrl to that domain:
Use an SDK or a no-code tool
The JavaScript SDK acceptss3Config in createStoredImage. See Create images and PDFs. The Python and PHP SDKs cannot send s3Config, the Go SDK has no stored image method, and no SDK wraps createStoredPdf. Call the REST endpoint from those languages.
The Zapier, n8n, and Pipedream actions do not send s3Config. To save files to your bucket from a workflow, call the REST endpoint from an HTTP request step in the tool.
Handle upload errors
When the upload to your bucket fails, the request fails withINTERNAL_SERVER_ERROR and the message Failed to upload image to custom S3 storage. For a PDF the message is Failed to upload PDF to custom S3 storage. Check the endpoint, the region, the bucket name, and the keys. INTERNAL_SERVER_ERROR explains how to handle the code.
Send the link to other apps
To send a file to Google Drive, Dropbox, or Slack, add a step after the Bannerify action in Zapier, n8n, or Pipedream. That step uploads the file from itsurl or posts the link in a message.