Skip to main content

​
SDK Resources

The public SDK is organized into resource namespaces. Most map directly to documented REST endpoints; a smaller set exists to support advanced first-party workflows.

​
Stable resource clients

NamespacePurposeReference
receptorsList, resolve, share, and invoke public entry points/api-reference/receptors
jobsExecute async work, inspect status, stream progress, transcribe audio/api-reference/jobs
memoriesCreate, ingest, update, and search memory records/api-reference/memories
tracesInspect conversation threads and add messages/api-reference/traces
neuronsManage AI workers and execution config/api-reference/neurons
pathwaysManage and execute visual workflows/api-reference/pathways
reflexesManage tool collections and execution bindings/api-reference/reflexes
recollectionsManage memory scopes for traces and owners/api-reference/recollections
searchSemantic search over indexed resources/api-reference/search
usageUsage and billing visibility/api-reference/usage
activityWorkspace activity feed and engrams/api-reference/activity
publicShare-token based receptor and trace flows/api-reference/public
healthLiveness and authenticated workspace context/api-reference/health
configModel catalog, embedding config, and cost estimates/api-reference/config
stakeholderMapStakeholder graph snapshots, briefings, and versions/api-reference/stakeholder-map

​
Advanced helpers

These namespaces are exposed publicly but are closer to first-party tooling than the core REST contract:
NamespaceIncludesNotes
backendvalidatePathway, compilePathway, getNeuronCards, chatCompletion, chatNeuron, raw tools metadataUseful for builders and internal tooling. Some helpers front endpoints that may evolve faster than the core resource CRUD surfaces.
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 package and is appropriate for product integrations.
  • @auvy-synapse/private-client is dashboard-only and not published to npm.
  • JWT-only workspace integration management is intentionally outside this API-key-focused docs set.