Bannerbear API Reference

Bannerbear is a service that auto generates images and videos.

1. Your designer designs a template in Bannerbear
2. We turn it into an API
3. You use this API to generate Images and Videos

See examples in Image Examples and Video Examples.

Authentication

Bannerbear uses API keys to allow access to the API. You can get an API key by creating a project in Bannerbear.

Bannerbear expects the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer API_KEY

All API requests on Bannerbear are scoped to a Project.

Project API Key

This key enables you to interact with a specific project via API.

You can find the Project API Key in your Project → Settings page.

Master API Key

You can optionally create a Master API Key which allows higher level access at the account level.

There are two types of Master API Key:

1. Limited Access: create and list Projects
2. Full Access: create and list Projects as well as interact with any Project (e.g. create Images, Videos etc)

When using a Full Access Master API Key to interact with a Project using any of the standard endpoints below, you must add a project_id parameter to your payload.

Account

To check your account status at any time you can use this endpoint. It will respond with your quota levels and current usage levels. Usage resets at the start of every month.

Async / Sync

The Bannerbear API is primarily asynchronous. When generating a new image, collection etc you POST a request, the API responds immediately with 202 Accepted and you either receive the generated result via webhook or via polling.

This is the preferred pattern as it keeps the request / response cycle predictable.

However, there is a synchronous option if you would simply like to wait for the response in the initial request.

To make a synchronous request use the synchronous base URL. The API required attributes / parameters function the same as normal. Synchronous requests will wait until the media file has finished generating before responding.

There is a timeout of 10 seconds on synchronous requests. Timeouts respond with a 408 status code.

Another option for synchronous image generation is using the signed URLs feature.

Images

Images are the main resource on Bannerbear.

You generate images by sending a POST request with a template uid and a list of template modifications you want to apply. These modifications can be things like: changing the text, changing the images or changing the colors.

Bannerbear will respond with JPG and PNG (and PDF, if requested) formats of the new Image you have requested.

The image object

Attributes

These attributes are populated by Bannerbear. All other attributes of the object are set by the user at the time of creation.

• uidstringThe unique ID for this object.
• statusstringThe current status of the image; pending, completed or failed.
• selfstringThe permalink to this object.
• image_urlstringThe final, rendered image url. This will be null to begin with and populates when the image has the status completed
• pdf_urlstringUrl to the generated PDF, if render_pdf was set to true.
• webhook_response_codeintegerThe HTTP response code received by the webhook_url.

Create an image

Creating an image on Bannerbear is achieved via this endpoint.

This endpoint responds with 202 Accepted after which your image will be queued to generate. Images are usually rendered within a few seconds. When completed, the status changes to completed.

You can poll the GET endpoint for status updates or use a webhook to get the final image posted to you.

This endpoint supports synchronous generation.

Parameters

• templatestringrequiredThe template uid that you want to use.
• modificationslistrequiredA list of modifications you want to make.
  • Child Parameters
  • namestring requiredThe name of the layer you want to change.
  • colorstringColor in hex format e.g. "#FF0000".
  • Text Container
  • textstringReplacement text you want to use.
  • backgroundstringBackground color in hex format e.g. "#FF0000".
  • background_border_colorstringBackground border color in hex format e.g. "#FF0000".
  • font_familystringChange the font.
  • text_align_hstringHorizontal alignment (left, center, right)
  • text_align_vstringVertical alignment (top, center, bottom)
  • font_family_2stringChange the secondary font.
  • color_2stringChange the secondary font color.
  • Image Container
  • image_urlstringChange the image.
  • effectstringChange the effect.
  • anchor_xstringChange the anchor point (left, center, right).
  • anchor_ystringChange the anchor point (top, center, bottom).
  • fill_typestringChange the fill type (fill, fit).
  • disable_face_detectbooleanSet to true to disable face detect for this request (if the image container is using face detect).
  • disable_smart_cropbooleanSet to true to disable smart crop for this request (if the image container is using smart crop).
  • Bar / Line Chart
  • chart_datastringComma-delimited list of numbers to use as data.
  • Star Rating
  • ratingintegerNumber from 0 to 100 to use as the rating.
  • QR Code
  • targetstringURL or text to use as the code target.
  • Bar Code
  • bar_code_datastringText to encode as a bar code.
  • Any Layer Type
  • gradientlistFill with gradient e.g. ["#000", "#FFF"]
  • shadowstringAdd a shadow e.g. "5px 5px 0 #CCC"
  • border_widthinteger Width of the object border.
  • border_colorstring Border color in hex format e.g. "#FF0000".
  • shift_xintegerShift layer along the x axis.
  • shift_yintegerShift layer along the y axis.
  • targetstringAdd a clickable link to a URL on this object when rendering a PDF.
  • hidebooleanSet to true to hide a layer.
