API Data Provider - Online Help

Connecting to Bannerbear

Bannerbear uses API Keys to control access to the API. The API supports different key types with varying levels of access.

Using API Key Authentication

You can obtain your API keys from the Bannerbear dashboard. Different key types are available depending on your access requirements.

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Bannerbear API key.
  • KeyType: Set this to specify your API key type (required).
  • ProjectId: Required when KeyType is set to Master for accessing project-specific endpoints.

Key Type Configuration

The KeyType property determines the scope and access level of your API key:

  • Project: Provide access to endpoints within a specific project
  • Master: Provide account-wide access to all projects and endpoints

When using a Master key type, you must specify the ProjectId to access project-specific endpoints. The ProjectId parameter allows Master keys to operate on specific projects while maintaining their elevated access privileges.

Example connection strings:

Standard API Key Configuration: 

Profile=C:\profiles\Bannerbear.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;KeyType=Project';

Master Key Configuration with ProjectId: 

Profile=C:\profiles\Bannerbear.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_master_api_key;KeyType=Master;ProjectId=your_project_id';

Available Tables

The Bannerbear API Profile provides access to the following tables:

  • AnimatedGifs: Animated GIF generation operations created from Bannerbear templates with configurable frames, frame rate, and loop settings.
  • Collections: Collections of images generated from a template set, supporting batch modification and transparent background options.
  • Diagnoses: Diagnosis results for image resources, including external image analysis and rendering issue reports.
  • Images: Generated images from Bannerbear templates with support for modifications, transparency, and PDF rendering.
  • Movies: Movie generation operations that combine video inputs with transitions, soundtracks, and overlay settings.
  • PdfJoin: PDF join operations that merge multiple input PDFs into a single output file.
  • PdfRasterize: PDF rasterization operations that convert PDF pages to PNG or JPG images at a configurable DPI.
  • Projects: Bannerbear projects with configuration settings for image proxy and web sessions.
  • Screenshots: Website screenshots captured at configurable browser dimensions with optional mobile user-agent support.
  • Sessions: Web editor sessions for a specific template, providing an interactive session editor URL.
  • SignedBases: Signed base URLs for a specific template, used to generate securely signed image requests.
  • TemplateSets: Sets of templates grouped together for batch image generation through the Collections endpoint.
  • Templates: Bannerbear image templates with modification definitions, tags, versioning, and dimension settings.
  • VideoTemplates: Video templates with overlay, transcription, and multi-overlay rendering capabilities.
  • Videos: Generated videos from video templates with trimming, zoom, blur, transcription, and GIF preview options.

Usage Examples

AnimatedGifs: 

SELECT * FROM AnimatedGifs

INSERT INTO AnimatedGifs (Template, Frames, InputMediaUrl, Fps, FrameDurations, IsLoop, WebhookUrl, Metadata) VALUES ('template-uuid', '[{"name":"layer1","text":"Hello World"}]', 'https://example.com/input.mp4', 12.0, '[200,200,200]', true, 'https://example.com/webhook', 'campaign-spring-2025')

Collections: 

SELECT * FROM Collections

INSERT INTO Collections (TemplateSet, Modifications, WebhookUrl, Metadata, IsTransparent) VALUES ('templateset-uuid', '[{"name":"title","text":"Hello World"}]', 'https://example.com/webhook', 'batch-run-001', false)

Diagnoses: 

SELECT * FROM Diagnoses WHERE Uid = 'diag-uuid'

INSERT INTO Diagnoses (ParentUid) VALUES ('image-uuid')

Images: 

SELECT * FROM Images

INSERT INTO Images (Template, Modifications, WebhookUrl, IsTransparent, IsRenderPdf, Metadata) VALUES ('template-uuid', '[{"name":"title","text":"Hello World"},{"name":"subtitle","text":"Welcome"}]', 'https://example.com/webhook', false, false, 'promo-banner-001')

Movies: 

SELECT * FROM Movies

