BiGapiguides
POST /v1/render → 200 application/pdf · 1¢

HTML, Markdown or a URL to PDF — for AI agents

Your agent wrote the report. This endpoint turns it into a real PDF: Chromium-rendered, with fonts, CSS, page breaks, headers and footers. Also renders PNG.

Quick start (curl)

Get a key first – no signup: curl -X POST https://api.bigapi.dev/v1/keys (100 free operations, 7 days).

curl -X POST https://api.bigapi.dev/v1/render -H 'Authorization: Bearer $KEY' -H 'Content-Type: application/json' -d '{"html":"<h1>Invoice 4711</h1>","format":"pdf"}' -o invoice.pdf

Give it to your agent (MCP)

Add BiGapi to Claude Desktop, Cursor or any MCP client – the server fetches its own key on first use:

{
  "mcpServers": {
    "bigapi": { "command": "npx", "args": ["-y", "@bigapi/mcp"] }
  }
}

Then simply ask: “Render this Markdown report as a PDF with a footer page number.” – the model calls the render tool.

When your agent needs this

Parameters

ParamTypeRequiredNotes
htmlstringnoHTML document or fragment. One of html, markdown, url is required.
markdownstringnoMarkdown source; converted with GitHub-flavoured rules.
urlstringnoPublic URL to render.
cssstringnoExtra CSS injected into the document.
formatstringnoone of pdf, png · default pdf
pdfobjectnoChromium PDF options: format (A4, Letter…), landscape, margin, printBackground, scale.
pngobjectnoViewport options: width, height, fullPage, deviceScaleFactor.
waitUntilstringnoone of load, domcontentloaded, networkidle0, networkidle2 · default networkidle0
timeoutMsintegernodefault 30000

Pricing

1¢ per operation
First 100 operations free (per key, 7 days) · failed calls (4xx/5xx) cost $0 · repeats with Idempotency-Key are free · prepaid credit from $5, never expires.

Every response carries X-BigAPI-Cost, X-BigAPI-Balance and X-BigAPI-Free-Ops – your agent can budget on its own.

Errors your agent can handle

StatusMeaningAgent action
401missing/invalid keyPOST /v1/keys for a fresh one
402credit exhaustedshow the upgrade_url from the response to a human
413file too largesplit the input (limit 100 MB)
422conversion failedcheck the detail field – costs $0
429rate limitedwait retry_after seconds

FAQ

Does it support page breaks and headers/footers?

Yes – CSS page breaks work, and pdf.headerTemplate / pdf.footerTemplate accept Chromium header/footer HTML.

Markdown or HTML – which should my agent send?

Markdown is simplest and gets a clean print stylesheet automatically. Send HTML when you need full layout control, plus optional css.

Can it render JavaScript-heavy pages?

Yes, url sources wait for network idle by default. Use waitUntil and timeoutMs to tune.