Licence
MIT
Version
2.0.0
Deps
1
Size
297 kB
Vulns
0
Weekly
0
@rymi/node
The official Node.js SDK for Rymi — ship production AI voice agents in minutes.
Create and manage voice agents, attach phone numbers, place and observe calls, wire up knowledge sources, track usage, run evals, and verify webhooks — all from server-side JavaScript or TypeScript.
Documentation · API Reference · Dashboard · Python SDK · MCP Server
Why Rymi
| Voice agents | Full STT → LLM → TTS stack control, per-channel fallbacks, and multi-language / bilingual support out of the box. |
| Telephony | Attach numbers, place outbound calls over PSTN, and observe live calls in real time. |
| Knowledge | Ground agents in your own docs and data with managed knowledge sources. |
| Usage & evals | Track minutes and spend, then run evaluations to keep quality high. |
| Typed & safe | First-class TypeScript types and built-in webhook signature verification. |
Installation
npm install @rymi/node
# or
pnpm add @rymi/node
# or
yarn add @rymi/nodeQuickstart
import { Rymi } from '@rymi/node';
const rymi = new Rymi({ apiKey: process.env.RYMI_API_KEY });
// Create a voice agent
const agent = await rymi.agents.create({
name: 'Support',
system_prompt: 'You are a helpful support agent for Acme Corp.',
voice: 'Aoede',
});
// Start an outbound call
const call = await rymi.calls.create({
agent_id: agent.id,
participants: [{ transport: 'pstn', identity: '+15551234567', from_number: '+15559876543' }],
});Tip: Set
RYMI_API_KEYin your environment and the client picks it up automatically — never hard-code secret keys or ship them to the browser.
Resources
The client exposes one namespace per resource group:
| Namespace | What it does |
|---|---|
agents |
Create, update, clone, and configure voice agents |
calls |
Place, list, and observe calls; fetch transcripts and recordings |
numbers |
Register and attach phone numbers |
telephony |
Inspect carrier status and provisioned numbers |
keys |
Manage publishable keys |
billing |
Usage summaries and balance |
templates |
Prebuilt agent templates |
webhooks |
Create webhooks and verify incoming signatures |
dnc |
Do-not-call list management |
Documentation
Full reference and guides: docs.rymi.live/api/sdk-node
License
MIT Rymi