mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-04-30 03:00:41 -04:00
90466908a8
<!-- Clearly explain the need for these changes: -->
we met some reality when merging into the docs site but this fixes it
### Changes 🏗️
updates paths, adds some guides
<!-- Concisely describe all of the changes made in this pull request:
-->
update to match reality
### Checklist 📋
#### For code changes:
- [x] I have clearly listed my changes in the PR description
- [x] I have made a test plan
- [x] I have tested my changes according to the test plan:
<!-- Put your test plan here: -->
- [x] deploy it and validate
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> Aligns block integrations documentation with GitBook.
>
> - Changes generator default output to
`docs/integrations/block-integrations` and writes overview `README.md`
and `SUMMARY.md` at `docs/integrations/`
> - Adds GitBook frontmatter and hint syntax to overview; prefixes block
links with `block-integrations/`
> - Introduces `generate_summary_md` to build GitBook navigation
(including optional `guides/`)
> - Preserves per-block manual sections and adds optional `extras` +
file-level `additional_content`
> - Updates sync checker to validate parent `README.md` and `SUMMARY.md`
> - Rewrites `docs/integrations/README.md` with GitBook frontmatter and
updated links; adds `docs/integrations/SUMMARY.md`
> - Adds new guides: `guides/llm-providers.md`,
`guides/voice-providers.md`
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
fdb7ff8111. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
---------
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com>
Co-authored-by: bobby.gaffin <bobby.gaffin@agpt.co>
50 lines
2.1 KiB
Markdown
50 lines
2.1 KiB
Markdown
# Bannerbear Text Overlay
|
|
<!-- MANUAL: file_description -->
|
|
Blocks for generating dynamic images with text overlays using Bannerbear templates.
|
|
<!-- END MANUAL -->
|
|
|
|
## 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
|
|
<!-- MANUAL: 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.
|
|
<!-- END MANUAL -->
|
|
|
|
### 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
|
|
<!-- MANUAL: 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.
|
|
<!-- END MANUAL -->
|
|
|
|
---
|