Export a Canvas

GET

/api/v1/notes/{id}/export

const url = 'https://example.com/api/v1/notes/example/export?format=png';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/notes/example/export?format=png' \
  --header 'Authorization: Bearer <token>'

Export the authenticated User’s Canvas as PNG or SVG. The bounded offline renderer resolves authorized Home images and returns 429 when it is busy. Route: /api/v1/notes/{id}/export. Inputs: id, format, offset, limit. Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Parameters

Path Parameters

required

string

Query Parameters

format

required

The format is fixed; callers cannot select a program, path or browser flag.

string

Allowed values: png svg

offset

integer

Byte offset for bounded CLI/MCP transfers. Omit to download the whole file.

limit

integer

>= 1 <= 524288

A chunk is at most 512 KiB, below the shared adapter response ceiling.

Responses

200

application/octet-stream

Array<integer>

400

Invalid Canvas or export dimensions

404

Note not found

429

Renderer busy

503

Renderer unavailable