Inkspan › Guides › Report Generation API

Report Generation API

Generate polished report PDFs from Markdown or templated HTML — for scheduled analytics reports, exports, and dashboards that need a shareable document.

Markdown is the natural output format for both scheduled jobs and language models, which makes this the usual last step in a reporting or agent pipeline.

Example

import requests

r = requests.post(
    'https://api.inkspan.dev/v1/generate/markdown',
    headers={'X-API-Key': 'ink_live_...'},
    json={
        "markdown": "# Q3 Report\n\n| Metric | Value |\n|---|---|\n| Signups | 1200 |"
    },
)
r.raise_for_status()
with open('document.pdf', 'wb') as f:
    f.write(r.content)

Request parameters

Name	Type	Required	Description
`markdown`	string	yes	Markdown source. GitHub-style tables and fenced code blocks are supported.
`filename`	string	no	Filename in the response's Content-Disposition.

Response

Returns a PDF as a binary stream with Content-Type: application/pdf and Content-Disposition: attachment; filename=document.pdf. Write the response body straight to disk — do not parse it as JSON.

Things that catch people out

Styling is a sensible built-in default, not configurable through this endpoint. For full control over typography, convert to HTML yourself and use /v1/generate/html.
Tables and fenced code are enabled; more exotic extensions such as footnotes and definition lists are not.
Raw HTML inside Markdown passes through to the renderer, which is useful for a page break (<div style='page-break-after:always'></div>).
Remember to escape newlines as \n when embedding Markdown in a JSON request body.

Errors

Status	Meaning	Fix
`401`	Invalid or missing API key	Send your key in the `X-API-Key` header.
`402`	Monthly quota exceeded	The response reports used/quota. Upgrade at inkspan.dev/#pricing.
`422`	Missing or invalid parameter	Check required fields in the table above — the body names the offending field.

Failed requests do not count against your quota; only successful ones are metered.

Frequently asked questions

Is there a free tier?

Yes — 100 documents a month, no card required. Usage-based plans start at $19/month when you outgrow it.

How do I authenticate?

Send your key in the X-API-Key header on every request.

Do failed requests count against my quota?

No. Only successful requests are metered.

Get a free API key →

Full guides for /v1/generate/markdown: cURL · Python · Node.js · all guides