Skip to content

Bannerbear

Updated View as Markdown

Read workspace render-credit quota, page through image template summaries and check an existing image status with a scoped Bannerbear v5 API key. This three-command subset returns metadata without generating media, polling, exposing canvas configuration or performing writes. v2 keys cannot authenticate these v5 endpoints.

What you can do (3)

What you can do

Available commands: 3 (3 read, 0 write). Enable only the commands your application needs.

Command Effect
Read workspace credit quota — bannerbear.account.get Read
List image template summaries — bannerbear.templates.list Read
Read image generation status — bannerbear.images.get Read

Connect and use

Connect and use

Open the integration's connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.

Get your provider credentials

Follow these steps for Bannerbear, then enter the issued values in the connection form below.

  1. In Bannerbear open the v5 API Keys page, create a dedicated key and grant image_templates:read and images:read for the commands you need. An unscoped key has full access; v2 keys are incompatible with v5. Enter the key in Bannerbear v5 API key in this connection, select commands and save. Create a scoped Tooluse.net API key for your client. Start with account.get or templates.list; images.get needs a previously generated image UID. Replace a revoked or rolled provider key in this same connection. These commands do not generate media or provide managed OAuth.

Official credential setup

Where to enter credentials

In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.

Connection field Requirement
Bannerbear v5 API key Required

Open API keys and create a Tooluse.net key for the enabled commands.

Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.

Configure Claude Code, Codex or Cursor once

Permissions and results

If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.

Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.

Call from your client

Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.

Configure Claude Code, Codex or Cursor once

Discover your enabled tools

List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.

curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.

HTTP call

curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {}
}'

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Commands

Read workspace credit quota — bannerbear.account.get

Read the workspace UID and render-credit quota for this v5 API key. Key metadata, billing details and AI-credit usage are not returned. This does not generate media or consume render credits.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List image template summaries — bannerbear.templates.list

Read one explicit page of image template UIDs, names and dimensions. The provider chooses its page size; pass the next page number in a later invocation. Canvas configuration, asset URLs, write-access settings and generation are excluded.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.page integer Required Positive Bannerbear page number; no automatic pagination. minimum: 1; maximum: 9007199254740991

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "page": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Read image generation status — bannerbear.images.get

Read an existing image UID, status and available creation/completion timestamps. This is one status read, not polling or generation. Output file URLs, metadata, error bodies and template modifications are excluded.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.uid string Required UID of an existing Bannerbear v5 image, not a template UID. pattern: "^[A-Za-z0-9_-]{1,128}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "uid": "image123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Errors

Check the key's expiry, revocation, workspace and allowed operations.

Reuse the same idempotency key only for the same request.

The connection or provider limit has been reached. Check the receipt before retrying.

Test the connection

Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.

Official provider documentation

Type to search…

↑↓ navigate↵ selectEsc close