media
Bannerbear CLI for Headless Automation
Use the Bannerbear CLI for headless automation with headless JSON commands, schema discovery, credentials, and permission controls.
10 functions 7 read 3 write API key auth
Bannerbear CLI for Headless Automation
Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers.
Use headless automation when another tool needs a stable local command surface. The Bannerbear CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Bannerbear CLI for Headless Automation
kosmokrator integrations:configure bannerbear --set api_key="$BANNERBEAR_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call bannerbear.bannerbear_create_image '{"template_id":"example_template_id","modifications":"example_modifications","width":1,"height":1,"transparent":true,"metadata":"example_metadata"}' --json Discovery Before Execution
Agents and scripts can inspect Bannerbear docs and schemas before choosing a function.
kosmo integrations:docs bannerbear --json
kosmo integrations:docs bannerbear.bannerbear_create_image --json
kosmo integrations:schema bannerbear.bannerbear_create_image --json
kosmo integrations:search "Bannerbear" --json
kosmo integrations:list --json Useful Bannerbear CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
bannerbear.bannerbear_create_image | Write | template_id, modifications, width, height, transparent, metadata | Generate an image from a Bannerbear template. Provide a template ID and an array of modifications to customize text, images, colors, and other layers. The image is generated asynchronously — use get_image to check status and retrieve the final URL. |
bannerbear.bannerbear_get_image | Read | image_id | Retrieve the status and download URL of a previously created Bannerbear image. Images are generated asynchronously, so poll this endpoint until status is "completed". |
bannerbear.bannerbear_list_images | Read | page, limit | List previously created Bannerbear images. Returns image UIDs, statuses, and download URLs. Supports pagination via page and limit parameters. |
bannerbear.bannerbear_list_collections | Read | page, limit | List Bannerbear collections. Collections are groups of images generated from a single template with different data. Supports pagination via page and limit parameters. |
bannerbear.bannerbear_create_video | Write | template_id, modifications, fps, trim, metadata | Generate a video from a Bannerbear template. Provide a template ID and an array of modifications per scene. The video is generated asynchronously — use get_video to check status and retrieve the final URL. |
bannerbear.bannerbear_get_video | Read | video_id | Retrieve the status and download URL of a previously created Bannerbear video. Videos are generated asynchronously, so poll this endpoint until status is "completed". |
bannerbear.bannerbear_list_templates | Read | none | List all available Bannerbear templates. Returns template UIDs, names, dimensions, and preview URLs. Use a template UID with create_image or create_video. |
bannerbear.bannerbear_get_template | Read | template_id | Get details for a specific Bannerbear template, including all available modification layers (text, image, color, etc.). Use this to discover which layer names to use when calling create_image or create_video. |
bannerbear.bannerbear_create_animated_gif | Write | template_id, modifications, fps, metadata | Generate an animated GIF from a Bannerbear template. Provide a template ID and an array of modifications per frame. The GIF is generated asynchronously — use get_image with the returned ID to check status. |
bannerbear.bannerbear_get_current_user | Read | none | Get the authenticated Bannerbear account details, including plan info and usage. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.