@thenavidm/bannerbear-mcp-cli

v3.0.1

Published

a month ago

Bannerbear V5 MCP and shared CLI with private workspace profiles, confirmed renders and exclusive signing-key delivery.

Bannerbear MCP Server & CLI

Bannerbear V5 MCP server and CLI for Codex and AI agents. 75 shared tools for templates, images, animations, media jobs, workflows, assets, publications, webhooks and Instant URLs, with explicit mutation approval and isolated private workspace profiles.

One package gives you a task CLI, local stdio MCP and versioned desktop bundle. Built and maintained by Navid Moazzez. Built on Slipway, which turns one definition of each tool into the MCP server and the CLI. Complete setup: navid.me.

The terminal is an illustration of shipped command names and review/confirmation. It is not a recorded paid render. The official MCP already exists and is compared fairly below. Provider outcomes and the desktop GUI remain unverified; section 7 has the measured token costs.

Two ways to use it

Command line

bannerbear-cli tools
bannerbear-cli get-account --agent
bannerbear-cli get-image-template --uid YOUR_TEMPLATE_UID --agent
bannerbear-cli preview-render-batch --payload-file /absolute/private/approved-batch.json --agent
bannerbear-cli create-image --payload-file /absolute/private/approved-image.json --confirm --agent

MCP server, for your AI app

codex mcp add bannerbear --env BANNERBEAR_TOKEN_FILE=/absolute/private/bannerbear.txt -- npx -y @thenavidm/bannerbear-mcp-cli@latest

Which one

| Where you work | Route | | --- | --- | | Codex/Cursor/agents with a shell | CLI, local MCP or both | | Claude Desktop | Bundled custom extension or local stdio | | Scripts / cron / CI | Same task CLI and shared policies | | Remote-only chat client | Official hosted Bannerbear OAuth MCP |

Features

| Capability | CLI command | MCP tool | | --- | --- | --- | | Templates / layers | get-image-template / get-layer-schema | get_image_template / get_layer_schema | | Explicit render / batch | create-image / create-batch | create_image / create_batch | | Exact batch review | preview-render-batch / apply-render-batch | preview_render_batch / apply_render_batch | | Workflows / media | get-workflow / run-workflow / poll-job | get_workflow / run_workflow / poll_job | | Confirmed local upload | upload-asset | upload_asset | | Private creation keys | create-webhook / create-instant-url | create_webhook / create_instant_url | | Schema / profiles | get-operation-schema / list-accounts | get_operation_schema / list_accounts |

| Number | Section | What it covers | | --- | --- | --- | | 1 | What you can ask it | What you can ask it | | 2 | Quick install | Quick install | | 3 | Set up Bannerbear access | Set up Bannerbear access | | 4 | Connect your client | Connect your client | | 5 | Check it works | Check it works | | 6 | Output, flags and exit codes | Output, flags and exit codes | | 7 | MCP or CLI and token cost | Measured in Claude Code and Codex, and how to spend less | | 8 | Every tool and argument | Every tool and argument | | 9 | Image, animation and workflow tasks | Image, animation and workflow tasks | | 10 | Jobs, batches and local files | Jobs, batches and local files | | 11 | Several private workspaces | Several private workspaces | | 12 | Writing safely | Writing safely | | 13 | How the two surfaces work | How the two surfaces work | | 14 | Your data | Your data | | 15 | Environment variables | Environment variables | | 16 | Updates and removal | Updates and removal | | 17 | Troubleshooting | Troubleshooting | | 18 | API coverage and comparisons | API coverage and comparisons | | 19 | Versions and migration | Versions and migration | | 20 | FAQ | FAQ |

1. What you can ask it

Find the intended image template and inspect every layer before changing text.
Preview the exact image body and approve one render.
Review an ordered image batch, then submit only the same profile and body.
Read workflow inputs and trigger only the requested run after approval.
Resume an existing image, animation, batch, media job or workflow run without submitting again.
Upload the chosen local asset only after approval.
Create a webhook/instant URL and save its one-time signing key privately.

Actual stdio discovery provides 75 shared tools: 33 reads/helpers and 42 confirmed mutations. Sixty-seven native operations derive from a pinned V5 OpenAPI snapshot; eight helpers add local profiles/schema/layers/preview, bounded pages/job polling and exact image-batch review/apply. This is a V5 refresh, not a V2 request-body rename.