• webhook_urlstringA url to POST the full Image object to upon rendering completed.
• transparentbooleanRender a PNG with a transparent background. Default is false.
• render_pdfbooleanRender a PDF. This feature costs 3x quota.
• template_versionintegerCreate image based on a specific version of the template.
• metadatastringAny metadata that you need to store e.g. ID of a record in your DB.

Retrieve an image

Retrieves a single Image object referenced by its unique ID.

Parameters

• uidstringrequiredThe image uid that you want to retrieve.

List all images

Lists images inside a project.

Parameters

• pageintegerquery stringThe page of results you would like to retrieve. The API returns 25 items per page.
• limitintegerquery stringThe API returns 25 items per page by default but you can request up to 100 using this parameter.

Examples

Videos

Videos are generated from a Video Template.

Bannerbear can generate 3 types of video:

1. Overlay a video with a static overlay
2. Transcribe a video with auto-transcribed subtitles
3. Multi Overlay a video with a slideshow overlay

These are set at the Video Template level.

You generate videos by sending a POST request with a video template uid, a list of template modifications you want to apply, and a media file.

Bannerbear will respond with an MP4 format of the new Video you have requested.

The video object

Attributes

These attributes are populated by Bannerbear. All other attributes of the object are set by the user at the time of creation.

• uidstringThe unique ID for this object.
• statusstringThe current status of the video; pending, pending_approval, rendering, completed or failed.
• selfstringThe permalink to this object.
• video_urlstringThe final, rendered video url. This will be null to begin with and populates when the video has the status completed
• length_in_secondsintegerThe measured length in seconds of the input_media_url. Bannerbear will validate the length before rendering videos to prevent going over quota.
• render_typestringThe name of the Build Pack.
• percent_renderedintegerThe progress of the video render from 0 to 100.
• transcriptionlistThe transcription for the video line by line. This is populated automatically if you are using Bannerbear's auto-transcription feature.
• gif_preview_urlstringA low frame rate gif preview of the final video. Requires setting create_gif_preview to true.
• webhook_response_codeintegerThe HTTP response code received by the webhook_url.

Create a video

Creating a video on Bannerbear is achieved via this endpoint.

This endpoint responds with 202 Accepted after which your video will be queued to generate. Video rendering time depends on length / complexity of the video. It can vary from a few seconds to a few minutes. When completed, the status changes to completed.

You can poll the GET endpoint for status updates or use a webhook to get the final video posted to you.

Parameters

• video_templatestringrequiredThe video template uid that you want to use.
• input_media_urlstringFull url to a video or audio file you want to import as the background of the video. You can also use a static image, and the zoom parameter will be set automatically. This is required depending on the build pack of the template you are using:
  • Build Pack
  • Overlayinput_media_url is required
  • Transcribeinput_media_url is required
  • Multi Overlay input_media_url is optional
