API reference / Canvas
Sort a canvas into themes
Groups items into themes: a new frame per group, titled, beside the rest of the canvas, with its items moved into a grid inside it. Name items by key (from GET /canvases/{id}?view=text); each once, and only notes, text, shapes and images.
post
/api/v1/canvases/{id}/sortOther ways to call it
CLI
troopy canvases sortMCP tool
troopy_sort_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.Path parameters
id*stringA 24-character id
Body
application/jsongroups*array<object>At most 20 items
2 properties
title*stringAt least 1 characters · At most 80 characters
keys*array<string>At most 200 items
Response
200 · application/jsondata*object2 properties
seq*integerframes*array<object>The frames it made, one per group
3 properties
key*stringThe item's key, unique on its canvas
title*stringkeys*array<string>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.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
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.