2. Quick install

npm install -g @thenavidm/bannerbear-mcp-cli@latest
bannerbear-cli --version
bannerbear-cli tools
bannerbear-cli schema create-image
bannerbear-cli login

Node 22+ is required for manual installs. Discovery and local previews work without keys. Provider calls need a private V5 key; see INSTALL.md for every client/OS and desktop setup. Use the versioned source and desktop release linked below.

3. Set up Bannerbear access

Private V5 workspace keys

Sign in to the intended Bannerbear workspace and open V5 API Keys. Create a key restricted to the resource/action scopes needed for your task.
Store the secret outside all repositories. Set BANNERBEAR_TOKEN_FILE to an absolute owner-only token-only file, or configure BANNERBEAR_API_KEY privately. A V2 key cannot authenticate V5.
Run bannerbear-cli doctor for local presence/settings, then deliberately run doctor --network to read GET /v5/account. This prints current scope/quota metadata and proves only that account read, not every operation.
Read the actual template/workflow, inspect its layers/inputs and save the exact requested native body privately. Preview it locally and approve only the intended render or change.

A key belongs to a workspace. It is not scoped to an individual template; separate workspaces are the provider isolation route when an integration must reach only a subset. Provider template/workflow ownership and api_write_access locks still apply. READ_ONLY is an additional local control, not a replacement for restricted provider scopes.

The 22 current scopes pair :read and :write for images, image_templates, animations, animation_templates, tools, workflows, batches, webhooks, instant_urls, publications and assets. An empty returned scopes array means full access. allowed_origins restricts browser-origin use; it does not make a local CLI key template-scoped. Request only the necessary grants. This wrapper does not create/roll keys, implement OAuth/refresh, load .env automatically or reuse official saved sessions. login prints instructions only.

On macOS/Linux, use an existing 0700 directory and a regular 0600 token file owned by your user. It must be absolute, non-symlink and at most 64 KiB. File credentials override environment keys and are cached until restart. On Windows, restrict the file/directory ACL to your user; POSIX mode checks do not validate Windows ACLs. GUI apps can have different environments from your shell.

Plans, credits and limits

The AGPL wrapper is free; Bannerbear subscriptions, render/AI credits, storage and workspace permissions remain separate. The provider currently advertises a 30-credit trial without a credit card. Check the current dashboard and pricing before approval; do not infer that every model or operation has the same cost. A workflow charges for its individual steps; a batch reduces request count, not render credits.

The current V5 reference states 60 POST requests per ten-second window. Official 0.13.0 source still uses a conservative 28-POST window and older 30-request wording. This package's default 200 ms spacing is per profile/process across calls, not a reservation or globally coordinated quota. Other clients using the key share provider limits. No request retries automatically after 429, 5xx, network failures or timeouts.

Native image batches are 1–100 items. This package limits JSON bodies/files to 1 MiB, raw uploads to 5,000,000 bytes and each response to 5 MiB; these are separate caps. Source describes a 20-asset trial allowance and content-hash deduplication within a workspace; check returned provider policy. Supported upload Content-Types come from the pinned V5 schema, including image/video/audio/PDF/JSON types. The provider validates actual media and MIME compatibility.

Rotation and revocation

Create/rotate/revoke the intended V5 key in Bannerbear, update private settings and restart clients. Uninstalling npm does not revoke a key or undo a queued render. Keep account records, render metadata, media URLs, signing keys and private output files out of public issues.

4. Connect your client

Codex is the primary documented agent. Use private file paths rather than placing keys in shell history:

codex mcp add bannerbear --env BANNERBEAR_TOKEN_FILE=/absolute/private/bannerbear.txt -- npx -y @thenavidm/bannerbear-mcp-cli@latest
codex mcp list

INSTALL.md includes private env_vars TOML, separate Windows paths, Claude Desktop bundled/manual setup, Claude Code, Cursor, VS Code/Copilot, Windsurf, Zed, Gemini CLI, Cline/other stdio clients and Docker. GUI environment forwarding and an actual installed desktop extension are different from protocol discovery. A remote-only chat client can use official hosted OAuth; this package exposes no public HTTP listener.

5. Check it works

