Captures

Push a capture

Push a single item into a brain for ingestion. Accepts notes, URLs, raw text, chat transcripts, and PDF/DOCX/PPTX documents. Capture is asynchronous: this returns an ingest source whose status you can poll or receive via webhook.

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.

Request

This endpoint expects an object.
kindenumRequired
Kind of raw input
contentstringOptional
Raw textual content of the capture
fetchUrlstringOptional

URL the service fetches and extracts instead of inlined content. Extraction is driven by kind: file -> parse PDF, Word, PPTX, HTML, or UTF-8 text; url -> scrape web page; transcript -> transcribe audio. Legacy .ppt and other unsupported binary formats are rejected. No cloud credentials needed.

mimeTypestringOptional

MIME type hint for fetchUrl extraction (for example application/vnd.openxmlformats-officedocument.presentationml.presentation)

fileNamestringOptional

Original filename hint for fetchUrl extraction, including its extension

labelstringOptional

Short title / filename / URL for display

originRefstring or nullOptional

Origin URL / external id, also used as the idempotency key for dedup

bucketenumOptional

Bucket hint for the resulting page(s)

sourceobjectOptional
Opaque provenance

Response

idstring
Ingest source id
tenantIdstring
Owning tenant id
subjectIdstring

Owning subject id (host-defined)

brainIdstring
Owning brain id
sourceobject or null
Opaque provenance
kindenum
Kind of raw input
bucketenum

Bucket hint for the resulting page(s)

labelstring
Short display label
contentstring or null

Extracted text; null for fetchUrl sources not yet extracted

originRefstring or null

Origin URL / external id, also the idempotency key for dedup

metadataobject or null

Extraction hints (e.g. mimeType, fileName)

chunkUuidslist of strings
Knowledge chunk uuids backing this source
statusenum
Compile pipeline status
lastErrorstring or null
Last compile error, if any
affectedPageIdslist of strings
Ids of pages this source contributed to
attemptsinteger
Compile attempts so far
compiledAtdatetime or null
When the compile completed
createdAtdatetime
ISO 8601 timestamp of when this record was created.
updatedAtdatetime
ISO 8601 timestamp of when this record was last modified.

Errors

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