Skip to main content
POST
Upload Workspace Canvas Item

Authorizations

Authorization
string
header
required

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

Path Parameters

workspaceId
string<uuid>
required

Body

multipart/form-data
file
file
required
filename
string

Optional Canvas-relative destination path. Defaults to the uploaded file name.

Response

File uploaded to an active workspace

A Canvas upload accepted immediately or queued until the workspace is active.

filePath
string
required

Canvas display path for the uploaded file.

Example:

"~/.replicas/canvas/report.pdf"

originalName
string
required

Normalized Canvas-relative file name.

Example:

"report.pdf"

sizeBytes
integer
required
Required range: x >= 0
uploadId
string

Present when the upload was queued. Pass it in the related message's canvasUploadIds.