Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Brain

Check a website import

Where a website import stands, and how many pages the brain learned from it.

get/api/v1/brain/imports/{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 brain import
MCP tooltroopy_get_brain_import
Rate limit120 calls in 60 seconds, for each key

Path parameters

id*string

A 24-character id

Response

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

A 24-character id

url*string
status*enum<string>

running: poll statusUrl every few seconds

runningdonefailed

pages*integer

Pages the brain learned from the site

error*string | null
createdAt*string

ISO 8601 date and time

finishedAt*string | null
statusUrl*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.
429 rate_limitedWait the number of seconds in Retry-After, then retry.