Package Exports
- @pyai/sdk
Readme
@pyai/sdk
Official TypeScript/JavaScript SDK for PyAI — the all-in-one voice AI platform: lightning-fast speech-to-text, ultra-realistic text-to-speech, end-to-end realtime voice agents, and automatic call compliance. Zero dependencies; runs in the browser and Node 18+.
PyAI products
- Hear — Lightning-fast, telephony-native speech-to-text. Whisper-compatible transcription tuned for real phone-call audio, with live streaming partials so your app reacts mid-sentence, plus async batch transcription for big archives.
POST /v1/audio/transcriptions - Speak — Ultra-realistic text-to-speech that starts speaking in tens of milliseconds. Stream lifelike, expressive voices, choose from 36 studio-quality presets, or clone any voice instantly — for free.
POST /v1/audio/speech - Omni (flagship) — One API for a complete, end-to-end voice AI agent. A single WebSocket where your agent listens, thinks, and speaks — grounded in your knowledge bases and tools, with human-like turn-taking and instant barge-in — no STT, LLM, or TTS to stitch together yourself.
wss://api.pyai.com/v1/omni - Trace (flagship) — The compliance API that keeps your AI agents safe. Trace automatically checks every call for HIPAA, TCPA, and PII risks (plus your own brand-voice rules), flags the exact rule broken, redacts sensitive data, and seals each call with a tamper-evident audit trail — so a risky conversation never slips through.
GET /v1/trace/interactions - Cue — Realtime turn detection + knowledge-grounded context for your own stack. Bring your own LLM and voice; Cue nails the hard part — knowing the instant a speaker finishes and surfacing the right context.
wss://api.pyai.com/v1/audio/transcriptions/stream - Telephony — Instant managed phone numbers for your voice agents. Provision a US number and route live calls straight into an Omni agent — no carrier contracts, no telephony glue.
POST /v1/telephony/numbers
The contract is https://api.pyai.com/openapi.json. This SDK wraps it
ergonomically with typed errors, automatic retries, and a realtime helper.
Install
npm install @pyai/sdkQuickstart
import PyAI from "@pyai/sdk";
const pyai = new PyAI({ apiKey: process.env.PYAI_API_KEY! });
// Text-to-speech
const audio = await pyai.audio.speech({ input: "Hello from PyAI.", voice: "stock_sarah_style2" });
await Bun.write?.("hello.wav", audio); // or fs.writeFile in Node
// Text-to-speech, streamed — start playing/forwarding at the first chunk
// (tens of ms) instead of waiting for the whole clip. Use mp3 for smooth
// progressive playback.
const stream = await pyai.audio.speechStream({ input: "Hello from PyAI.", voice: "stock_sarah_style2", response_format: "mp3" });
for await (const chunk of stream) writeToSpeakerOrResponse(chunk);
// Voices
const { data: voices } = await pyai.voices.list({ gender: "female" });
// Async transcription (safe retry with an idempotency key)
const job = await pyai.transcriptionJobs.create(
{ audio_url: "https://example.com/call.wav", diarize: true },
{ idempotencyKey: crypto.randomUUID() },
);
const done = await pyai.transcriptionJobs.get(job.job_id);Realtime (Omni)
Keys travel as a WebSocket subprotocol so this works in the browser:
const ws = pyai.connectRealtime({ product: "omni", agentId: "agent_123" });
ws.addEventListener("message", (e) => console.log(e.data));
// Or build the pieces yourself for a custom WS library:
const url = pyai.realtimeURL({ product: "omni", agentId: "agent_123" });
const proto = pyai.realtimeSubprotocol();Omni uses the native
wss://api.pyai.com/v1/omnisurface.connectRealtimetargets it by default (product: "omni");product: "flow"uses/v1/realtime. The older/v2/omni/chatURL is deprecated but still works.
Errors
Failures throw PyAIError with a stable code (branch on it, not the message):
import { PyAIError } from "@pyai/sdk";
try {
await pyai.audio.speech({ input: "hi" });
} catch (err) {
if (err instanceof PyAIError && err.code === "credit_exhausted") {
// out of prepaid credit — add credit or use a sandbox key
}
}Common codes: unauthorized, forbidden, credit_exhausted,
rate_limit_exceeded, concurrency_limit_exceeded, idempotency_conflict.
429/5xx are retried automatically (honoring Retry-After); tune with
new PyAI({ apiKey, maxRetries }).
CLI (pyai)
Installing the package also provides a pyai command — a smoke tester that
proves your key, the endpoint, and audio synthesis in one shot:
export PYAI_API_KEY=pyai_test_...
npx pyai smoke
# PASS models.list — 12 models
# PASS voices.list — 38 voices
# PASS audio.speech — 45210 bytes of audio
# All checks passed. Your key, the endpoint, and audio synthesis work.Other commands:
pyai models
pyai voices --gender female --region en_us
pyai speak --text "Hello" --voice stock_sarah_style2 --out hello.wav
pyai transcribe --url https://example.com/call.wav --diarize --pollAuth comes from PYAI_API_KEY / PYAI_BASE_URL (or --api-key / --base-url).
Develop
npm install
npm test # node --test, fetch injected (no network)
npm run build # emits dist/ (incl. the pyai CLI bin)