API reference / Account
Read a Troopy guide
Reads one guide of troopy.ai/docs as markdown: the whole guide, or one part of it with the parts under it. Name the part by its anchor, from GET /guides or from sections. A text of more than 5,000 characters stops there, and cut is true: read it one part at a time.
get
/api/v1/guideOther ways to call it
CLI
troopy guides readMCP tool
troopy_read_guideRate limit60 calls in 60 seconds, for each key
Query parameters
slug*stringThe guide, as GET /guides names it: get-started, apps/stripe
sectionstringThe anchor of one part, from GET /guides or from sections. Leave it out to read the whole guide
Response
200 · application/jsondata*object7 properties
slug*stringtitle*stringsummary*stringurl*stringThe address on troopy.ai/docs, to give a person
sections*array<object>The parts of the guide, to read one at a time
2 properties
anchor*stringheading*stringtext*stringThe markdown of the guide, or of the part
cut*booleanThe text stops before its end. Read one part at a 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.
429 rate_limitedWait the number of seconds in Retry-After, then retry.