Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Troop

Teach a teammate a task

Starts recording a task a person is about to do once in the teammate's own browser on the workspace's computer: its browser comes to the front, then page visits, clicks, typing and Enter are recorded, never passwords, one-time codes or card numbers. Take over the computer's screen (POST /computer/desktop) to do it. Starting while one records returns that one. Needs an owner or admin.

post/api/v1/agents/{handle}/teach

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy teach start
MCP toolNone. Call it over REST or with the CLI.
Rate limit10 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

handle*string

The teammate's handle, like chief

At most 40 characters

Body

application/json
goal*string

What you are about to show, like Refund an order in Stripe

At least 3 characters · At most 200 characters

Response

201 · application/json
data*object
9 properties
id*string

A 24-character id

agent*string

The teammate's handle

goal*string

What the person said they would show

status*enum<string>

recordingstudyingreadysaveddiscardedfailed

steps*integer

Steps recorded: visits, clicks, typing, Enter

draft*object | null

The skill it drafted, once ready

3 properties
name*string
description*string

When to use it

text*string

The steps, in markdown

threadId*string | null

The conversation it studies the recording in

error*string | null
createdAt*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.