Build with BulkRender.

All API requests require a platform API key sent in the X-API-Key header. API access is available on all plans, including Free. Usage is billed per document credit.

Create and manage keys in Settings, Platform API Keys.

Keys use the format br_live_.... The full key is shown only once at creation time. Store it securely.

curl -X POST https://api.bulkrender.com/api/documents/generate \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Generate a single document from a template. Pass the template ID and a data object with key-value pairs matching your template variables.

Request Body

curl -X POST https://api.bulkrender.com/api/documents/generate \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "templateId": "c5f2e8a1-...",
    "data": {
        "name": "John Doe",
        "company": "Acme Inc",
        "items": [
            { "product": "Widget", "quantity": "10", "price": "$9.99" }
        ]
    },
    "outputFormat": "docx"
}'

{
  "status": "success",
  "data": {
    "id": "d4e5f6a7-...",
    "name": "Invoice - John Doe",
    "file_type": "docx",
    "file_size": 24832,
    "url": "https://download.bulkrender.com/document-templates/docs/Invoice-John-Doe.docx?X-Amz-Expires=3600&...",
    "created_at": "2026-05-17T10:30:00.000Z",
    "expires_at": "2026-06-16T10:30:00.000Z"
  }
}

Generate multiple documents from the same template. Each record in the array produces one document. The result is a downloadable ZIP archive.

Request Body

Batch Size Limits

curl -X POST https://api.bulkrender.com/api/documents/generate-batch \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "templateId": "c5f2e8a1-...",
    "records": [
        { "name": "Alice Smith", "email": "alice@example.com" },
        { "name": "Bob Jones", "email": "bob@example.com" }
    ],
    "outputFormat": "docx"
}'

{
  "status": "success",
  "data": {
    "batchId": "b8c9d0e1-...",
    "url": "https://download.bulkrender.com/document-templates/batches/batch-b8c9d0e1.zip?X-Amz-Expires=3600&...",
    "count": 2,
    "totalSize": 49152,
    "documents": [
      { "name": "Alice Smith", "key": "...", "size": 24576 },
      { "name": "Bob Jones", "key": "...", "size": 24576 }
    ]
  }
}

Everything you need for a full workflow without opening the dashboard: list your templates to find a templateId, inspect its variables to build the data object, check your credit balance, generate, and refresh download links later.

Templates

Documents

Credits

curl https://api.bulkrender.com/api/billing/credits -H "X-API-Key: YOUR_API_KEY"

{ "status": "success", "data": { "plan": "pro", "subscriptionCredits": 500,
    "purchasedCredits": 100, "totalCredits": 600, "purchasedCreditPacks": [...] } }

Feedback

POST /api/feedback with { "type": "bug", "message": "..." } sends feedback to the team. Auth optional; limited to 5 per hour per IP.

MCP parity note: every BulkRender MCP tool maps to one of these endpoints, except search_templates (fetches the template list and filters locally) and estimate_cost (client-side math: DOCX is 1 credit per document, PDF is 2). Neither needs a server route.

All API responses follow a consistent JSON structure.

Success

{ "status": "success", "data": { ... } }

Error

{ "status": "error", "message": "Description of what went wrong" }

Credit Usage Headers

Generation endpoints return credit information in response headers:

The API uses standard HTTP status codes. Errors always return a JSON body with status: "error" and a message field.

HTTP/1.1 402 Payment Required

{
  "status": "error",
  "message": "Insufficient credits. You need 2 credits for PDF. You have 0 credits."
}

Rate Limits

Generation and mutation endpoints are rate-limited to 30 requests per minute per organization. The limit applies across all API keys in your organization.

Rate limit headers are included in every response: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Credits

Each document generation costs credits based on format:

For batch requests, total credits = number of records × credit cost per format. Example: 50 PDF documents = 100 credits.

To safely retry requests without generating duplicate documents, include an Idempotency-Key header with a unique value (e.g., a UUID).

