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.
Choose a package
Use this page when you know what you want to build but not which import path to use.
By workflow
| I want to… | Package | Entry | Credential |
|---|
| Invoke receptors / neurons from a backend | @auvy-synapse/client | fromApiKey() | API key |
| Browse assets, search the vault, run jobs | @auvy-synapse/client | fromApiKey() | API key |
| Stream job tokens from a server script | @auvy-synapse/client | auvy.jobs + streaming | API key |
| Embed Synapse in a browser app | @auvy-synapse/client | createAUVYClient({ publishableKey, getAccessToken }) | Publishable key + JWT |
| Show an integration catalog and OAuth link | @auvy-synapse/connect-client | connectFromSession() | Publishable key + JWT |
| Manage triggers / credentials / OAuth apps | @auvy-synapse/connect-client/advanced | createAUVYConnectClient() | Publishable key + JWT |
| Execute a Connect tool from agent-end or API | @auvy-synapse/connect-client/server | connectRunTool() | Internal secret |
By credential
| Credential | Where to get it | Packages |
|---|
| API key | Cortex → Workspace Settings → API Keys | @auvy-synapse/client |
| Publishable key | Cortex workspace settings (browser) | @auvy-synapse/client, @auvy-synapse/connect-client |
| User JWT | Your auth provider (Supabase session in dashboard) | Browser entries above |
| Share token | Receptor/trace share links | @auvy-synapse/client (public.*, stream options) |
| Connect internal secret | Operator env on API/agent-end | @auvy-synapse/connect-client/server |
Synapse API vs Connect
| Service | Base URL env | Integrations CRUD |
|---|
| Synapse API | AUVY_API_URL | Returns 410 — do not use |
| Connect | AUVY_CONNECT_URL | GET/POST /v1/integrations |
Common combinations
Backend automation (no Connect UI)
npm install @auvy-synapse/client
const auvy = await fromApiKey()
await auvy.receptors.invoke(workspaceSlug, 'support-bot', { message: 'Hello' })
Full-stack app with OAuth integrations
npm install @auvy-synapse/client @auvy-synapse/connect-client
- Product features →
fromApiKey() or browser createAUVYClient()
- Integration picker + OAuth →
connectFromSession()
Self-hosted operator stack
- Set
AUVY_API_URL, AUVY_CONNECT_URL, and secrets per docs/SETUP.md in the monorepo
- Workers use
connectRunTool() with AUVY_CONNECT_INTERNAL_SECRET
Not on npm
| Package | Use |
|---|
@auvy-synapse/private-client | AUVY dashboard only |
| Monorepo server packages | Server-only — never import from browser integrator apps |