API reference / Canvas
Read a photo of a board into notes
Takes a photo of a cork board or a whiteboard with sticky notes on it. The photo goes on the canvas. The Chief of Staff reads it on the workspace's AI plan, and each note that it can read becomes a sticky note in its colour, laid out as on the board, in a frame beside the photo. Words written on the board itself become text. Send a PNG, JPEG or WebP image of at most 3.5 MB and 8,000 pixels a side, base64-encoded. The answer comes at once: poll statusUrl until status is done. A workspace reads 20 photos a day, 2 at a time. From the CLI, pass --content @./board.jpg to read a file.
/api/v1/canvases/{id}/photosOther ways to call it
troopy canvases read-photoIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Path parameters
id*stringA 24-character id
Body
application/jsoncontent*stringThe photo, base64-encoded
At most 4700000 characters · base64
Response
202 · application/jsondata*object8 properties
id*stringThe read: GET /canvases/{id}/photos/{read} says where it is
status*enum<string>reading: the Chief of Staff reads the photo; poll statusUrl every few seconds
readingdonefailed
photo*string | nullThe photo on the canvas, an image item
frame*string | nullThe frame that holds the notes, once they are there
notes*integerThe notes and the words of the board that it added
error*string | nullWhy it failed
createdAt*stringISO 8601 date and time
statusUrl*string