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.
Developer Overview
AUVY Synapse is a multi-app monorepo. Durable product objects (resource heads, versions, document lane, search chunks) live on the unified resource spine in Mongo and related stores; the public docs explain how to use that model via/v1/browse, /v1/search, and /v1/resources. This page maps apps and packages for contributors.
The public docs focus on the external developer contract, but the repo also includes internal apps and packages that shape how those surfaces work.
Service map
| App | Purpose | Default port |
|---|---|---|
apps/web | Nuxt dashboard | 3000 |
apps/api | Public REST API and auth-aware platform routes | 3001 |
apps/agent-end | Background execution worker | 3002 |
apps/mcp | Hosted MCP server | 3003 |
apps/connect | Integration lifecycle and tool execution | 3004 |
apps/bots | Bot control plane + worker (not the Synapse API) | 3005 |
apps/docs | Mintlify docs site | 3000 (or next free) |
Package boundaries
| Package | Role | Public? |
|---|---|---|
@auvy-synapse/kernel | Shared env helpers, workspace/branding constants, pure utilities — imported from packages/kernel/src (no publish workflow for app imports) | N/A (monorepo-only; consumed like application code) |
@auvy-synapse/client | Public TypeScript SDK | Yes |
@auvy-synapse/connect-client | Typed HTTP client for Connect (/v1/integrations, OAuth apps); workspace-only package | No |
@auvy-synapse/private-client | Dashboard-only client for workspace APIs and Connect-backed integration routes | No |
@auvy-synapse/internal | Shared schemas, config, and utilities | No |
@auvy-synapse/auth | Shared request authentication and role checks | No |
Public developer surfaces
- REST API at
https://api.auvy.ai - TypeScript SDK via
@auvy-synapse/client - CLI via
@auvy-synapse/cli - MCP server at
https://mcp.auvy.ai/mcp - OpenAPI spec at
https://api.auvy.ai/openapi
Private and first-party surfaces
@auvy-synapse/private-clientis used by the dashboard and is not publishedresolveConnectPublicUrlFromEnv(Connect’s public base URL for OAuth and integration HTTP) lives in@auvy-synapse/kernel/config/connectPublicUrland is re-exported from@auvy-synapse/connect-clientfor callers that already depend on Connect types- Connect management routes are JWT-only and intentionally excluded from the public SDK
- Some SDK helpers under
backendexist for builders and first-party tooling, but they are not the same stability tier as the core CRUD namespaces
Data model split
AUVY uses two logical data planes:- Platform/Auth DB for workspaces, users, billing, API keys, integrations, and secrets
- Product DB for neurons, pathways, receptors, reflexes, document-lane resources, and execution data
Where to start
- Platform features — unified resource spine, then execution and tools
- Integrate the API if you are building against the platform
- TypeScript SDK if you are using JavaScript or TypeScript
- Local development if you are working in this repo
- Documentation site if you are editing
apps/docs/(Mintlify config, MDX, OpenAPI)