Documentation Index
Fetch the complete documentation index at: https://docs.auvy.ai/llms.txt
Use this file to discover all available pages before exploring further.
Recollections API
Recollections group document-lane resources (for example assets) for neurons and traces, scoped for context and retrieval.
List Recollections
Get a list of recollections.
Brain scope required. Include the X-Brain-Id header or configure getBrainId in the public client.
| Header | Type | Description |
|---|
X-Brain-Id | string (UUID) | Required. Brain ID for scoping |
Query Parameters
| Parameter | Type | Description |
|---|
limit | number | Maximum number of results (default: 20) |
offset | number | Offset for pagination |
Get Recollection
Get a single recollection by ID.
GET /v1/recollections/:id
Path Parameters
| Parameter | Type | Description |
|---|
id | string | Recollection UUID |
Get Recollection Stats
Get memory (asset) count, chunk count, and embedding-lane lexical RAG row count (resource_chunks, kind rag_embedding) for a recollection.
GET /v1/recollections/:id/stats
Path Parameters
| Parameter | Type | Description |
|---|
id | string | Recollection UUID |
Response
| Field | Type | Description |
|---|
resource_count | number | Assets in the recollection after brain filter |
chunk_count | number | Chunk link rows across those assets |
embedding_lane_chunk_row_count | number | Rows in resource_chunks with kind rag_embedding (embedding-aligned lexical index for hybrid/fulltext RAG) |
Search Recollections
Search within recollections by owner. Supports semantic (vector), keyword (fulltext), or hybrid strategy.
Brain scope required. Include the X-Brain-Id header or brain_id in the request body.
POST /v1/recollections/search
| Header | Type | Description |
|---|
X-Brain-Id | string (UUID) | Required. Brain ID for scoping |
Request Body
| Field | Type | Required | Description |
|---|
query | string | Yes | Search query |
owner_type | string | Yes | Owner type (e.g. neuron, trace) |
owner_ids | string[] | Yes | Owner UUIDs to scope search |
limit | number | No | Max results (default: 10, max: 100) |
threshold | number | No | Score threshold for vector strategy (default: 0.7) |
strategy | string | No | vector (default), qdrant (synonym for vector), fulltext, or hybrid. fulltext uses keyword search over the indexed corpus; hybrid merges vector and keyword with RRF. |
context | string | No | Filter recollections by context (project or context metadata). |
neuron_id | string | No | Filter recollections by neuron UUID. |
project | string | No | Filter recollections by project metadata. |
trace_id | string | No | Scope search to a trace’s recollection (owner_type= trace when owner_ids empty). |
tags | string[] | No | Filter recollections by tags (must match all). |
Create Recollection
Create a new recollection.
Request Body
| Field | Type | Required | Description |
|---|
name | string | Yes | Recollection name |
description | string | No | Recollection description |
Update Recollection
Update an existing recollection.
PUT /v1/recollections/:id
Delete Recollection
Delete a recollection.
DELETE /v1/recollections/:id
- Neurons API - Use recollections in neuron configurations
- Assets and Artifacts API - Ingest and attach document-lane rows to recollections
- Search - Hybrid search over resources (scoped recollections use this API’s own search)