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 surfaces
AUVY ships three npm packages for integrators. Pick the smallest surface that matches your runtime and credentials.
Package map
| Package | Import | Audience | Credential |
|---|
@auvy-synapse/client | fromApiKey(), createAUVYClient() | Servers, scripts, browser product UI | API key or publishable key + JWT |
@auvy-synapse/connect-client | connectFromSession() | Custom integration UI in browser | Publishable key + user JWT |
@auvy-synapse/connect-client/advanced | createAUVYConnectClient() | Dashboard builders, admin CRUD | Publishable key + JWT |
@auvy-synapse/connect-client/server | connectRunTool(), connectExecute() | API, agent-end, bots (S2S) | AUVY_CONNECT_INTERNAL_SECRET |
@auvy-synapse/kernel installs transitively with @auvy-synapse/client and @auvy-synapse/connect-client. Do not import the kernel package root from browser apps — use concrete subpaths only when you need shared types.
Synapse client (@auvy-synapse/client)
Primary entry: fromApiKey() — validates the key and bootstraps workspace context from GET /v1/session/context.
| Namespace | Use for |
|---|
resources | Browse, search, grep, catalog symmetry |
resourceStore | Assets and artifacts (document lane) |
receptors, neurons, pathways | Execution and CRUD |
jobs | Run lifecycle, streaming, provideInput |
traces | Thread reads and messages |
skills, interventions, voice | Brain skills, HITL, STT vocabulary |
Connect public vs advanced
| Need | Use |
|---|
| Catalog picker, OAuth link, connection status, tool list | connectFromSession() — Connect SDK |
| Triggers, credentials, OAuth apps, integration CRUD | connect.advanced or /advanced import — Connect advanced |
| Run a Connect tool from a worker | connectRunTool() on /server |
list, get, link, completeLink, status, tools, unlink.
Dashboard-only
The AUVY web dashboard uses @auvy-synapse/private-client (not on npm). It re-exports the Connect advanced surface as auvyPrivateClient.integrations plus session-only routes (API keys, billing, workspace admin).