• modificationslistA list of modifications you want to make. See Create an image for more details on the child parameters. Unlike an Image the modifications list is not always required for a Video.
• zoomstringApply a panning zoom effect to the video or image, can be one of: center, top, right, bottom, left.
• zoom_factorfloatAmount to zoom in by from 1 to 100. If zoom is set and zoom_factor is left blank, this will default to 10.
• blurintegerApply a blur filter (from 1 to 10) to the incoming video.
• trim_start_timestringTrim the input_media_url clip to a specific start point, using HH:MM:SS notation.
• trim_end_timestringTrim the input_media_url clip to a specific end point, using HH:MM:SS notation.
• trim_to_length_in_secondsintegerForce trim the end video to a specific time. There are two ways to trim videos, either you use trim_to_length_in_seconds to trim from the start point by specifying a desired length.
  Or you can use trim_start_time and trim_end_time to specify a part of the video / audio to be used.
• webhook_urlstringA url to POST the full Video object to upon rendering completed.
• metadatastringAny metadata that you need to store e.g. ID of a record in your DB.
• frameslistApplies only to videos using the Multi Overlay build pack. A list of modifications lists, each one representing a single graphic overlay on the video.
• frame_durationslistApplies only to videos using the Multi Overlay build pack. Custom durations for each frame. When not specified, frames will be spread evenly across the video.
• create_gif_previewbooleanSet to true to create a short animated gif preview in addition to the final mp4.

Retrieve a video

Parameters

• uidstringrequiredThe video uid that you want to retrieve.

Update a video

Parameters

• uidstringrequiredThe video uid that you want to update.
• transcriptionlistA replacement transcription containing your corrected / edited text. Note that each element of the transcription array represents a specific timestamp. For that reason, the number of lines of your patched text must match the original. Bannerbear will not update the record if the number is different. Editing transcriptions is meant for minor corrections, not making major changes.
• approvedbooleanSet to true to approve the video and start the rendering process.

List all videos

Parameters

• pageintegerquery stringThe page of results you would like to retrieve. The API returns 25 items per page.

Examples

Collections

Sometimes you want to use the same data payload but push to multiple templates at once.

In Bannerbear, you can do this by grouping templates together in a Template Set. Pushing data to a Template Set results in a response that includes multiple images (depending on how many templates were in your set).

This multi-image object is known as a Collection.

The collection object

Attributes

These attributes are populated by Bannerbear. All other attributes of the object are set by the user at the time of creation.

• uidstringThe unique ID for this object.
• statusstringThe current status of the collection; pending, completed or failed.
• selfstringThe permalink to this object.
• image_urlsobjectAn object of final, rendered image urls. This will be null to begin with and populates when the collection has the status completed
• imageslistAn array of the full Image objects in this collection.
• webhook_response_codeintegerThe HTTP response code received by the webhook_url.

Create a collection

Creating a collection on Bannerbear is achieved via this endpoint and behaves the same as creating a single Image except with a different response.

This endpoint responds with 202 Accepted after which your collection will be queued to generate. Collections are usually rendered within a few seconds. When completed, the status changes to completed.

You can poll the GET endpoint for status updates or use a webhook to get the final video posted to you.

This endpoint supports synchronous generation.

Parameters

• template_setstringrequiredThe template set uid that you want to use.
• modificationslistrequiredA list of modifications you want to make. See Create an image for more details on the child parameters.
• webhook_urlstringA url to POST the full Collection object to upon rendering completed.
• metadatastringAny metadata that you need to store e.g. ID of a record in your DB.
• transparentbooleanRender the collection with a transparent background. Default is false.

Retrieve a collection

Parameters

• uidstringrequiredThe collection uid that you want to retrieve.

List all collections

Parameters

• pageintegerquery stringThe page of results you would like to retrieve. The API returns 25 items per page.

Animated Gifs

Animated Gifs on Bannerbear take the form of simple slideshows. You can add multiple frames, control the duration of individual frames, control the number of loops and more.

The animated gif object

Attributes

These attributes are populated by Bannerbear. All other attributes of the object are set by the user at the time of creation.

• uidstringThe unique ID for this object.
• selfstringThe permalink to this object.
• image_urlstringThe final, rendered image url. This will be null to begin with and populates when the image has the status completed
• webhook_response_codeintegerThe HTTP response code received by the webhook_url.

