API Data Provider - Online Help

Images

Retrieve and manage generated images from Bannerbear.

Columns

Name Type ReadOnly References Description
Uid [KEY] String True

Unique image generation identifier

CreatedAt Datetime True

Image generation creation timestamp

Status String True

Current status of image generation

The allowed values are pending, completed, failed.

Url String True

API URL for this image resource

ImageUrl String True

URL of the generated image

Template String False

Templates.Uid

Template UID used for image generation

Modifications String False

Array of modifications applied to template

WebhookUrl String False

Webhook URL for completion notifications

WebhookResponseCode Integer True

HTTP response code from webhook call

IsTransparent Boolean False

Whether image has transparent background

Metadata String False

Custom metadata string

IsRenderPdf Boolean False

Whether to render image as PDF

PdfUrl String True

URL of generated PDF if render_pdf is true

Width Integer True

Image width in pixels

Height Integer True

Image height in pixels

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