Skip to main content

​
SDK Resources

TypeScript layout: (1) auvy.resources — browse, search, patchCentral, catalog symmetry. (2) auvy.resourceStore — assets and artifacts. (3) neurons, pathways, reflexes, receptors — vertical CRUD and invoke. Most namespaces map directly to documented REST endpoints; backend and v1 exist for advanced or escape-hatch calls.

​
Stable resource clients

NamespacePurposeReference
resourcesUnified browse, search, and central patch/api-reference/resources
resourceStoreAssets, artifacts, ingest, chunks, versions/api-reference/assets-artifacts
neuronsCreate and update agents (model, memory, tools, scope)/api-reference/neurons
pathwaysManage and execute visual workflows/api-reference/pathways
reflexesManage tool collections and execution bindings/api-reference/reflexes
receptorsGateway: list, share, and invoke neurons/pathways/api-reference/receptors
receptorChannelBindingsSlack/Teams/email channel bindings to receptors/api-reference/receptors
jobsExecute async work, inspect status, stream progress/api-reference/jobs
tracesInspect conversation threads and add messages/api-reference/traces
skillsBrain-scoped markdown skillssource of truth
interventionsHuman-in-the-loop flowssource of truth
browseCatalog list and resource trees (resources.browse preferred)/api-reference/resources
searchsearchSemantic, grepSemantic (resources.search preferred)/api-reference/resources
chatDocument OCR helpers (multipart upload)/api-reference/resources
publicShare-token receptor and trace flows/api-reference/public
healthLiveness and workspace context/api-reference/introduction
configModel and embedding configurationsource of truth

​
Advanced helpers

These namespaces are exposed publicly but are closer to first-party tooling than the core REST contract:
NamespaceIncludesNotes
backendvalidatePathway, compilePathway, getNeuronCards, raw tools metadataUseful for builders and advanced tooling. Chat runs use neurons.invoke; pathway runs use pathways.execute.
v1get, post, put, patch, delete helpers under /v1/*Escape hatch for new endpoints before a typed namespace is added.

​
Streaming helpers

These package-level exports are part of the intended SDK surface: 
import {
  createAUVYClient,
  createStream,
  isTokenChunk,
  isErrorChunk,
} from '@auvy-synapse/client'
Use them when you want token streaming without managing raw SSE yourself.

​
Pagination helpers

Every list-style namespace exposes either paginate(), listAll(), or both. 
for await (const receptor of auvy.receptors.paginate({ pageSize: 20 })) {
  console.log(receptor.slug)
}

​
Contract boundaries

  • @auvy-synapse/client is the public npm package for Synapse integrators.
  • Integration OAuth and tool catalogs live on Connect — see Connect SDK.