Skip to main content

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.

​
Browse

Browse is list-only discovery. It has no substring pattern and returns the same result shape as POST /v1/browse list mode (with optional full_heads). 
GET /v1/browse?type=neurons
POST /v1/browse
POST /v1/browse/resource-tree
For type/pattern keyword or hybrid search use Search (POST /v1/search). For async multi-type jobs use GET /v1/search.

​
List by Type

FieldTypeRequiredDescription
typestringYesOne of: assets, artifacts, stakeholder_maps, meetings, receptors, pathways, neurons, reflexes.
curl -G https://api.auvy.ai/v1/browse \
  --data-urlencode "type=artifacts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Brain-Id: YOUR_BRAIN_ID"

const artifacts = await auvy.resources.browse.list({ type: 'artifacts' })

​
Resource Tree

The resource tree is the Vault browse payload: native folder structure plus indexed resource heads in one response. 
const root = await auvy.resources.browse.resourceTree({ parent_key: '/' })

const batch = await auvy.resources.browse.resourceTreeBatch({
  parent_keys: ['/Policies', '/Meetings'],
})
Use Resources for the full tree contract, pagination, batch mode, and live mutation events.
  • Resources — resource catalog, tree, move, events
  • Search — hybrid type/pattern search (/v1/search)