> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.livingbrain.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.livingbrain.com/_mcp/server.

# Brain health score

GET https://api.livingbrain.com/v1/brains/{brainId}/score

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

Reference: https://docs.livingbrain.com/api-reference/workspace/get-score

## Authentication

- `x-api-key` header (required) — 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.

## Request

### Path parameters

- `brainId` (string, required) — Brain id

## Response

### 200

- `brainId` (string, required) — Identifier of the brain this belongs to.
- `freshness` (BrainScoreMetricDto, required) — How recently the brain's pages have been updated or referenced.
- `readiness` (BrainScoreMetricDto, required) — How complete and well-connected the brain is.
- `strain` (BrainScoreMetricDto, required) — Backlog pressure — unprocessed captures, contested pages, and unacknowledged changes.
- `computedAt` (string, required) — ISO timestamp

## Errors

### 400 Bad Request Error

Validation failed (e.g. empty title/body, slug already in use)

- `statusCode` (integer, required) — HTTP status code
- `timestamp` (string, required) — ISO timestamp of the failure
- `path` (string, required) — Request path (query string stripped)
- `message` (string, required) — Human-readable error message
- `body` (ErrorResDtoBody, optional) — Original framework exception response when available, e.g. `{ statusCode, message, error }` with per-field validation messages

### 401 Unauthorized Error

Unauthorized

- `statusCode` (integer, required) — HTTP status code
- `timestamp` (string, required) — ISO timestamp of the failure
- `path` (string, required) — Request path (query string stripped)
- `message` (string, required) — Human-readable error message
- `body` (ErrorResDtoBody, optional) — Original framework exception response when available, e.g. `{ statusCode, message, error }` with per-field validation messages

### 404 Not Found Error

Brain, page, change, or connection not found

- `statusCode` (integer, required) — HTTP status code
- `timestamp` (string, required) — ISO timestamp of the failure
- `path` (string, required) — Request path (query string stripped)
- `message` (string, required) — Human-readable error message
- `body` (ErrorResDtoBody, optional) — Original framework exception response when available, e.g. `{ statusCode, message, error }` with per-field validation messages

## Types

### BrainScoreMetricDto

- `key` (string, required) — Stable machine-readable identifier, safe to branch on in code.
- `label` (string, required) — Human-readable display name.
- `score` (double, required) — Score 0-100
- `status` (string, required) — Human-readable status label
- `summary` (string, required) — One-line explanation of what this metric captures.
- `higherIsBetter` (boolean, required) — Whether a larger value is an improvement. Drives arrow direction in trend UI.
- `factors` (list of BrainScoreFactorDto, required) — The individual factors that roll up into this metric.

### ErrorResDtoBody

Original framework exception response when available, e.g. `{ statusCode, message, error }` with per-field validation messages

### BrainScoreFactorDto

- `key` (string, required) — Stable machine-readable identifier, safe to branch on in code.
- `label` (string, required) — Human-readable display name.
- `description` (string, required) — Human-readable explanation of what this factor measures.
- `value` (double, required) — The factor's measured value.
- `unit` (string, required) — Unit the value is expressed in, for formatting.
- `tone` (enum, required) — Whether this value reads as good, neutral, or bad — use it to colour the UI.
  - Allowed values: `positive`, `neutral`, `negative`

## Examples

**Response**

```json
{
  "brainId": "string",
  "freshness": {
    "key": "freshness",
    "label": "string",
    "score": 1.1,
    "status": "string",
    "summary": "string",
    "higherIsBetter": true,
    "factors": [
      {
        "key": "string",
        "label": "string",
        "description": "string",
        "value": 1.1,
        "unit": "pages",
        "tone": "positive"
      }
    ]
  },
  "readiness": {
    "key": "freshness",
    "label": "string",
    "score": 1.1,
    "status": "string",
    "summary": "string",
    "higherIsBetter": true,
    "factors": [
      {
        "key": "string",
        "label": "string",
        "description": "string",
        "value": 1.1,
        "unit": "pages",
        "tone": "positive"
      }
    ]
  },
  "strain": {
    "key": "freshness",
    "label": "string",
    "score": 1.1,
    "status": "string",
    "summary": "string",
    "higherIsBetter": true,
    "factors": [
      {
        "key": "string",
        "label": "string",
        "description": "string",
        "value": 1.1,
        "unit": "pages",
        "tone": "positive"
      }
    ]
  },
  "computedAt": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.livingbrain.com/v1/brains/brainId/score"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.livingbrain.com/v1/brains/brainId/score';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.livingbrain.com/v1/brains/brainId/score"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.livingbrain.com/v1/brains/brainId/score")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.livingbrain.com/v1/brains/brainId/score")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.livingbrain.com/v1/brains/brainId/score', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.livingbrain.com/v1/brains/brainId/score");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.livingbrain.com/v1/brains/brainId/score")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```