bannerbear-cli doctor
bannerbear-cli doctor --network
bannerbear-cli list-accounts --agent
bannerbear-cli get-account --agent --select quota,api_key.scopes
bannerbear-cli list-image-templates --page 1 --agent

Local doctor checks settings/presence. Network doctor checks the selected V5 account response. Then inspect the exact template/workflow you intend to use. Do not render/upload/delete merely to test installation. Full discovery returns 75; read-only returns 33 and direct confirmed mutation calls still refuse.

6. Output, flags and exit codes

MCP uses underscore names; CLI uses hyphens from the same catalogue. Path/query flags are top-level; native JSON bodies use --payload or --payload-file exclusively. Output retains provider shapes: list endpoints return arrays, creates return queued objects and helper wrappers report their explicit bounds.

| Flag / command | Contract | | --- | --- | | tools / no command | Actual current commands, writes marked | | COMMAND --help / schema COMMAND | Derived flags / complete JSON Schema | | --agent | Compact JSON and no prompts; never confirms a write | | --select a,b.c | Local selection only; does not change upstream quota or fields | | --account NAME | Exact private workspace profile label | | --confirm | Exact selected mutation approval | | --payload / --payload-file | Native V5 body / regular local JSON file | | --asset-file / --content-type | Confirmed raw bytes and declared provider MIME type | | --secret-result-file | Exclusive private result for creation signing keys |

| Exit | Meaning | | --- | --- | | 0 | Success | | 1 | Unexpected error | | 2 | Invalid input or refused mutation, an unknown command or a hidden write | | 3 | Not found | | 4 | Authentication/permission failure | | 5 | Provider/transport failure | | 7 | Rate limit or exhausted credit quota | | 10 | Missing/invalid private configuration |

A queued UID is not a completed render. A failed media result is retained for inspection. No formatting or --yes flag changes the write guard.

7. MCP or CLI and token cost

Both surfaces are the same program with the same 75 tools. The difference is when the model pays for them. Measured in Claude Code:

| Cost | MCP server | CLI | |---|---|---| | Every message, with every tool loaded | 216,300 tokens | nothing | | Every message, Claude Code's default | 1,150 tokens | nothing | | When Bannerbear comes up | nothing more, or the tools it picks | 3,300 tokens for SKILL.md, once |

Claude Code's tool search is on by default: it sends only the tool names and the server instructions, and loads a tool's full definition when the model reaches for it. An app that loads every tool up front pays the first line on every message, and most of it is Bannerbear's native body schemas: the template and animation tools carry about 62 KB each.

To spend less, BANNERBEAR_READ_ONLY=1 leaves the 33 reads and helpers, a tool list of about 11,300 tokens instead of 147,800 (o200k). --select keeps only the fields you name from a result. Or install the CLI and add the server on the days it earns its place.

Measured on 2026-10-05 with Claude Code 2.1.286 on Claude Opus 5.5: one short prompt with and without the server connected, once with ENABLE_TOOL_SEARCH=false and once with the default, the difference read from the API's own usage figures. SKILL.md was measured the same way. Other apps and models count tokens a little differently.

Against 2.0.1, measured the same day: every tool loaded costs 216,285 tokens instead of 216,552, tool search the same (1,147), and SKILL.md 56 more, because it now says how approval works over MCP and lists every exit code. In Codex 0.159.3 on gpt-6.1-sol, the same task, "find the command that renders one image from a template, and the flags it requires", read a median of 107,521 input tokens on 3.0.0 against 151,819 on 2.0.1 over the CLI, five runs each: three 2.0.1 runs also ran schema without a command or repeated the help, and every extra step carries the whole conversation forward, including the 12,000-token schema create-image prints. which did not name create-image for those words, because Bannerbear's operation descriptions name the endpoint, POST /v5/images, rather than the task, so every 3.0.0 run also read the command list. Over MCP, Codex prints the tool list with a script: 23,325 tokens on 3.0.0 against 23,495. Its input totals depend on whether it then looks at create_image a second time: a median of 48,562 against 48,570 in runs that answered from the list, and 77,724 against 77,956 in runs that looked twice.

8. Every tool and argument

All 75 sections below come from actual stdio discovery. Payload validation also applies when a body is loaded from a file. Mandatory confirmation is enforced outside the ordinary required-key list. Native nested shapes, allowed values, references and local limits follow the tool tables.

