Login
Free Sign Up
Docs
/

Canvas Ingestion

Ingestion turns an uploaded file into an artifact on a Canvas. It is the only way external content enters a Canvas.

Supported Formats

Six formats are supported. No other file type can be ingested. PDF, Word, email, archive, audio, and video formats are not supported.

Format

Media types

Extensions

text

text/plain, text/markdown, text/x-markdown

.txt, .md, .markdown

csv

text/csv, text/tab-separated-values, application/csv

.csv, .tsv

xlsx

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel.sheet.macroenabled.12

.xlsx, .xlsm

json

application/json, text/json

.json

html

text/html, application/xhtml+xml

.html, .htm, .xhtml

image

image/png, image/jpeg, image/webp, image/gif

.png, .jpg, .jpeg, .webp, .gif

An unsupported media type returns BAD_REQUEST with the message Unsupported ingestion media type.

Upload

Upload one file per request, up to 20 MiB (20,971,520 bytes).

Upload is subject to the same access rules as Canvas. See Canvas Access. Requests that fail these checks return 404 Not found.

After a successful upload:

  • The Canvas gains an artifact node labelled with the file name. The node has no data.
  • The node is placed at the default position, x 80, y 120.
  • A Canvas version is saved with the summary Uploaded <filename>.