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.

Authentication

Choose the auth method that matches where your code runs.
EnvironmentRecommended auth
Backend service or server actionAPI key
Browser appPublishable key plus user JWT
Shared/public receptor flowShare token
CLIAPI key stored in encrypted local config
MCP clientOAuth if supported, otherwise API key header

CLI Authentication

auvy login --api-key ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
auvy config show
auvy config set workspace-slug your-workspace
Saved 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_KEY

Browser 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