| MCP tool | CLI command | Policy | | --- | --- | --- | | get_account | bannerbear-cli get-account | Read / local helper | | list_image_templates | bannerbear-cli list-image-templates | Read / local helper | | create_image_template | bannerbear-cli create-image-template | Explicit confirmation required | | get_image_template | bannerbear-cli get-image-template | Read / local helper | | update_image_template | bannerbear-cli update-image-template | Explicit confirmation required | | delete_image_template | bannerbear-cli delete-image-template | Explicit confirmation required | | list_images | bannerbear-cli list-images | Read / local helper | | create_image | bannerbear-cli create-image | Explicit confirmation required | | get_image | bannerbear-cli get-image | Read / local helper | | list_batches | bannerbear-cli list-batches | Read / local helper | | create_batch | bannerbear-cli create-batch | Explicit confirmation required | | get_batch | bannerbear-cli get-batch | Read / local helper | | list_webhooks | bannerbear-cli list-webhooks | Read / local helper | | create_webhook | bannerbear-cli create-webhook | Explicit confirmation required | | get_webhook | bannerbear-cli get-webhook | Read / local helper | | update_webhook | bannerbear-cli update-webhook | Explicit confirmation required | | delete_webhook | bannerbear-cli delete-webhook | Explicit confirmation required | | list_assets | bannerbear-cli list-assets | Read / local helper | | upload_asset | bannerbear-cli upload-asset | Explicit confirmation required | | get_asset | bannerbear-cli get-asset | Read / local helper | | check_assets | bannerbear-cli check-assets | Read / local helper | | list_publications | bannerbear-cli list-publications | Read / local helper | | get_publication | bannerbear-cli get-publication | Read / local helper | | install_publication | bannerbear-cli install-publication | Explicit confirmation required | | list_instant_urls | bannerbear-cli list-instant-urls | Read / local helper | | create_instant_url | bannerbear-cli create-instant-url | Explicit confirmation required | | get_instant_url | bannerbear-cli get-instant-url | Read / local helper | | update_instant_url | bannerbear-cli update-instant-url | Explicit confirmation required | | delete_instant_url | bannerbear-cli delete-instant-url | Explicit confirmation required | | list_animations | bannerbear-cli list-animations | Read / local helper | | create_animation | bannerbear-cli create-animation | Explicit confirmation required | | get_animation | bannerbear-cli get-animation | Read / local helper | | list_animation_templates | bannerbear-cli list-animation-templates | Read / local helper | | create_animation_template | bannerbear-cli create-animation-template | Explicit confirmation required | | get_animation_template | bannerbear-cli get-animation-template | Read / local helper | | update_animation_template | bannerbear-cli update-animation-template | Explicit confirmation required | | delete_animation_template | bannerbear-cli delete-animation-template | Explicit confirmation required | | animate_template | bannerbear-cli animate-template | Explicit confirmation required | | remove_bg | bannerbear-cli remove-bg | Explicit confirmation required | | generate_ai_image | bannerbear-cli generate-ai-image | Explicit confirmation required | | generate_ai_video | bannerbear-cli generate-ai-video | Explicit confirmation required | | video_thumbnails | bannerbear-cli video-thumbnails | Explicit confirmation required | | subtitle_video | bannerbear-cli subtitle-video | Explicit confirmation required | | generate_voiceover | bannerbear-cli generate-voiceover | Explicit confirmation required | | create_pdf | bannerbear-cli create-pdf | Explicit confirmation required | | trim_video | bannerbear-cli trim-video | Explicit confirmation required | | concat_videos | bannerbear-cli concat-videos | Explicit confirmation required | | resize_video | bannerbear-cli resize-video | Explicit confirmation required | | crop_video | bannerbear-cli crop-video | Explicit confirmation required | | overlay_video | bannerbear-cli overlay-video | Explicit confirmation required | | overlay_image | bannerbear-cli overlay-image | Explicit confirmation required | | add_audio | bannerbear-cli add-audio | Explicit confirmation required | | add_cover_art | bannerbear-cli add-cover-art | Explicit confirmation required | | create_video_slideshow | bannerbear-cli create-video-slideshow | Explicit confirmation required | | apply_color_filter | bannerbear-cli apply-color-filter | Explicit confirmation required | | soften_video | bannerbear-cli soften-video | Explicit confirmation required | | create_gif_preview | bannerbear-cli create-gif-preview | Explicit confirmation required | | list_tool_jobs | bannerbear-cli list-tool-jobs | Read / local helper | | get_tool_job | bannerbear-cli get-tool-job | Read / local helper | | list_workflows | bannerbear-cli list-workflows | Read / local helper | | create_workflow | bannerbear-cli create-workflow | Explicit confirmation required | | update_workflow | bannerbear-cli update-workflow | Explicit confirmation required | | delete_workflow | bannerbear-cli delete-workflow | Explicit confirmation required | | get_workflow | bannerbear-cli get-workflow | Read / local helper | | list_workflow_runs | bannerbear-cli list-workflow-runs | Read / local helper | | run_workflow | bannerbear-cli run-workflow | Explicit confirmation required | | get_workflow_run | bannerbear-cli get-workflow-run | Read / local helper | | list_accounts | bannerbear-cli list-accounts | Read / local helper | | get_operation_schema | bannerbear-cli get-operation-schema | Read / local helper | | get_layer_schema | bannerbear-cli get-layer-schema | Read / local helper | | preview_operation | bannerbear-cli preview-operation | Read / local helper | | query_pages | bannerbear-cli query-pages | Read / local helper | | poll_job | bannerbear-cli poll-job | Read / local helper | | preview_render_batch | bannerbear-cli preview-render-batch | Read / local helper | | apply_render_batch | bannerbear-cli apply-render-batch | Explicit confirmation required |

