AUVY

First SDK call

Install @auvy-os/client and invoke a neuron in TypeScript.

First SDK call

The TypeScript SDK is the recommended integrator surface. Execution is job-centric: neurons.invoke returns a job_id you stream or poll.

Install

npm install @auvy-os/client
export AUVY_API_KEY=ak_live_...
export AUVY_BRAIN_ID=your-participating-brain-uuid

Create the key in CortexAdmin → API keys. See Authentication for user-scoped keys and brain participation.

Setup (once)

import { fromApiKey } from '@auvy-os/client'

// Reuse one client for the process lifetime
export const auvy = await fromApiKey()

// One-time: list neurons in your brain and cache a UUID (env, config, or DB)
const neurons = await auvy.neurons.list({ brainId: process.env.AUVY_BRAIN_ID })
const neuronId = neurons[0]?.id
if (!neuronId) throw new Error('No neurons in brain')

Invoke (hot path)

const { job_id } = await auvy.neurons.invoke(neuronId, {
  message: 'Hello from the SDK',
  stream: true,
})

console.log('job_id', job_id)

Stream tokens

import { createStream, isTokenChunk } from '@auvy-os/client'

for await (const chunk of createStream(auvy, job_id)) {
  if (isTokenChunk(chunk) && chunk.token) {
    process.stdout.write(chunk.token)
  }
}

Poll status

const status = await auvy.jobs.getStatus(job_id, { lite: true })

Packages

PackageUse
@auvy-os/clientPublic API — neurons, pathways, jobs, resources
@auvy-os/connect-clientOAuth integrations — Connect SDK

Agent-friendly reference

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

Next steps

On this page