AUVY Docs

Run neurons (agents), pathways (workflows), and receptors (triggers) in your workspace. Store assets and artifacts, browse and search catalog data, and follow jobs and traces for long-running work. Start with the TypeScript SDK (@auvy-synapse/client). Use MCP or the CLI for assistants and scripts; use HTTP when you need a non-TypeScript stack.

AI agents: start with Build with AI, agent-onboarding/SKILL.md, and llms.txt before calling the API.

Quick start

Get an API key

cortex.auvy.ai → Admin → API keys → Create API Key.

Install the SDK

npm install @auvy-synapse/client
export AUVY_API_KEY=ak_live_...

First invoke

import { fromApiKey } from '@auvy-synapse/client'
const auvy = await fromApiKey()
const { receptor } = await auvy.receptors.get(auvy.workspaceSlug!, 'support-bot')
const { job_id } = await auvy.receptors.fire(receptor.id, { message: 'Hello' })

Pick your path: First API call · First SDK call · First CLI & MCP · Integrate the API.

Choose your surface

Surface	Best for	Docs
TypeScript SDK	Node, Bun, browser — typed helpers (recommended)	SDK introduction
MCP	Cursor, Claude Desktop, ChatGPT	MCP server
CLI	Terminal scripts, JSON automation	CLI
HTTP	Non-TypeScript stacks	API reference

Credential	Use
API key	Backend, cron, CLI, MCP
Publishable key + JWT	Browser apps
Share token (`?t=...`)	Public receptor/trace links

Details: Authentication.

Common goals

Goal	Start here
Method names for agents	SDK source of truth
Invoke + stream + errors	Jobs, streaming, and errors
Browse / search catalog	`auvy.resources` — Resources API
OAuth integrations	Connect SDK
Neuron scope (`core` / `workspace` / `brain`)	Neurons — Scope

Product nouns

Noun	Role
Neuron	Configurable agent (model, tools, memory)
Pathway	Workflow graph
Receptor	Trigger that dispatches a neuron or pathway
Job	Async run — poll or stream via `job_id`

Long-running invoke returns a job_id. Server automation uses an API key; browser apps use publishable key + JWT.

Quickstart

Minimal Node.js example: Quickstart.

Machine-readable docs

Asset	URL
Curated index	llms.txt
Agent skill	agent-onboarding/SKILL.md
OpenAPI	openapi.json

​AUVY Docs

​Quick start

​Choose your surface

​Common goals

​Product nouns

​Quickstart

​Machine-readable docs