REreplicas
Canvas

Read Canvas file

get/v1/replica/{id}/canvas/{filename}

Request

  • Base URL
    https://api.replicas.dev
  • URL
    https://api.replicas.dev/v1/replica/{id}/canvas/{filename}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Replica ID

filenamestring required

Path within the Canvas, URL-encoded

Headers

X-Replicas-Api-Version'2026-10-07'

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

Response

Success

filenamestring required

The Canvas-relative file path, including nested folders.

kind'markdown' | 'mermaid' | 'html' | 'text' | 'image' | 'pdf' | 'docx' | 'video' | 'audio' | 'other' required

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

size_bytesinteger required
mime_typestring required

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

contentstring

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

base64string

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

too_largeboolean

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

revisionstring

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

Example response

{
  "filename": "reports/q3/summary.md"
}

Changes

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