Skip to main content
GET
/
v1
/
replica
/
{id}
/
canvas
/
{filename}
Get Canvas Item
curl --request GET \
  --url https://api.tryreplicas.com/v1/replica/{id}/canvas/{filename} \
  --header 'Authorization: Bearer <token>'
{
  "filename": "<string>",
  "sizeBytes": 123,
  "mimeType": "<string>",
  "content": "<string>",
  "base64": "<string>",
  "tooLarge": true
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

The unique identifier of the replica

​
filename
string
required

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

Response

Successful response

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

​
filename
string
required
​
kind
enum<string>
required

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

Available options:
markdown,
html,
image,
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 / html kinds.

​
base64
string

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

​
tooLarge
boolean

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