Skip to main content
GET
Get Canvas Item

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the Replicas dashboard under Organization → Settings → API Keys.

Path Parameters

id
string<uuid>
required

The unique identifier of the replica

filename
string
required

The Canvas-relative file path, including extension (e.g. reports/q3/summary.md). Encode / as %2F in the request URL.

Example:

"reports/q3/summary.md"

Response

Successful response

A single Canvas item's content. Text kinds populate content; binary kinds populate base64. Items over the 5 MB preview cap return tooLarge: true with neither payload populated.

filename
string
required

The Canvas-relative file path, including nested folders.

Example:

"reports/q3/summary.md"

kind
enum<string>
required

The kind of Canvas item, inferred from its file extension.

Available options:
markdown,
mermaid,
html,
text,
image,
pdf,
video,
audio,
other
sizeBytes
integer
required
mimeType
string
required

MIME type to render the content with (e.g. text/markdown; charset=utf-8, image/png).

content
string

UTF-8 text for markdown / mermaid / html / text kinds.

base64
string

Base64 payload for image / pdf / video / audio / other kinds.

tooLarge
boolean

Present and true when the file exceeded the engine's preview size cap.