Workspace

Brain health score

Return the brain's health score with its contributing factors and metrics. The score reflects coverage, freshness, and connectedness.

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.

Response

brainIdstring
Identifier of the brain this belongs to.
freshnessobject
How recently the brain's pages have been updated or referenced.
readinessobject

How complete and well-connected the brain is.

strainobject

Backlog pressure — unprocessed captures, contested pages, and unacknowledged changes.

computedAtstring
ISO timestamp

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error