# Bannerbear Text Overlay

Blocks for generating dynamic images with text overlays using Bannerbear templates.

## Bannerbear Text Overlay

### What it is

Add text overlay to images using Bannerbear templates. Perfect for creating social media graphics, marketing materials, and dynamic image content.

### How it works

This block uses Bannerbear's API to generate images by populating templates with dynamic text and images. Create templates in Bannerbear with text layers, then modify layer content programmatically.

Webhooks can notify you when asynchronous generation completes. Include custom metadata for tracking generated images.

### Inputs

| Input               | Description                                                       | Type                    | Required |
| ------------------- | ----------------------------------------------------------------- | ----------------------- | -------- |
| template\_id        | The unique ID of your Bannerbear template                         | str                     | Yes      |
| project\_id         | Optional: Project ID (required when using Master API Key)         | str                     | No       |
| text\_modifications | List of text layers to modify in the template                     | List\[TextModification] | Yes      |
| image\_url          | Optional: URL of an image to use in the template                  | str                     | No       |
| image\_layer\_name  | Optional: Name of the image layer in the template                 | str                     | No       |
| webhook\_url        | Optional: URL to receive webhook notification when image is ready | str                     | No       |
| metadata            | Optional: Custom metadata to attach to the image                  | str                     | No       |

### Outputs

| Output     | Description                                                | Type |
| ---------- | ---------------------------------------------------------- | ---- |
| error      | Error message if the operation failed                      | str  |
| success    | Whether the image generation was successfully initiated    | bool |
| image\_url | URL of the generated image (if synchronous) or placeholder | str  |
| uid        | Unique identifier for the generated image                  | str  |
| status     | Status of the image generation                             | str  |

### Possible use case

**Social Media Graphics**: Generate personalized social posts with dynamic quotes, stats, or headlines.

**Marketing Banners**: Create ad banners with different product names, prices, or offers.

**Certificates & Cards**: Generate personalized certificates, invitations, or greeting cards.

***


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://agpt.co/docs/integrations/block-integrations/text_overlay.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.