Create an animated gif

This endpoint responds with 202 Accepted after which your animated gif will be queued to generate. Animated gifs are usually rendered within a few seconds. When completed, the status changes to completed.

You can poll the GET endpoint for status updates or use a webhook to get the final animated gif posted to you.

Parameters

• templatestringrequiredThe template uid that you want to use.
• frameslistrequiredA list of modifications lists to apply in sequence. See Create an image for more details on the child parameters. Animated Gifs can have a maximum of 30 frames.
• input_media_urlstringAn optional movie file that can be used as part of the gif. Depending on the number of frames you pass in, Bannerbear will generate thumbnails of this movie and place them sequentially into an image container in your template named video_frame.
• fpsintegerSet the frame rate of gif (default is 1 frame per second).
• frame_durationslistCustom durations for each frame (overrides fps).
• loopbooleanSet the gif to loop or only play once.
• metadatastringAny metadata that you need to store e.g. ID of a record in your DB.
• webhook_urlstringA url to POST the full Animated Gif object to upon rendering completed.

Retrieve an animated gif

Parameters

• uidstringrequiredThe animated gif uid that you want to retrieve.

List all animated gifs

Parameters

• pageintegerquery stringThe page of results you would like to retrieve. The API returns 25 items per page.

Screenshots

The Bannerbear API includes a screenshot tool if you need to capture screenshots of public webpages.

This endpoint supports synchronous generation.

The screenshot object

Attributes

These attributes are populated by Bannerbear. All other attributes of the object are set by the user at the time of creation.

• uidstringThe unique ID for this object.
• statusstringThe current status of the image; pending, completed or failed.
• selfstringThe permalink to this object.
• webhook_response_codeintegerThe HTTP response code received by the webhook_url.

Create a screenshot

This endpoint responds with 202 Accepted after which your screenshot will be queued to generate. Screenshots are usually rendered within a few seconds. When completed, the status changes to completed.

You can poll the GET endpoint for status updates or use a webhook to get the final screenshot posted to you.

Parameters

• urlstringrequiredThe website you want to screenshot.
• widthintegerScreenshot browser width, defaults to 1200 if not set.
• heightintegerScreenshot browser height, defaults to full page if not set.
• mobilebooleanUse mobile user agent. Default is false.
• languagestringSet the browser language using a two-letter ISO 639-1 code. Only languages using Latin, Japanese, Korean, Chinese and Thai alphabets are supported.
• metadatastringAny metadata that you need to store e.g. ID of a record in your DB.
• webhook_urlstringA url to POST the full Screenshot object to upon rendering completed.

Retrieve a screenshot

Parameters

• uidstringrequiredThe screenshot uid that you want to retrieve.

List all screenshots

Parameters

• pageintegerquery stringThe page of results you would like to retrieve. The API returns 25 items per page.

Templates

Templates are the reusable designs that you create in the Bannerbear editor. You can list a project's templates via the API.

You can design a template using the Bannerbear template editor, or you can add one from the template library (and modify it as needed).

Every template has a list of modifications available, for example text boxes that you can populate with different text, or image placeholders that you can replace with different images.

The template object

Attributes

• uidstringThe unique ID for this object.
• namestringThe name of this template.
• selfstringThe permalink to this object.
• preview_urlstringA thumbnail of the latest version of the template.
• available_modificationslistA list of available modifications.
• tagslistAn array of tags for this template.

Create a template

This endpoint allows you create blank templates, which you can then use with the Sessions API to provide your users a blank canvas plus editor environment to design their own templates from scratch.

Parameters

• namestringrequiredThe name of the new blank template.
• widthintegerrequiredThe width of the new blank template.
• heightintegerrequiredThe height of the new blank template.
• metadatastringAny metadata that you need to store e.g. ID of a record in your DB.
• tagslistAn array of tags for this template.

Duplicate a template

You can duplicate templates with this endpoint, which is useful if you are using the Sessions API. Let your users select templates from your custom library, then duplicate the template and create a Session so that they can customize it.

