Build with BulkRender.

All API requests require a platform API key sent in the X-API-Key header. API access is available on the Pro plan and above.

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_MCP_TOKEN_HERE"

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,
    "downloadUrl": "https://s3.amazonaws.com/your-bucket/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",
    "recipientEmailField": "email"
}'

{
  "status": "success",
  "data": {
    "batchId": "b8c9d0e1-...",
    "downloadUrl": "https://s3.amazonaws.com/your-bucket/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 }
    ],
    "deliverySummary": { "sent": 2, "failed": 0, "skipped": 0 }
  }
}

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 403 Forbidden

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

Rate Limits

API requests 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 MCP server so you can generate documents directly from Claude, Cursor, Windsurf, Cline, or any MCP-compatible assistant. No API calls, no boilerplate — just ask.

Prerequisites

• BulkRender account on Pro plan or above (API access required)
• MCP URL from Settings, Integrations, AI Assistants (MCP) — generated once, treat like a password

Get your MCP URL

Go to Settings, Integrations, open the AI Assistants section, and click Generate MCP URL. Copy it immediately — it is only shown once.

Connect: Claude Desktop / Cursor / Windsurf / Cline

Add to your app's MCP config file. Paste your MCP URL directly — no environment variables needed:

{
  "mcpServers": {
    "bulkrender": {
      "url": "https://mcp.bulkrender.com/mcp/YOUR_MCP_URL"
    }
  }
}

Connect: Claude.ai

Go to Settings, Integrations, Add MCP and paste your MCP URL.

Connect: Claude Code (CLI)

claude mcp add bulkrender --scope user -- npx mcp-remote YOUR_MCP_URL

Verify: claude mcp list should show bulkrender ✓ Connected

Available Tools

DOCX = 1 credit. PDF = 2 credits. Rate limit: 30 requests/min per organisation.

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://mcp.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.

Machine-Readable Resources

• OpenAPI 3.1 Spec — full schema for auto-generating client code
• llms.txt — lightweight plain-text API summary for LLM context
• GitHub: bulkrender-mcp — source, issues, changelog
• npm: bulkrender-mcp