render

Convert a JSON Canvas board to PDF (API key)

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.

post/api/v1/canvas

Request

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

Request body

filesobject

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).

Response

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

successtrue required
templateIdstring

Stored template rendered (/render only).

pageCountinteger required
sizeBytesinteger required
renderMsinteger required
artifactIdstring

Render artifact id; download again via GET /api/v1/artifacts/{id}/pdf.

credits_deductedinteger
remaining_balanceinteger

Changes

No recorded changes to this operation across all 1 revision of this API.