API reference / Brain
Learn a website
Reads up to 25 pages of a website, starting at url and staying on its domain, and adds each to the brain as a source. The workspace's computer does the reading, so it must be launched. Answers 202 at once; poll statusUrl until status is done.
post
/api/v1/brain/importsOther ways to call it
CLI
troopy brain learnMCP tool
troopy_learn_websiteRate 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.Body
application/jsonurl*stringWhere to start, usually the home page
At most 2000 characters · uri
Response
202 · application/jsondata*object8 properties
id*stringA 24-character id
url*stringstatus*enum<string>running: poll statusUrl every few seconds
runningdonefailed
pages*integerPages the brain learned from the site
error*string | nullcreatedAt*stringISO 8601 date and time
finishedAt*string | nullstatusUrl*stringErrors
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.
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.