Skip to main content

​
Core HTTP reference

Prefer the TypeScript SDK — SDK introduction and source of truth cover the same surface with typed helpers. Use this hub for curl, other languages, or debugging.
The API base URL is https://api.auvy.ai (/v1/...). JSON request and response bodies; standard HTTP status codes. Walkthrough: Integrate the API.

​
Authentication

CredentialHeader / paramUse case
API keyAuthorization: Bearer ak_live_...Server, CLI, scripts
Share token?t=... or body fieldPublic receptor and trace flows
JWT-only routes (API keys management, session bootstrap, MCP toolkit admin) are not in the published OpenAPI file — use the Cortex dashboard with a signed-in user. Issue API keys under Admin → API keys. 
import { fromApiKey } from '@auvy-synapse/client'
const auvy = await fromApiKey(process.env.AUVY_API_KEY!)

​
Resources vs invoke routes

PatternPurposeDocs
ResourcesCatalog lists, trees, browse, searchResources
Assets & artifactsFile and text ingest, versionsAssets and Artifacts
InvokeReceptors, neurons, pathways, jobsReceptors, Neurons, Pathways, Jobs

​
Errors

{ "message": "Human-readable error", "code": "ERROR_CODE" }
CodeStatusRetryable
AUTH_REQUIRED401No
FORBIDDEN403No
NOT_FOUND404No
VALIDATION_ERROR400No
RATE_LIMIT429Yes
INTERNAL_SERVER_ERROR5xxYes
See Jobs, streaming, and errors.

​
Pagination

List endpoints accept limit and offset. The SDK provides paginate() helpers — SDK resources.

​
Streaming

Invoke with stream: true, then GET /v1/jobs/:jobId/stream (SSE). See Jobs, streaming, and errors.

​
Health

GET /v1/health (or GET /health) returns service status. With an API key, the response includes workspace context when available: 
const health = await auvy.health.check()
Unauthenticated checks return { "status": "healthy", "version": "..." }. fromApiKey() uses GET /v1/session/context for bootstrap, not health.

​
OpenAPI

openapi.json — OpenAPI 3.1 subset aligned with @auvy-synapse/client (no dashboard-only or internal routes).

​
Core endpoints (this reference)

Receptors

Triggers and share links.

Neurons

Agents: CRUD and invoke.

Pathways

Workflows: CRUD and execute.

Reflexes

Tool bundles.

Jobs

Status, stream, cancel, input.

Traces

Conversation threads and messages.

Public

Share-token flows.

Resources

Catalog, browse, search, trees.

Assets and Artifacts

Files and editable documents.
Skills, interventions, voice, meetings, usage, and other advanced HTTP topics are covered on the SDK resources page or via SDK namespaces — not duplicated in this slim reference.