get_account

bannerbear-cli get-account

GET /v5/account. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

| Argument | Required | Type | Details | | --- | --- | --- | --- | | account | No; body and guard rules apply | string | Exact private workspace profile label; no fallback to another profile key. |

Native operation: GET /v5/account. No JSON request body.

list_image_templates

bannerbear-cli list-image-templates

GET /v5/image_templates. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

| Argument | Required | Type | Details | | --- | --- | --- | --- | | page | No; body and guard rules apply | integer | See the full input schema. minimum: 1. maximum: 1000000. | | account | No; body and guard rules apply | string | Exact private workspace profile label; no fallback to another profile key. |

Native operation: GET /v5/image_templates. No JSON request body.

create_image_template

bannerbear-cli create-image-template

POST /v5/image_templates. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

| Argument | Required | Type | Details | | --- | --- | --- | --- | | account | No; body and guard rules apply | string | Exact private workspace profile label; no fallback to another profile key. | | confirm | No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. | | payload | No; body and guard rules apply | object | Complete current native JSON body. Use payload or payload_file exclusively. | | payload_file | No; body and guard rules apply | string | Regular non-symlink local JSON file, at most 1 MiB. minLength: 1. |

Native operation: POST /v5/image_templates. Native JSON body is required via payload/payload_file.

get_image_template

bannerbear-cli get-image-template

GET /v5/image_templates/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/image_templates/{uid}. No JSON request body.

update_image_template

bannerbear-cli update-image-template

PATCH /v5/image_templates/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

| Argument | Required | Type | Details | | --- | --- | --- | --- | | uid | Yes | string | See the full input schema. minLength: 1. maxLength: 128. pattern: ^[A-Za-z0-9_-]+$. | | account | No; body and guard rules apply | string | Exact private workspace profile label; no fallback to another profile key. | | confirm | No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. | | payload | No; body and guard rules apply | object | Complete current native JSON body. Use payload or payload_file exclusively. | | payload_file | No; body and guard rules apply | string | Regular non-symlink local JSON file, at most 1 MiB. minLength: 1. |

Native operation: PATCH /v5/image_templates/{uid}. Native JSON body is required via payload/payload_file.

delete_image_template

bannerbear-cli delete-image-template

DELETE /v5/image_templates/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: DELETE /v5/image_templates/{uid}. No JSON request body.

list_images

bannerbear-cli list-images

GET /v5/images. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/images. No JSON request body.

create_image

bannerbear-cli create-image

POST /v5/images. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

| Argument | Required | Type | Details | | --- | --- | --- | --- | | account | No; body and guard rules apply | string | Exact private workspace profile label; no fallback to another profile key. | | confirm | No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. | | payload | No; body and guard rules apply | ImageCreateRequest | Complete current native JSON body. Use payload or payload_file exclusively. | | payload_file | No; body and guard rules apply | string | Regular non-symlink local JSON file, at most 1 MiB. minLength: 1. |

