Skip to main content

First SDK call

The TypeScript SDK is the recommended integrator surface. It mirrors the public HTTP API with typed namespaces and streaming helpers.

Install

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

Minimal 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 from the SDK',
})

console.log('job_id', job_id)

Wait or stream

// Poll until complete
const result = await auvy.jobs.wait(job_id)

// Or stream tokens (see jobs-and-streaming)
for await (const event of auvy.jobs.stream(job_id)) {
  console.log(event)
}

Packages

PackageUse
@auvy-synapse/clientPublic API — receptors, neurons, jobs, resources
@auvy-synapse/connect-clientOAuth integrations from browser sessions — Connect SDK

Agent-friendly reference

Coding agents should read SDK source of truth for version-pinned method names.

Next steps