API reference / Canvas
Get the read of a photo
Where the read of a photo is: reading, done with the frame of its notes, or failed with why. The notes arrive on the canvas for everyone who has it open.
get
/api/v1/canvases/{id}/photos/{read}Other ways to call it
CLI
troopy canvases photoMCP toolNone. Call it over REST or with the CLI.
Rate limit120 calls in 60 seconds, for each key
Path parameters
id*stringA 24-character id
read*stringA 24-character id
Response
200 · 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*stringErrors
400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
429 rate_limitedWait the number of seconds in Retry-After, then retry.