Native operation: POST /v5/images. Native JSON body is required via payload/payload_file.

get_image

bannerbear-cli get-image

GET /v5/images/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/images/{uid}. No JSON request body.

list_batches

bannerbear-cli list-batches

GET /v5/batches. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/batches. No JSON request body.

create_batch

bannerbear-cli create-batch

POST /v5/batches. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/batches. Native JSON body is required via payload/payload_file.

get_batch

bannerbear-cli get-batch

GET /v5/batches/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/batches/{uid}. No JSON request body.

list_webhooks

bannerbear-cli list-webhooks

GET /v5/webhooks. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/webhooks. No JSON request body.

create_webhook

bannerbear-cli create-webhook

POST /v5/webhooks. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/webhooks. Native JSON body is required via payload/payload_file.

get_webhook

bannerbear-cli get-webhook

GET /v5/webhooks/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/webhooks/{uid}. No JSON request body.

update_webhook

bannerbear-cli update-webhook

PATCH /v5/webhooks/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: PATCH /v5/webhooks/{uid}. Native JSON body is required via payload/payload_file.

delete_webhook

bannerbear-cli delete-webhook

DELETE /v5/webhooks/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: DELETE /v5/webhooks/{uid}. No JSON request body.

list_assets

bannerbear-cli list-assets

GET /v5/assets. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/assets. No JSON request body.

upload_asset

bannerbear-cli upload-asset

POST /v5/assets. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

| Argument | Required | Type | Details | | --- | --- | --- | --- | | account | No; body and guard rules apply | string | Exact private workspace profile label; no fallback to another profile key. | | confirm | No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. | | asset_file | Yes | string | Regular non-symlink local file, at most 5,000,000 bytes. Uploaded only after confirmation. minLength: 1. | | content_type | Yes | string | Exact documented Content-Type for these raw file bytes. Values: image/jpeg, image/png, image/webp, image/gif, image/svg+xml, video/mp4, video/webm, video/quicktime, audio/mpeg, audio/wav, audio/mp4, audio/webm, audio/ogg, application/pdf, application/json. |

Native operation: POST /v5/assets. Raw local bytes required.

get_asset

bannerbear-cli get-asset

GET /v5/assets/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/assets/{uid}. No JSON request body.

check_assets

bannerbear-cli check-assets

POST /v5/assets/check. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

| Argument | Required | Type | Details | | --- | --- | --- | --- | | account | No; body and guard rules apply | string | Exact private workspace profile label; no fallback to another profile key. | | payload | No; body and guard rules apply | object | Complete current native JSON body. Use payload or payload_file exclusively. | | payload_file | No; body and guard rules apply | string | Regular non-symlink local JSON file, at most 1 MiB. minLength: 1. |

Native operation: POST /v5/assets/check. Native JSON body is required via payload/payload_file.

list_publications

bannerbear-cli list-publications

GET /v5/publications. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

| Argument | Required | Type | Details | | --- | --- | --- | --- | | page | No; body and guard rules apply | integer | See the full input schema. minimum: 1. maximum: 1000000. | | kind | No; body and guard rules apply | string | See the full input schema. Values: image, animation, workflow. | | category | No; body and guard rules apply | string | See the full input schema. Values: announcements & news, beauty & fashion, business & finance, education & coaching, employee highlights, events & weddings, film & movies, food & drinks, gaming & e-sports, home & real estate, marketing & sales, motivational quotes, podcasts & publishing, product showcase, reviews & testimonials, social media, tech & crypto, travel & nature. | | q | No; body and guard rules apply | string | See the full input schema. | | account | No; body and guard rules apply | string | Exact private workspace profile label; no fallback to another profile key. |

Native operation: GET /v5/publications. No JSON request body.

get_publication

bannerbear-cli get-publication

GET /v5/publications/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/publications/{uid}. No JSON request body.

install_publication

bannerbear-cli install-publication

POST /v5/publications/{uid}/install. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/publications/{uid}/install. No JSON request body.

list_instant_urls

bannerbear-cli list-instant-urls

GET /v5/instant_urls. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/instant_urls. No JSON request body.

create_instant_url

bannerbear-cli create-instant-url

POST /v5/instant_urls. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/instant_urls. Native JSON body is required via payload/payload_file.

get_instant_url

