Get Canvas Item
Reads a single Canvas item by its Canvas-relative path, including nested paths. Text kinds (markdown, mermaid, html, text) return UTF-8 text in content. Binary kinds (image, pdf, video, audio, other) return base64 in base64. Items over the 5 MB preview cap return tooLarge: true with neither payload; callers should reach for replicas media upload for those.
Authorizations
API key authentication. Obtain your API key from the Replicas dashboard under Organization → Settings → API Keys.
Path Parameters
The unique identifier of the replica
The Canvas-relative file path, including extension (e.g. reports/q3/summary.md). Encode / as %2F in the request URL.
"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.
The Canvas-relative file path, including nested folders.
"reports/q3/summary.md"
The kind of Canvas item, inferred from its file extension.
markdown, mermaid, html, text, image, pdf, video, audio, other MIME type to render the content with (e.g. text/markdown; charset=utf-8, image/png).
UTF-8 text for markdown / mermaid / html / text kinds.
Base64 payload for image / pdf / video / audio / other kinds.
Present and true when the file exceeded the engine's preview size cap.