Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Troop

Nudge a teammate

Has the teammate pick up its next task in To do now, rather than at the next minute's pickup, even one waiting to retry after a failure. outcome is picked (with the task it started), working (it already is, with its task if it has one) or idle (nothing waits for it in To do). A paused teammate answers not_ready, and so does one that can't run now (its daily limit, its AI plan, an app it needs), with why.

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

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 agents nudge
MCP tooltroopy_nudge_agent
Rate limit20 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

Response

200 · application/json
data*object
2 properties
outcome*enum<string>

pickedworkingidle

task*object | null
2 properties
key*string
title*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.