Skip to main content

​
AUVY Docs

AUVY exposes one public API surface and four practical ways to use it. This docs site focuses on the API-key and share-token controllable contract.
  • REST API
  • @auvy-synapse/client
  • CLI
  • MCP server

Integrate the API

Quick start and end-to-end: API key to production streaming.

Authentication

API key, browser, CLI, MCP, and Connect auth flows.

TypeScript SDK

Public client setup, auth modes, resources, and advanced helpers.

API Reference

Every endpoint, payload, response, and integration surface.

​
Choose Your Entry Point

REST API

Call https://api.auvy.ai/v1 directly from any language.

TypeScript Client

Use @auvy-synapse/client for typed requests, retries, and streaming helpers.

CLI

Script common workflows from the terminal with auvy.

MCP Server

Connect AUVY to Cursor, Claude Desktop, ChatGPT, and other MCP clients.

​
What You Need To Know

  • A receptor is the public invoke target.
  • Most examples use POST /v1/receptors/:workspace_slug/:slug/invoke.
  • Long-running execution returns a job_id, which you can poll or stream.
  • Server-side usage should use an API key.
  • Browser usage should use a publishable key plus a user JWT.
  • Shared/public receptor flows use a share token.
  • JWT-only workspace integration management is intentionally out of scope for this docs set.
1

Create an API key

Generate a key in the dashboard, then keep it server-side.
2

Make your first request

Start with curl or createAUVYClient.fromApiKey(...).
3

Add polling or streaming

Use the Jobs API or the client streaming helpers for long-running responses.
4

Add CLI, MCP, or Connect when needed

Use the CLI for scripts, the hosted MCP server for assistant workflows, and Connect when you need external integrations or account connections.

​
Next Steps

  1. Integrate the API for quick start and full walkthrough.
  2. Authentication to choose the right credential model.
  3. TypeScript SDK, CLI Reference, or MCP Server for your preferred integration surface.