API reference / Canvas
Create a canvas
Adds a canvas, empty or laid out from a template: brainstorm (a title, then frames for ideas, questions and next steps) or retro (frames for what went well, what to improve, and actions). Everyone in the workspace can open and change it.
post
/api/v1/canvasesOther ways to call it
CLI
troopy canvases createMCP tool
troopy_create_canvasRate limit30 calls in 60 seconds, for each key
RetriesSend an
Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsonname*stringAt least 1 characters · At most 80 characters
templateenum<string>blank unless said
blankbrainstormretro
Response
201 · application/jsondata*object6 properties
id*stringA 24-character id
name*stringcreatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringlastEditedBy*object | nullWho changed it last
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time
Errors
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.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.