Parameters

• uidstringquery stringThe uid of the template you want to duplicate (must be from the same Project).

Retrieve a template

Parameters

• uidstringrequiredThe template uid that you want to retrieve.
• extendedbooleanquery stringSet to true to return an extended response including current layer defaults.

Update a template

You can edit some basic attributes of a Template via the API.

Parameters

• namestringThe name of the template.
• metadatastringAny metadata that you need to store e.g. ID of a record in your DB.
• tagslistAn array of tags for this template.
• widthintegerThe new width of the template.
• heightintegerThe new height of the template.

List all templates

Parameters

• pageintegerquery stringThe page of results you would like to retrieve. The API returns 25 items per page.
• tagstringquery stringList items only with this tag.
• limitintegerquery stringThe API returns 25 items per page by default but you can request up to 100 using this parameter.
• namestringquery stringList items that partially match this name.
• extendedbooleanquery stringSet to true to return an extended response including current layer defaults.

Import templates

You can import templates to a project from the public library, or any templates that have been shared publicly in your account or other accounts.

The parameters in this request should be Publication IDs. These are the IDs of publicly-available templates either from the library or shared by other users. This request will not work with private template IDs.

This endpoint does not attempt to de-dupe, if you call it twice with the same payload, templates will be imported twice.

If you are looking for a JSON feed of all templates (publications) in the Bannerbear template library, you can find that here.

Parameters

• publicationslistrequiredAn array of Publication IDs to import into this project.

Delete a template

Permanently delete a template from your project. This action cannot be undone.

Parameters

• uidstringrequiredThe template uid that you want to delete.

Template Sets

Templates Sets are sets of Templates that you group together in the Bannerbear dashboard. You can create, modify and list a project's template sets via the API.

The template set object

Attributes

• uidstringThe unique ID for this object.
• namestringThe name of this template set.
• selfstringThe permalink to this object.
• available_modificationslistA list of available modifications.
• templateslistA list of templates inside this set.

Create a template set

Parameters

• namestring A name for this template set.
• templateslist requiredA list of template UIDs to add to this template set.

Update a template set

Parameters

• namestring A name for this template set.
• templateslist requiredAn updated list of template UIDs to include in this template set. When using the PATCH operation the template set will be cleared first and the new list of templates applied. This allows for removing templates and adding templates depending on your array of UIDs.

Retrieve a template set

Parameters

• uidstringrequiredThe template set uid that you want to retrieve.
• extendedbooleanquery stringSet to true to return an extended response including current layer defaults.

List all template sets

Parameters

• pageintegerquery stringThe page of results you would like to retrieve. The API returns 25 items per page.
• extendedbooleanquery stringSet to true to return an extended response including current layer defaults.

Video Templates

Video Templates are a subset of Templates.

Templates for Images hold design / layout information - as would be required to render Images.

Video Templates simply hold some extra instructions, telling Bannerbear what kind of video to render.

These are called Build Packs and there are 3 types:

1. Overlay a video with a static overlay
2. Transcribe a video with auto-transcribed subtitles
3. Multi Overlay a video with a slideshow overlay

The video template object

Attributes

• uidstringThe unique ID for this object.
• namestringThe name of this video template.
• selfstringThe permalink to this object.
• parent_template_uidstringThe template ID of the parent.
• render_typestringThe name of the Build Pack.
• approval_requiredbooleanWhether videos under this template require approval before rendering proceeds. This setting can be changed in the video template Build Pack settings.
• preview_urlstringA thumbnail of the latest version of the template.
• available_modificationslistA list of available modifications.

Create a video template

Parameters

• templatestring requiredThe image template on which to base this video template.
• render_typestring requiredThe Build Pack to use: overlay, transcribe, or multi_overlay
• approval_requiredboolean Whether to require approval before rendering (only applies to the transcribe Build Pack)
• transcription_layer_namestring Text layer for transcriptions (only applies to the transcribe Build Pack)

Retrieve a video template

