Sign in

v1

latestOpenAPI 3.1.02026-07-22100167210.7 KB
Replica

Get Canvas Item

Reads a single Canvas item by filename. Text kinds (markdown, html) return UTF-8 text in content. Binary kinds (image, video, audio, other) return base64 in base64. Items over the 5 MB per-file cap return tooLarge: true with neither payload; callers should reach for replicas media upload for those.

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

Path parameters

idstring uuid required

The unique identifier of the replica

filenamestring required

The Canvas item filename, including extension (e.g. example-plan.md).

Response

Successful response

filenamestring required
kind'markdown' | 'html' | 'image' | 'video' | 'audio' | 'other' required

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

sizeBytesinteger required
mimeTypestring required

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

contentstring

UTF-8 text for markdown / html kinds.

base64string

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

tooLargeboolean

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