If the same key is sent again within 24 hours, the API returns the original response instead of generating a new document. No additional credits are charged.

curl -X POST https://api.bulkrender.com/api/documents/generate \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
  -d '{ "templateId": "c5f2e8a1-...", "data": { "name": "John Doe" } }'

BulkRender ships a native, hosted MCP server so you can generate documents directly from Claude (Claude.ai, Claude Desktop, Claude Code), with more MCP-compatible assistants coming soon. No API calls, no boilerplate, no package to install: just ask.

Prerequisites

• BulkRender account with available credits (any plan)

Connect: Claude.ai and Claude Desktop (recommended)

Sign in with your BulkRender account, no token setup needed. Go to Settings, Connectors, Add custom connector and paste the BulkRender endpoint:

https://api.bulkrender.com/mcp

Claude opens a BulkRender sign-in page. Log in, approve access, done. Manage or disconnect apps any time from Settings, Integrations, Connected apps.

Alternative: personal MCP URL

For tools where a sign-in flow is not practical (CLI, headless agents), generate a personal MCP URL instead: go to Settings, Integrations, open the AI Assistants section, and click Generate MCP URL. Copy it immediately, it is only shown once, and treat it like a password. In config files, use it via mcp-remote:

{
  "mcpServers": {
    "bulkrender": {
      "command": "npx",
      "args": ["mcp-remote", "YOUR_MCP_URL"]
    }
  }
}

Connect: Claude Code (CLI)

claude mcp add --transport http bulkrender YOUR_MCP_URL --scope user

Verify: claude mcp list should show bulkrender ✓ Connected

Cursor / Windsurf / Cline: coming soon

BulkRender speaks standard MCP, but we have only fully tested Claude clients so far. Verified setup guides for Cursor, Windsurf and Cline are coming soon.

Available Tools

DOCX = 1 credit. PDF = 2 credits. Rate limit: 100 requests per 15 minutes per IP on the MCP endpoint. Generation calls also count toward the 30/min organisation limit.

Template Data Shapes

Templates support two kinds of blocks, and each expects a different data shape:

• Loops (repeating rows like {#items}...{/items}): pass an array of objects. Each element renders the block once with its own values.
• Conditionals (show/hide sections like {#isVIP}...{/isVIP}): pass a boolean to toggle. Variables inside the block resolve from the top level of your data, so supply them there, not nested inside the block name.

Example: {"discount": true, "discountAmount": "100.00"} renders the discount section with its amount. Nesting the amount inside a discount object leaves it blank.

Walk-in Tools (no account required)

Agents with no BulkRender account can generate documents and pay per session. Connect using the public MCP URL, no API key needed:

https://api.bulkrender.com/mcp/acp

Pricing: $0.10/credit. DOCX = 1 credit, PDF = 2 credits. Minimum charge $1.00 (covers up to 10 DOCX or 5 PDF docs). Unused credit is yours if you sign up.

Usage Examples

• "List my BulkRender templates"
• "Generate an invoice using the Invoice Template for Acme Corp, invoice #1234, dated 2025-01-15, amount $5,000"
• "Generate invoices for these 3 clients: Acme Corp ($5,000), Beta Inc ($3,200), Gamma LLC ($7,800)"
• "How many BulkRender credits do I have left?"

The assistant calls list_templates to find the template, then generate_document or generate_batch, and returns a signed download URL valid for 1 hour.

Autonomous Agent Accounts

Need an agent to self-register and maintain its own API key and credit balance over time? See the Agent Provisioning guide for the full flow: autonomous registration, human operator OTP verification, credit top-up, and spend limits.

Machine-Readable Resources

• OpenAPI 3.1 Spec: full schema for auto-generating client code
• llms.txt: lightweight plain-text API summary for LLM context
• Agent discovery catalog: capabilities, pricing, and integration details for agent frameworks