INSERT INTO Movies (Width, Height, Inputs, Transition, SoundtrackUrl, WebhookUrl, Metadata) VALUES (1920, 1080, '[{"asset_url":"https://example.com/clip1.mp4"},{"asset_url":"https://example.com/clip2.mp4"}]', 'fade', 'https://example.com/audio.mp3', 'https://example.com/webhook', 'promo-video-001')

PdfJoin: 

SELECT * FROM PdfJoin WHERE Uid = 'pjoin-uuid'

INSERT INTO PdfJoin (PdfInputs) VALUES ('["https://example.com/doc1.pdf","https://example.com/doc2.pdf"]')

PdfRasterize: 

SELECT * FROM PdfRasterize WHERE Uid = 'prast-uuid'

INSERT INTO PdfRasterize (PdfUrl, Dpi, WebhookUrl) VALUES ('https://example.com/document.pdf', 150, 'https://example.com/webhook')

Projects: 

SELECT * FROM Projects

INSERT INTO Projects (Name, ImageProxyEnabled, WebSessionsEnabled) VALUES ('My Marketing Project', true, false)

Screenshots: 

SELECT * FROM Screenshots

INSERT INTO Screenshots (SourceUrl, Width, Height, IsMobile, Language, Metadata, WebhookUrl) VALUES ('https://example.com', 1280, 720, false, 'en', 'homepage-screenshot', 'https://example.com/webhook')

Sessions: 

SELECT * FROM Sessions

INSERT INTO Sessions (Template, Metadata) VALUES ('template-uuid', 'design-session-001')

SignedBases: 

SELECT * FROM SignedBases WHERE TemplateUid = 'template-uuid'

INSERT INTO SignedBases (TemplateUid) VALUES ('template-uuid')

TemplateSets: 

SELECT * FROM TemplateSets

INSERT INTO TemplateSets (Templates, Name) VALUES ('["template-uuid-1","template-uuid-2"]', 'Social Media Pack')

UPDATE TemplateSets SET Name = 'Updated Social Pack', Templates = '["template-uuid-1","template-uuid-3"]' WHERE Uid = 'templateset-uuid'

Templates: 

SELECT * FROM Templates

INSERT INTO Templates (Name, Width, Height, Tags, Metadata) VALUES ('Summer Campaign Banner', 1200, 628, '["social","promo"]', '{"campaign":"summer-2025"}')

UPDATE Templates SET Name = 'Updated Banner', Tags = '["social","updated"]', Width = 1200, Height = 628, Metadata = '{"campaign":"summer-2025"}' WHERE Uid = 'template-uuid'

DELETE FROM Templates WHERE Uid = 'template-uuid'

VideoTemplates: 

SELECT * FROM VideoTemplates

INSERT INTO VideoTemplates (ParentTemplateUid, RenderType, ApprovalRequired, TranscriptionLayerName) VALUES ('template-uuid', 'overlay', false, 'subtitles')

Videos: 

SELECT * FROM Videos

INSERT INTO Videos (VideoTemplate, InputMediaUrl, Modifications, ZoomSettings, ZoomFactor, BlurSettings, TrimStartTime, TrimEndTime, TrimToLengthInSeconds, WebhookUrl, Metadata, Frames, FrameDurations, CreateGifPreview) VALUES ('videotemplate-uuid', 'https://example.com/input.mp4', '[{"name":"title","text":"Hello World"}]', '{"type":"in"}', 1.2, '{"strength":5}', 0.0, 30.0, 30.0, 'https://example.com/webhook', 'promo-video-001', '[{"image_url":"https://example.com/frame1.png"}]', '[2.0,3.0]', false)

UPDATE Videos SET ApprovalRequired = true, Transcription = '[{"text":"Hello World","start":0.0,"end":2.5}]' WHERE Uid = 'video-uuid'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property Description
APIKey The API Key used to authenticate to Bannerbear.
AuthScheme The scheme used for authentication. Accepted entries are APIKey or None.
Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD
KeyType The type of API key being used for authentication. Accepted entries are Project or Master.
Allowed values are: PROJECT, MASTER
ProjectId The project identifier required when using a Master API key for non-Projects endpoints.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0