Skip to main content
GET
Read Canvas file

Authorizations

Authorization
string
header
required

Organization or personal API key from Settings → API Keys.

Headers

X-Replicas-Api-Version
enum<string>

API version. 2026-10-07 returns snake_case responses. See versioning.

Available options:
2026-10-07

Path Parameters

id
string<uuid>
required

Replica ID

filename
string
required

Path within the Canvas, URL-encoded

Response

Success

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
size_bytes
integer
required
mime_type
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.

too_large
boolean

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

revision
string

SHA-256 revision to pass as expectedRevision when saving editable text.

Pattern: ^[a-f0-9]{64}$