Parameters

• uidstringrequiredThe video template uid that you want to retrieve.

List all video templates

Parameters

• pageintegerquery stringThe page of results you would like to retrieve. The API returns 25 items per page.

Sessions

Sessions provide your users with access to the Bannerbear template editor. When you create a Session you will receive a session_editor_url which provides secure, expiring access to the Bannerbear template editor for a specific template. This link can be used by your user, even if they are not a Bannerbear member.

Preview Mode

You can create a read-only preview mode with no editor tools using the parameter {preview_mode: true}.

By appending a base64-encoded query string of modifications to the session_editor_url in Preview Mode you can preview template modifications to your users. See embedding the template editor on the knowledge base.

The session object

Attributes

• uidstringThe unique ID for this object.
• selfstringThe permalink to this object.
• session_editor_urlstringThe editor url for this session. Once accessed this can only be accessed by that same user (identified by browser) for 2 hours, after which it expires.
• expiredbooleanWhether this Session has expired. Once expired, the session_editor_url becomes inactive.

Create a session

Parameters

• templatestringrequiredThe template uid you want to create a Session for.
• metadatastringAny metadata that you need to store e.g. ID of a record in your DB.
• modestringStart the session in one of three modes. default allows all template options. limited allows editing of template layers but not deleting or adding new layers. preview is a read-only mode.
• custom_fontslistSpecify a list of custom fonts to show in the Session editor. The default is to show all custom fonts that are available in the account.

Retrieve a session

Parameters

• uidstringrequiredThe session uid that you want to retrieve.

List all sessions

Parameters

• pageintegerquery stringThe page of results you would like to retrieve. The API returns 25 items per page.

Webhooks

Webhooks are used in Bannerbear to notify your system of when assets are generated.

Bannerbear features two methods to set webhooks. The first method is to pass a webhook_url parameter when generating an Image, Collection, Video etc.

The second method is to set Project-level webhooks that will fire for all events of a specific type within your project. You can register these Project-level webhooks via the Project > Advanced Settings page, or via this API endpoint.

The webhook object

Attributes

• uidstringThe unique ID for this object.
• selfstringThe permalink to this object.
• urlstringThe external webhook url.
• eventstringThe event type that this webhook will fire on.

Create a webhook

Parameters

• urlstringrequiredThe external webhook receiver URL you want to register.
• eventstringrequiredThe event type to register this URL to. Options are: template_created, template_edited, image_created, collection_created, video_created, animated_gif_created, movie_created, screenshot_created

Retrieve a webhook

Parameters

• uidstringrequiredThe webhook uid that you want to retrieve.

Delete a webhook

Parameters

• uidstringrequiredThe webhook uid that you want to delete.

Movies

A Movie is a series of Video clips joined together in sequence, using optional transitions, into a single MP4 file. Bannerbear handles the cropping and encoding of files automatically.

An example use case for a Movie is when your business has videos with a consistent intro and outro, and you want to place dynamically-generated Video content from the Bannerbear /videos endpoint between them.

Another use case for a Movie is when you want to join static images together in an MP4 slideshow with transitions.

The movie object

Attributes

These attributes are populated by Bannerbear. All other attributes of the object are set by the user at the time of creation.

• uidstringThe unique ID for this object.
• statusstringThe current status of the movie; pending, rendering, completed or failed.
• selfstringThe permalink to this object.
• percent_renderedintegerThe progress of the movie render from 0 to 100.
• total_length_in_secondsintegerThe final length of the combined movie file.
• movie_urlstringThe final, rendered movie url. This will be null to begin with and populates when the movie has the status completed
• webhook_response_codeintegerThe HTTP response code received by the webhook_url.

Create a movie

You can combine up to 10 video clips into a movie. Video clips should be listed chronologically in the inputs parameter.

Instead of a video clip you can also use a static image url in the asset_url parameter. When using a static image, it will be shown for 5 seconds by default in the final movie. You can change this using the trim_to_length_in_seconds parameter.

Parameters

