Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Needs you

Answer a teammate's question

Answers what a teammate asked on a task (a task's asks are in GET /tasks/{key}). A decision takes choice (one of its options) or text of your own. An input takes text. An approval takes approve, or changes with text: for an engineering ticket's plan, send the version you read. Once nothing on the task waits for a person, its teammate picks it up again with the answers. Answering twice returns the first answer.

post/api/v1/asks/{id}

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 asks answer
MCP tooltroopy_answer_ask
Rate limit60 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*string

A 24-character id

Body

application/json
choicestring

At most 200 characters

textstring

At most 4000 characters

versioninteger

For the approval of a plan: the version you read. A newer plan is refused, so read it again first

At least 1

Response

200 · application/json
data*object
14 properties
id*string

A 24-character id

taskId*string

A 24-character id

agent*string

The teammate asking

kind*enum<string>

decisioninputapprovallogin

question*string
options*array<string>

For a decision: the choices, the teammate's pick first

draftId*string | null

For an approval: the draft to approve

docobject | null

For the approval of a plan: the plan and the version to approve

2 properties
kind*enum<string>

analysisplan

version*integer
sitestring | null

For a login request: the site the teammate needs a login to

status*enum<string>

openansweredwithdrawn

answer*object | null
2 properties
choice*string | null
text*string | null
answeredBy*object | null
3 properties
type*enum<string>

personagentapi

id*string
name*string
answeredAt*string | null
createdAt*string

ISO 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.