Templates / API Reference

API Reference PDF template — render it from Markdown

An API reference is a lookup surface, and the design should behave like one. Roboto Mono headings give every endpoint a stable, scannable anchor; grid-ruled tables carry parameters and status codes; an Inter body keeps the prose out of the way. Blue accents mark the interactive: paths, verbs, examples.

Use this template Download sample.md

API Reference

Before & after

Plain Markdown in. A api reference worth sending out.

Your reference is likely already Markdown — generated from an OpenAPI spec or written by hand in the repo. Send it through as-is: endpoint headings, parameter tables, fenced request/response examples. Render on release and hand enterprise customers the versioned, offline PDF their procurement asked for.

api-reference.mdMD

# Northwind API Reference — v2

Base URL: `https://api.northwind.dev/v2` · Auth: `Bearer` token

## POST /jobs

Create an ingestion job.

### Request

```json
{
  "type": "sync",
  "source": "warehouse",
  "priority": "normal"
}
```

### Parameters

| Field      | Type   | Required | Notes                     |
| ---------- | ------ | -------- | ------------------------- |
| `type`     | string | yes      | `sync` or `backfill`      |
| `source`   | string | yes      | Registered source id      |
| `priority` | string | no       | `low` · `normal` · `high` |

### Responses

| Status | Meaning                              |
| ------ | ------------------------------------ |
| 201    | Job created; body contains `job_id`  |
| 409    | A job for this source is in flight   |
| 422    | Validation failed; see `errors[]`    |

## GET /jobs/{id}

Fetch job status. Poll at ≥5s intervals; webhooks are
preferred for completion events.

```bash
curl -H "Authorization: Bearer $TOKEN" \
  https://api.northwind.dev/v2/jobs/job_8fk2
```

api-reference.pdfPDF

API Reference

Render it your way

Three ways to render the api reference.

Dashboard

Paste your Markdown in the editor, pick API Reference, and download the PDF — no code involved.

REST API

curl https://inkrun.dev/api/v1/render \
  -H "Authorization: Bearer sk_..." \
  -H "Accept: application/pdf" \
  -d '{"template": "api-reference", "markdown": "# ..."}' \
  --output api-reference.pdf

MCP · your agent

Add the Inkrun MCP connector once, then ask your agent:

“Generate a PDF reference for these endpoints with the api-reference template.”

FAQ

API Reference template — common questions.

Can I generate the Markdown from an OpenAPI spec?

Yes — any OpenAPI-to-Markdown step works; Inkrun renders the result, so your PDF reference regenerates alongside the spec.

How do endpoint tables render?

Tables get the template's full grid ruling — every cell bordered — which is what parameter and status-code lookup wants.

Why would an API need a PDF at all?

Enterprise procurement, air-gapped environments and versioned release artifacts — a deterministic PDF is the reference that doesn't change after you ship it.

Related templates