Authentication
Choose the right credential for the public API, client, CLI, and MCP server.
Authentication
Choose the auth method that matches where your code runs.
Recommended by Environment
| Environment | Recommended auth |
|---|---|
| Backend service or server action | API key |
| Browser app | Publishable key plus user JWT |
| Shared/public receptor flow | Share token |
| CLI | API key stored in encrypted local config |
| MCP client | OAuth if supported, otherwise API key header |
CLI Authentication
auvy login --api-key ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
auvy config show
auvy config set workspace-slug your-workspaceSaved CLI config lives in ~/.auvy/config.encrypted. If it is missing, the CLI falls back to environment variables such as AUVY_API_URL, AUVY_API_KEY, AUVY_WORKSPACE_SLUG, NUXT_PUBLIC_AUVY_WORKSPACE_SLUG, and AUVY_BRAIN_ID.
API Keys
Use API keys for backend services, local scripts, cron jobs, and CLI usage.
export AUVY_API_KEY=YOUR_API_KEYBrowser Auth
Use a publishable key plus the current user JWT in browser apps.
MCP Authentication
Use OAuth when the client supports interactive login. Otherwise send an API-key header to https://mcp.auvy.ai/mcp.
Next Steps
- Integrate the API for the canonical REST and client walkthrough.
- MCP server for assistant connection flows.