---
title: "Convert a JSON Canvas board to PDF (API key)"
method: POST
path: "/api/v1/canvas"
tags: ["render"]
---

# Convert a JSON Canvas board to PDF (API key)

`POST /api/v1/canvas`

## Request

- Base URL: `https://makespdf.com`
- URL: `https://makespdf.com/api/v1/canvas`
- Auth: one of:
  - HTTP bearer
  - none

Send the parsed canvas object or the raw .canvas file text - cards, connector arrows, groups, image and note cards render in about a second. Text cards run the full markdown pipeline. Cards whose content overflows continue on later pages.

## Request body

- object
  - `canvas` union, required: A JSON Canvas 1.0 document (an Obsidian .canvas board) - the parsed object, or the raw file text as a string. Max 2MB of JSON; cards render through the markdown pipeline, so text cards support headings, lists, tables, images, Mermaid and graph blocks.
    - object
    - string
  - `files` object: Contents for the canvas file / background paths, keyed by the exact path string. The server cannot read a vault, so image and note cards resolve through this map (or the standard image fetcher for bare http(s) URLs).
  - `options` object: Rendering options. Omit for defaults.
    - `pageSize` 'A3' | 'A4' | 'A5' | 'Letter' | 'Legal': Fit the board on a sheet. Omit to make the page the board itself.
    - `fontFamily` 'Inter' | 'NotoSans'
    - `title` string
    - `author` string
    - `subject` string
    - `keywords` string
    - `lang` string: Document language (BCP 47) - sets the PDF /Lang and picks the built-in CJK font ('ja', 'ko', 'zh-Hant', 'zh-Hans', ...). Omit to infer from the text.

## Response `200`

Rendered PDF (PDF/A-2A + PDF/UA-1 dual-compliant, tagged). Send `Accept: application/json` for metadata instead of bytes.

- RenderMetadata: Returned instead of PDF bytes when the request sends `Accept: application/json`.
  - `success` true, required
  - `templateId` string: Stored template rendered (/render only).
  - `pageCount` integer, required
  - `sizeBytes` integer, required
  - `renderMs` integer, required
  - `artifactId` string: Render artifact id; download again via GET /api/v1/artifacts/{id}/pdf.
  - `templateWarnings` unknown[]
    - unknown
  - `layoutWarnings` unknown[]
    - unknown
  - `credits_deducted` integer
  - `remaining_balance` integer
  - `paid` object
    - `payer` string
    - `txHash` string

## Other responses

- `400`: Malformed body or failed validation. Never billed.
- `401`: Missing or invalid Bearer token. The body links the docs, llms.txt and the auth skill.
- `429`: Rate limit exceeded.
- `500`: Unexpected server error. Never billed.

---

[API](https://skmtc.dev/makespdf/apis/makespdf-api.md) · [All operations](https://skmtc.dev/makespdf/apis/makespdf-api/llms.txt) · [OpenAPI document](https://skmtc.dev/makespdf/apis/makespdf-api/revisions/b3042c8646ef?raw)