• widthintegerrequiredThe desired width of your movie. Bannerbear will crop / scale your input clips to fit this width.
• heightintegerrequiredThe desired height of your movie. Bannerbear will crop / scale your input clips to fit this height.
• inputslistrequiredA list of videos (or images) you want to combine into a movie.
  • Child Parameters: Video
  • asset_urlstringURL to a video file. This can be a Bannerbear video or an externally-hosted video. It can also be a static image url.
  • trim_to_length_in_secondsintegerForce trim the end video to a specific time.
  • mutebooleanRemove the sound from this video clip.
  • soundtrack_urlstringURL to an audio file to overlay on top of this clip.
• transitionstringThe name of the transition you want to use between video clips. Current options are: fade, pixelize, slidedown, slideright, slideup, slideleft.
• soundtrack_urlstringURL to an audio file to overlay on top of the movie.
• webhook_urlstringA url to POST the full Movie object to upon rendering completed.
• metadatastringAny metadata that you need to store e.g. ID of a record in your DB.

Retrieve a movie

Parameters

• uidstringrequiredThe movie uid that you want to retrieve.

List all movies

Parameters

• pageintegerquery stringThe page of results you would like to retrieve. The API returns 25 items per page.

Examples

Fonts

Fonts are set at the template level in Bannerbear. When you design a template and create a text box, you choose a font for that text box. So it is not necessary to set fonts when creating images via the API, as the defaults will be used.

However, if you wish you can change fonts in your images on-the-fly when creating an image by adding a font_family parameter and the name of a valid font.

If you use an invalid font name when creating an image, the template default font will be used.

This endpoint simply returns a list of valid fonts.

Effects

Bannerbear has a number of built-in effects that you can apply to image containers at the template level.

However, you can also set these on-the-fly when you make Image API requests using the effect property.

This is useful if you need to make multiple variations from a template, but use different effects in each one.

This endpoint simply returns a list of valid effects.

Diagnoses

Sometimes an image you generate on Bannerbear may not turn out as expected.

The most common problem is with imported images, which is the current focus for this diagnostic tool.

An imported image may be missing at the origin, or blocking Bannerbear access etc. This is usually due to permissions, file formats etc, but it can be tedious to track down the root cause.

This endpoint helps you isolate the problem, given an Image ID.

When you create a Diagnosis, Bannerbear will run through a series of checks on the data in the Image you have requested the diagnosis for. You will then receive a report with issues and suggested fixes.

The subtle difference between the singular Diagnosis and plural Diagnoses is easy to miss. Ensure you use the right spelling when using this endpoint.

The diagnosis object

Attributes

These attributes are populated by Bannerbear. All other attributes of the object are set by the user at the time of creation.

• uidstringThe unique ID for this object.
• typestringThe parent object type
• parent_uidstringThe parent object unique ID
• statusstringThe current status of the diagnosis; pending or completed.
• reportobjectA categorized report of issues with your Image. For now the only category is external_images which lists your image_urls and displays any issues Bannebear had with accessing them.

Create a diagnosis

This endpoint responds with 202 Accepted after which your report will be queued to generate.

When completed, the status changes to completed.

Use the GET endpoint to retrieve the final report.

Parameters

• image_uidstringrequiredThe Image uid that you would like to run a diagnostic on. Currently this endpoint only supports Image uids.

Retrieve a diagnosis

Parameters

• uidstringrequiredThe diagnosis uid that you want to retrieve.

Signed Bases

Bannerbear has a Signed URL feature which allows on-demand generation of images using encrypted URL parameters.

You can create the base URLs via API using this endpoint.

This endpoint only generates the Base URL, also known as a Signed Base. In order to generate images using the Base URL you will need to append encrypted URL parameters as described in the Signed URL documentation.

The signed base object

Attributes

• uidstringThe unique ID for this object.
• base_urlstringThe Base URL for this signed base.
• example_urlstringAn example live signed url using this base with dummy text / images.

Create Signed Base

Parameters

• No parameters