bannerbear-cli get-instant-url

GET /v5/instant_urls/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/instant_urls/{uid}. No JSON request body.

update_instant_url

bannerbear-cli update-instant-url

PATCH /v5/instant_urls/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: PATCH /v5/instant_urls/{uid}. Native JSON body is required via payload/payload_file.

delete_instant_url

bannerbear-cli delete-instant-url

DELETE /v5/instant_urls/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: DELETE /v5/instant_urls/{uid}. No JSON request body.

list_animations

bannerbear-cli list-animations

GET /v5/animations. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/animations. No JSON request body.

create_animation

bannerbear-cli create-animation

POST /v5/animations. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/animations. Native JSON body is required via payload/payload_file.

get_animation

bannerbear-cli get-animation

GET /v5/animations/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/animations/{uid}. No JSON request body.

list_animation_templates

bannerbear-cli list-animation-templates

GET /v5/animation_templates. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/animation_templates. No JSON request body.

create_animation_template

bannerbear-cli create-animation-template

POST /v5/animation_templates. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/animation_templates. Native JSON body is required via payload/payload_file.

get_animation_template

bannerbear-cli get-animation-template

GET /v5/animation_templates/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Native operation: GET /v5/animation_templates/{uid}. No JSON request body.

update_animation_template

bannerbear-cli update-animation-template

PATCH /v5/animation_templates/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: PATCH /v5/animation_templates/{uid}. Native JSON body is required via payload/payload_file.

delete_animation_template

bannerbear-cli delete-animation-template

DELETE /v5/animation_templates/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: DELETE /v5/animation_templates/{uid}. No JSON request body.

animate_template

bannerbear-cli animate-template

POST /v5/animation_templates/{uid}/animate. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/animation_templates/{uid}/animate. Native JSON body is required via payload/payload_file.

remove_bg

bannerbear-cli remove-bg

POST /v5/tools/remove_bg. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/remove_bg. Native JSON body is required via payload/payload_file.

generate_ai_image

bannerbear-cli generate-ai-image

POST /v5/tools/generate_ai_image. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/generate_ai_image. Native JSON body is required via payload/payload_file.

generate_ai_video

bannerbear-cli generate-ai-video

POST /v5/tools/generate_ai_video. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/generate_ai_video. Native JSON body is required via payload/payload_file.

video_thumbnails

bannerbear-cli video-thumbnails

POST /v5/tools/video_thumbnails. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/video_thumbnails. Native JSON body is required via payload/payload_file.

subtitle_video

bannerbear-cli subtitle-video

POST /v5/tools/subtitle_video. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/subtitle_video. Native JSON body is required via payload/payload_file.

generate_voiceover

bannerbear-cli generate-voiceover

POST /v5/tools/generate_voiceover. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/generate_voiceover. Native JSON body is required via payload/payload_file.

create_pdf

bannerbear-cli create-pdf

POST /v5/tools/create_pdf. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/create_pdf. Native JSON body is required via payload/payload_file.

trim_video

bannerbear-cli trim-video

POST /v5/tools/trim_video. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/trim_video. Native JSON body is required via payload/payload_file.

concat_videos

bannerbear-cli concat-videos

POST /v5/tools/concat_videos. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/concat_videos. Native JSON body is required via payload/payload_file.

resize_video

bannerbear-cli resize-video

POST /v5/tools/resize_video. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/resize_video. Native JSON body is required via payload/payload_file.

crop_video

bannerbear-cli crop-video

POST /v5/tools/crop_video. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/crop_video. Native JSON body is required via payload/payload_file.

overlay_video

bannerbear-cli overlay-video

POST /v5/tools/overlay_video. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/overlay_video. Native JSON body is required via payload/payload_file.

overlay_image

bannerbear-cli overlay-image

POST /v5/tools/overlay_image. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/overlay_image. Native JSON body is required via payload/payload_file.

add_audio

bannerbear-cli add-audio

POST /v5/tools/add_audio. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/add_audio. Native JSON body is required via payload/payload_file.

add_cover_art

bannerbear-cli add-cover-art

POST /v5/tools/add_cover_art. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Native operation: POST /v5/tools/add_cover_art. Native JSON body is required via payload/payload_file.

create_video_slideshow

bannerbear-cli create-video-slideshow

POST /v5/tools/create_video_slideshow. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission