API Reference

Authentication

All API requests require an API key. Pass it via the x-api-key header or the api_key query parameter.

curl -H "x-api-key: pf_live_your_key_here" \
  https://api.pagebolt.dev/v1/screenshot

Base URL

https://api.pagebolt.dev/v1

Error Responses

All errors return JSON with an error field.

Rate Limits

Rate limits are per-user, based on your plan. Check response headers:

POST /v1/screenshot

Capture a screenshot of a URL or HTML content. Returns the image as binary data.

Request Body (JSON)

Example

curl -X POST https://api.pagebolt.dev/v1/screenshot \
  -H "x-api-key: pf_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://github.com",
    "width": 1280,
    "height": 720,
    "format": "png",
    "fullPage": false
  }' \
  -o screenshot.png

GET /v1/screenshot

Convenience endpoint — pass parameters as query strings. Ideal for embedding in <img> tags.

<img src="https://api.pagebolt.dev/v1/screenshot?api_key=pf_live_your_key&url=https://example.com&width=800&format=webp" />

POST /v1/pdf

Generate a PDF from a URL or HTML content. Returns the PDF as binary data.

Request Body (JSON)

Example: Generate an invoice PDF

curl -X POST https://api.pagebolt.dev/v1/pdf \
  -H "x-api-key: pf_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<h1>Invoice #1234</h1><p>Amount: $99.00</p>",
    "format": "A4",
    "margin": "2cm",
    "displayHeaderFooter": true
  }' \
  -o invoice.pdf

POST /v1/og-image

Generate dynamic Open Graph / social card images. Use built-in templates or provide custom HTML.

Request Body (JSON)

Example

curl -X POST https://api.pagebolt.dev/v1/og-image \
  -H "x-api-key: pf_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "template": "gradient",
    "title": "How to Build a SaaS in 2026",
    "subtitle": "A practical guide for solo founders",
    "accentColor": "#8b5cf6",
    "bgColor": "#1e1b4b"
  }' \
  -o social-card.png

GET /v1/usage

Check your current usage and plan limits programmatically.

curl https://api.pagebolt.dev/v1/usage \
  -H "x-api-key: pf_live_your_key"

Response

{
  "plan": "starter",
  "usage": {
    "current": 1247,
    "limit": 5000,
    "remaining": 3753
  }
}

MCP Server (AI Agent Integration)

PageBolt includes a built-in Model Context Protocol (MCP) server that lets AI coding assistants call the PageBolt API directly. Say "take a screenshot of example.com" in your IDE and get the result inline.

Available Tools

Environment Variables

Setup: Claude Desktop

Add this to your Claude Desktop config file (~/.claude/claude_desktop_config.json):

{
  "mcpServers": {
    "pagebolt": {
      "command": "node",
      "args": ["/path/to/pagebolt/src/mcp-server.mjs"],
      "env": {
        "PAGEBOLT_API_KEY": "pf_live_your_key_here",
        "PAGEBOLT_BASE_URL": "https://your-pagebolt-instance.com"
      }
    }
  }
}

Setup: Cursor

Add this to your Cursor MCP settings (.cursor/mcp.json in your project):

{
  "mcpServers": {
    "pagebolt": {
      "command": "node",
      "args": ["/path/to/pagebolt/src/mcp-server.mjs"],
      "env": {
        "PAGEBOLT_API_KEY": "pf_live_your_key_here",
        "PAGEBOLT_BASE_URL": "https://your-pagebolt-instance.com"
      }
    }
  }
}

Example Usage

Once configured, you can ask your AI agent things like: