API reference / Troop
Get a teaching session
The teammate's teaching session that is going, or null: a task a person is showing it on its computer (recording, with how many steps so far), the recording it is studying (studying), or the skill it drafted, waiting for review (ready). Poll it while recording or studying. Needs an owner or admin.
get
/api/v1/agents/{handle}/teachOther ways to call it
CLI
troopy teach getMCP toolNone. Call it over REST or with the CLI.
Rate limit120 calls in 60 seconds, for each key
Path parameters
handle*stringThe teammate's handle, like chief
At most 40 characters
Response
200 · application/jsondata*object | null9 properties
id*stringA 24-character id
agent*stringThe teammate's handle
goal*stringWhat the person said they would show
status*enum<string>recordingstudyingreadysaveddiscardedfailed
steps*integerSteps recorded: visits, clicks, typing, Enter
draft*object | nullThe skill it drafted, once ready
3 properties
name*stringdescription*stringWhen to use it
text*stringThe steps, in markdown
threadId*string | nullThe conversation it studies the recording in
error*string | nullcreatedAt*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.