SDK Resources
Resource namespaces, advanced helpers, and contract boundaries for @auvy-os/client.
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
| Namespace | Purpose | Reference |
|---|---|---|
resources | Unified browse, search, and central patch | /api/resources |
resourceStore | Assets, artifacts, ingest, chunks, versions | /api/assets-artifacts |
neurons | Create and update agents (model, memory, tools, scope) | /api/neurons |
pathways | Manage and execute visual workflows | /api/pathways |
reflexes | Manage tool collections and execution bindings | /api/resources |
receptors | Gateway: list, share, and invoke neurons/pathways | /api/receptors |
receptorChannelBindings | Slack/Teams/email channel bindings to receptors | /api/receptors |
jobs | Execute async work, inspect status, stream progress | /api/jobs |
traces | Inspect conversation threads and add messages | /api/traces |
skills | Brain-scoped markdown skills | source of truth |
interventions | Human-in-the-loop flows | source of truth |
browse | Catalog list and resource trees (resources.browse preferred) | /api/resources |
search | searchSemantic, grepSemantic (resources.search preferred) | /api/resources |
chat | Document OCR helpers (multipart upload) | /api/resources |
public | Share-token receptor and trace flows | /api/public |
health | Liveness and workspace context | /api/introduction |
config | Model and embedding configuration | source of truth |
Advanced helpers
These namespaces are exposed publicly but are closer to first-party tooling than the core REST contract:
| Namespace | Includes | Notes |
|---|---|---|
backend | validatePathway, compilePathway, getNeuronCards, raw tools metadata | Useful for builders and advanced tooling. Chat runs use neurons.invoke; pathway runs use pathways.execute. |
v1 | get, 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-os/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-os/clientis the public npm package for AUVY OS integrators.- Integration OAuth and tool catalogs live on Connect — see Connect SDK.
Related
- TypeScript SDK for installation and auth setup
- API Reference for REST details
- Introduction — surfaces and repos