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.

​
SDK Resources

How to work with the spine in TypeScript: (1) auvy.resources — browse.list, browse.resourceTree, search.searchSemantic / search.search, patchCentral, and resources.neurons (catalog GETs, history, soft-delete, restore). (2) auvy.resourceStore — document lane list/get/ingest/chunks aligned with /v1/assets and /v1/artifacts. (3) Vertical clients — neurons, pathways, reflexes, receptors — for create/update, invoke, slug reads, and pathway execute when that HTTP shape fits best. 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, central patch, meetings vertical, synaptic SDK symmetry/api-reference/resources
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
jobsExecute async work, inspect status, stream progress, transcribe audio/api-reference/jobs
resourceStoreDocument lane: assets, artifacts, ingest, chunks, versions/api-reference/assets-artifacts
tracesInspect conversation threads and add messages/api-reference/traces
recollectionsKnowledge scopes for traces and owners (RAG retrieval)/api-reference/recollections
searchsearchSemantic (match-only POST /v1/search), grepSemantic (list/match + optional grep_keywords), async GET /v1/search/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

​
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.
  • The public Connect base URL (NUXT_PUBLIC_AUVY_CONNECT_URL / AUVY_CONNECT_URL) is implemented in @auvy-synapse/kernel/config/connectPublicUrl and re-exported from @auvy-synapse/connect-client for dashboard and service code that already imports Connect types.