Captures

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

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
offsetintegerOptional
statusenumOptional
Allowed values:
idsstringOptional

Comma-separated source ids for a targeted lookup (e.g. resolving a page’s source refs regardless of age)

Response

itemslist of objects
The ingest sources on this page of results.
totalinteger

Total sources matching the filter (ignores pagination)

limitinteger
Applied page size
offsetinteger
Applied offset

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error