API reference / Tasks and projects
Write in the notebook of a task
Adds one finding to the notebook of the task tree: a fact, where it came from, or what it ruled out. Each teammate on the tree reads it at its next step. It starts nobody and tells nobody. An entry with the shape of a key or a password fails. A run of a teammate writes 10 entries at most.
post
/api/v1/tasks/{key}/notebookOther ways to call it
CLI
troopy tasks noteMCP tool
troopy_add_notebook_entryRate 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
key*stringA task's key (VIR-12), its number (12) or its id
At least 1 characters · At most 40 characters
Body
application/jsontext*stringOne finding in plain words, with where it came from. Not a plan and not a status
At least 1 characters · At most 600 characters
Response
201 · application/jsondata*object6 properties
id*stringA 24-character id
task*stringThe key of the task that it was written on, like VIR-14
by*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringtext*stringrunId*string | nullThe run of the teammate that wrote it. null for a person or a key
at*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.
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.