BrainAPI Ingest API

For the complete BrainAPI documentation index, see llms.txt. A markdown version of any docs page is available by appending .md to its URL. Docs MCP: /docs/mcp.

Ingest Data

Accept data for asynchronous ingestion.

Authorization

BrainPAT<token>

BrainAPI personal access token.

In: header

Header Parameters

X-Brain-ID?string

Preferred brain scope. Query/body/multipart fallbacks remain supported.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for the ingestion endpoint.

brain_id?Brain Id

The brain identifier to store the data in.

Default"default"

data*|

identification_params?|

The parameters used to identify the data.

meta_keys?|

The shared keys that should not be treated as nodes. (eg: email because each person has an email). The keys specified here will not be analyzed but just added to the metadata.

observate_for?array<string>|

What to look for and describe in the data during observation. If not provided, the observations will be generic

Default[]

preferred_extraction_entities?array<string>|

The entities that are preferred to be extracted from the data. If not provided, the extraction will be done on all the entities in the data.

Default[]

skip_enrichment?Skip Enrichment

Persist the text chunk and embedding only. Skip observations and knowledge-graph enrichment (Scout/Architect).

Defaultfalse

source_timestamp?|

Reference timestamp for the source content (e.g. session date). Used to resolve relative dates like 'yesterday' into absolute dates.

`application/json`

curl -X POST "https://example.com/ingest/" \  -H "Content-Type: application/json" \  -d '{    "data": {      "json_data": {}    }  }'

{  "message": "string",  "task_id": "string"}

Ingest File

Ingest a file into the processing pipeline and save to the memory.

Authorization

BrainPAT<token>

BrainAPI personal access token.

In: header

Header Parameters

X-Brain-ID?string

Preferred brain scope. Query/body/multipart fallbacks remain supported.

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file*File

`application/json`

curl -X POST "https://example.com/ingest/file" \  -F file="string"

{  "message": "string",  "task_id": "string"}

Ingest Structured Data

Accept structured data for asynchronous ingestion.

Authorization

BrainPAT<token>

BrainAPI personal access token.

In: header

Header Parameters

X-Brain-ID?string

Preferred brain scope. Query/body/multipart fallbacks remain supported.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for the structured ingestion endpoint.

anchor?|

The related information to connect the structured data to.

brain_id?Brain Id

The brain identifier to store the data in.

Default"default"

data*array<>

The list of event-centric information triples to ingest.

mode?|

Ingest mode. deterministic: no LLM (triples only; UUID anchor or exact name+type match). hybrid: persist submitted triples then optionally enrich from text. enrich: same as hybrid with LLM backfill. When omitted, inferred as hybrid if text is set else deterministic.

text?|

Additional text context for the structured data.

Response Body

`application/json`

curl -X POST "https://example.com/ingest/structured" \  -H "Content-Type: application/json" \  -d '{    "data": [      {        "object": {          "name": "string",          "type": "string"        }      }    ]  }'

{  "message": "string",  "task_id": "string"}

BrainAPI Ingest API

202application/json

400application/json

401application/json

403application/json

404application/json

405application/json

406application/json

422application/json

429application/json

500application/json

503application/json

202application/json

400application/json

401application/json

403application/json

404application/json

405application/json

406application/json

422application/json

429application/json

500application/json

503application/json

202application/json

400application/json

401application/json

403application/json

404application/json

405application/json

406application/json

422application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`