Synapse developer interface

Map of credentials, execution surfaces (REST, SDK, CLI, MCP), Connect integrations, and what the public OpenAPI spec covers.

Synapse developer interface

The developer interface is how you build on AUVY Synapse outside the dashboard: issue credentials in Cortex, then call the platform through one or more execution surfaces. This page is the one-page map; Integrate the API is the step-by-step onboarding walkthrough.

1. Credentials (Cortex dashboard)

1. Sign up or sign in at cortex.auvy.ai.
2. Open Workspace Settings → API Keys (direct link).
3. Click Create API Key and copy the value immediately — it is shown only once.

Send server-side and automation traffic as:

Authorization: Bearer ak_live_...

Browser apps use a publishable key plus the signed-in user JWT, not a long-lived API key in frontend code. See Authentication.

2. Execution surfaces

Pick the surface that matches where your code runs:

Surface	Best for	Docs
REST API	Any language, curl, generated clients	API Reference, Integrate the API
TypeScript SDK	Node, Bun, browser with typed helpers and streaming	SDK introduction
CLI	Terminal workflows, scripts, discovery for LLMs	CLI introduction
MCP server	Cursor, Claude Desktop, ChatGPT, other MCP clients	MCP introduction

All four use the same product API at https://api.auvy.ai/v1 (override AUVY_API_URL for self-hosted stacks).

REST

curl https://api.auvy.ai/v1/receptors \
  -H "Authorization: Bearer YOUR_API_KEY"

SDK

import { fromApiKey } from '@auvy-synapse/client'
const auvy = await fromApiKey(process.env.AUVY_API_KEY!)

CLI

auvy login --api-key ak_live_...
auvy receptors list --output json

MCP

{
  "mcpServers": {
    "auvy": {
      "url": "https://mcp.auvy.ai/mcp",
      "headers": { "Authorization": "Bearer ak_live_..." }
    }
  }
}

3. Product nouns: Neuron, Pathway, Trigger

Synapse separates what runs from what starts it:

Noun	Role	Typical API
Neuron	Agentic execution (LLM + tools)	GET/POST /v1/neurons, GET /v1/resources/neurons/:id
Pathway	Deterministic graph execution	GET/POST /v1/pathways, POST /v1/pathways/:id (run)
Trigger	Durable automation entry (schedule, webhook, chat, manual, …) pointing at a neuron or pathway	GET/POST /v1/triggers, vault GET /v1/resources/triggers/:id

The Automations hub (GET /v1/automations/graph) lists trigger resources only. New automations should create triggers via POST /v1/triggers, not receptor-first flows. Receptors remain for legacy Connect ingress and share links; Connect delivery may include trigger_resource_id to resolve the spine row before dispatch.

4. Connect (managed integrations)

Connect is an optional fifth path for OAuth integrations, Composio toolkits, and custom OpenAPI HTTP APIs. It runs on a separate service (AUVY_CONNECT_URL); Synapse /v1/integrations routes return 410 — use the dashboard Connect module or Connect HTTP APIs with a user session, not an API key alone.

Typical flows:

• Link Slack, Microsoft Graph, or other connectors from the dashboard.
• Register a custom OpenAPI URL for tools your neurons and reflexes can call.
• MCP clients may expose integration tools via connect_execute when your workspace MCP toolkit allowlist includes them.

Connect is session/JWT-oriented for management; execution from agents goes through Connect from agent-end. Self-hosted operators document Connect in the repo docs/CONNECT.md; hosted Cortex behaves the same.

5. OpenAPI and live reference

The published OpenAPI 3.1 document describes the public integrator contract (API key and share-token routes):

• Interactive: api.auvy.ai/docs (Scalar)
• JSON: api.auvy.ai/openapi and docs.auvy.ai/openapi.json

Dashboard and session routes are intentionally not in the public OpenAPI snapshot: for example /v1/api-keys, /v1/session/context, /v1/session/boot, and /v1/mcp-toolkits. Those require a signed-in dashboard user (Supabase JWT). Create API keys in Workspace Settings → API Keys; configure MCP toolkits under Auvy Admin → MCP toolkits (platform admin).

For the full route table including dashboard-only paths, see apps/api/README.md in the monorepo.

6. Auth matrix (quick)

Environment	Credential
Backend, cron, CLI	API key (ak_live_...)
Browser dashboard / embedded UI	Publishable key + user JWT
Public receptor or trace share	Share token (?t=...)
MCP (assistants)	OAuth or API key header
Connect integration setup	User session (dashboard)

Full detail: Authentication.

Recommended path

1. Read this map

   Choose REST, SDK, CLI, or MCP (and Connect if you need external tools).

2. Follow Integrate the API

   Integrate the API — first request, invoke, errors, streaming.

3. Go deep on your surface

   API Reference, SDK, CLI, or MCP tab for exhaustive reference.

Contributors vs integrators

You are…	Start here
Building on Synapse (API key, ship an integration)	This page → Integrate the API
Contributing to the monorepo	Mintlify Contributing tab → Contributor overview

Next steps

• Integrate the API — canonical onboarding
• Authentication — credential types
• Platform features — spine, execution, tools
• API Reference — REST endpoints