Workspace

Prompt index

Return a compact index of the brain's top pages, formatted for injection into an LLM prompt. This is the intended way to give an agent working context without sending the whole brain.

Authentication

x-api-keystring

Your Living Brain API key. Create one from the dashboard; keys are scoped to an organization and carry the role of the member they were issued to.

Path parameters

brainIdstringRequired
Brain id

Headers

x-subject-idstringRequired
Identifies the end user the request is made on behalf of. Brains are owned by a subject, so this determines which brains the caller can see.

Query parameters

limitintegerOptional

Response

slugstring

URL-safe identifier, unique within the brain.

titlestring

Human-readable title.

summarystring
Summary truncated to 160 chars
pageTypeenum
What kind of knowledge this page holds.
pinnedboolean
Pinned entries are placed first in the prompt index.
statusenum
Lifecycle state. Deprecated and archived items are hidden from listings by default.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error