API reference / Account
Search the Troopy guides
Searches the guides of troopy.ai/docs, which tell how each part of Troopy works and how to use it. Each hit names a guide, the part of it that fits, some of its words and its address. GET /guide reads a guide or one part of it.
get
/api/v1/guidesOther ways to call it
CLI
troopy guides searchMCP tool
troopy_search_guidesRate limit60 calls in 60 seconds, for each key
Query parameters
q*stringWhat to find, in a few words: connect stripe, approve a plan, routine time zone
At least 2 characters · At most 200 characters
limitintegerAt most 10
Default 6 · At least 1 · At most 10
Response
200 · application/jsondata*array<object>6 properties
slug*stringtitle*stringsection*string | nullThe heading of the part that fits, or null for the start of the guide
anchor*string | nullThe anchor of that part, for GET /guide
snippet*stringSome words of the part, round the words that fit
url*stringThe address of the part on troopy.ai/docs, to give a person
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.
429 rate_limitedWait the number of seconds in Retry-After, then retry.