> 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.

# List ingest sources

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

List ingest sources for a brain, optionally filtered by processing status. Use this to surface an ingestion queue or to find sources that failed to compile.

Reference: https://docs.livingbrain.com/api-reference/captures/list-sources

## 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

### Query parameters

- `limit` (integer, optional)
- `offset` (integer, optional)
- `status` (enum, optional)
  - Allowed values: `pending`, `compiling`, `completed`, `failed`
- `ids` (string, optional) — Comma-separated source ids for a targeted lookup (e.g. resolving a page’s source refs regardless of age)

## Response

### 200

- `items` (list of BrainIngestSourceDto, required) — The ingest sources on this page of results.
- `total` (integer, required) — Total sources matching the filter (ignores pagination)
- `limit` (integer, required) — Applied page size
- `offset` (integer, required) — Applied offset

## Errors

### 400 Bad Request Error

Validation failed (e.g. neither/both of `content` and `fetchUrl`)

- `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 or source 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

### 429 Too Many Requests Error

Caller rate limit exceeded

- `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

### BrainIngestSourceDto

- `id` (string, required) — Ingest source id
- `tenantId` (string, required) — Owning tenant id
- `subjectId` (string, required) — Owning subject id (host-defined)
- `brainId` (string, required) — Owning brain id
- `source` (BrainSourceDto, required, nullable) — Opaque provenance
- `kind` (enum, required) — Kind of raw input
  - Allowed values: `note`, `file`, `url`, `transcript`, `chat_turn`, `integration`
- `bucket` (enum, required) — Bucket hint for the resulting page(s)
  - Allowed values: `inbox`, `notes`, `ideas`, `projects`
- `label` (string, required) — Short display label
- `content` (string, required, nullable) — Extracted text; null for `fetchUrl` sources not yet extracted
- `originRef` (string, required, nullable) — Origin URL / external id, also the idempotency key for dedup
- `metadata` (BrainIngestSourceDtoMetadata, required, nullable) — Extraction hints (e.g. mimeType, fileName)
- `chunkUuids` (list of string, required) — Knowledge chunk uuids backing this source
- `status` (enum, required) — Compile pipeline status
  - Allowed values: `pending`, `compiling`, `completed`, `failed`
- `originalBytes` (integer, required, nullable) — Original file/note bytes counted toward account storage
- `lastError` (string, required, nullable) — Last compile error, if any
- `affectedPageIds` (list of string, required) — Ids of pages this source contributed to
- `attempts` (integer, required) — Compile attempts so far
- `compiledAt` (datetime, required, nullable) — When the compile completed
- `createdAt` (datetime, required) — ISO 8601 timestamp of when this record was created.
- `updatedAt` (datetime, required) — ISO 8601 timestamp of when this record was last modified.

### ErrorResDtoBody

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

### BrainSourceDto

- `channel` (string, required) — Provenance channel
- `ref` (string, optional, nullable) — Opaque host reference (e.g. agent id)
- `label` (string, optional, nullable) — Human-readable provenance label

### BrainIngestSourceDtoMetadata

Extraction hints (e.g. mimeType, fileName)

## Examples

**Response**

```json
{
  "items": [
    {
      "id": "string",
      "tenantId": "string",
      "subjectId": "string",
      "brainId": "string",
      "source": {
        "channel": "chat",
        "ref": "string",
        "label": "via Sales Agent"
      },
      "kind": "note",
      "bucket": "inbox",
      "label": "string",
      "content": "string",
      "originRef": "string",
      "metadata": {},
      "chunkUuids": [
        "string"
      ],
      "status": "pending",
      "originalBytes": 1,
      "lastError": "string",
      "affectedPageIds": [
        "string"
      ],
      "attempts": 1,
      "compiledAt": "2024-01-15T09:30:00Z",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}
```

**SDK Code**

```python
import requests

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

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

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

print(response.json())
```

```javascript
const url = 'https://api.livingbrain.com/v1/brains/brainId/sources';
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/sources"

	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/sources")

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/sources")
  .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/sources', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.livingbrain.com/v1/brains/brainId/sources");
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/sources")! 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()
```