@rymi/node 1.0.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -8
- package/dist/index.d.mts +562 -15
- package/dist/index.d.ts +562 -15
- package/dist/index.js +264 -8
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +261 -8
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,16 +1,43 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
1
3
|
# @rymi/node
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
### The official Node.js SDK for [**Rymi**](https://rymi.live) — ship production AI voice agents in minutes.
|
|
6
|
+
|
|
7
|
+
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.
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/@rymi/node)
|
|
10
|
+
[](https://www.npmjs.com/package/@rymi/node)
|
|
11
|
+
[](https://www.npmjs.com/package/@rymi/node)
|
|
12
|
+
[](./LICENSE)
|
|
13
|
+
|
|
14
|
+
[**Documentation**](https://docs.rymi.live/api/sdk-node) · [**API Reference**](https://docs.rymi.live) · [**Dashboard**](https://rymi.live) · [**Python SDK**](https://pypi.org/project/rymi/) · [**MCP Server**](https://www.npmjs.com/package/@rymi/mcp)
|
|
15
|
+
|
|
16
|
+
</div>
|
|
17
|
+
|
|
18
|
+
---
|
|
4
19
|
|
|
5
|
-
|
|
20
|
+
## ✨ Why Rymi
|
|
6
21
|
|
|
7
|
-
|
|
22
|
+
| | |
|
|
23
|
+
|---|---|
|
|
24
|
+
| 🎙️ **Voice agents** | Full STT → LLM → TTS stack control, per-channel fallbacks, and multi-language / bilingual support out of the box. |
|
|
25
|
+
| ☎️ **Telephony** | Attach numbers, place outbound calls over PSTN, and observe live calls in real time. |
|
|
26
|
+
| 📚 **Knowledge** | Ground agents in your own docs and data with managed knowledge sources. |
|
|
27
|
+
| 📊 **Usage & evals** | Track minutes and spend, then run evaluations to keep quality high. |
|
|
28
|
+
| 🔒 **Typed & safe** | First-class TypeScript types and built-in webhook signature verification. |
|
|
29
|
+
|
|
30
|
+
## 📦 Installation
|
|
8
31
|
|
|
9
32
|
```bash
|
|
10
33
|
npm install @rymi/node
|
|
34
|
+
# or
|
|
35
|
+
pnpm add @rymi/node
|
|
36
|
+
# or
|
|
37
|
+
yarn add @rymi/node
|
|
11
38
|
```
|
|
12
39
|
|
|
13
|
-
## Quickstart
|
|
40
|
+
## 🚀 Quickstart
|
|
14
41
|
|
|
15
42
|
```typescript
|
|
16
43
|
import { Rymi } from '@rymi/node';
|
|
@@ -31,10 +58,28 @@ const call = await rymi.calls.create({
|
|
|
31
58
|
});
|
|
32
59
|
```
|
|
33
60
|
|
|
34
|
-
|
|
61
|
+
> **Tip:** Set `RYMI_API_KEY` in your environment and the client picks it up automatically — never hard-code secret keys or ship them to the browser.
|
|
62
|
+
|
|
63
|
+
## 🧩 Resources
|
|
64
|
+
|
|
65
|
+
The client exposes one namespace per resource group:
|
|
66
|
+
|
|
67
|
+
| Namespace | What it does |
|
|
68
|
+
|-----------|--------------|
|
|
69
|
+
| `agents` | Create, update, clone, and configure voice agents |
|
|
70
|
+
| `calls` | Place, list, and observe calls; fetch transcripts and recordings |
|
|
71
|
+
| `numbers` | Register and attach phone numbers |
|
|
72
|
+
| `telephony` | Inspect carrier status and provisioned numbers |
|
|
73
|
+
| `keys` | Manage publishable keys |
|
|
74
|
+
| `billing` | Usage summaries and balance |
|
|
75
|
+
| `templates` | Prebuilt agent templates |
|
|
76
|
+
| `webhooks` | Create webhooks and verify incoming signatures |
|
|
77
|
+
| `dnc` | Do-not-call list management |
|
|
78
|
+
|
|
79
|
+
## 📖 Documentation
|
|
35
80
|
|
|
36
|
-
Full reference: [rymi.
|
|
81
|
+
Full reference and guides: [**docs.rymi.live/api/sdk-node**](https://docs.rymi.live/api/sdk-node)
|
|
37
82
|
|
|
38
|
-
## License
|
|
83
|
+
## 📄 License
|
|
39
84
|
|
|
40
|
-
MIT
|
|
85
|
+
[MIT](./LICENSE) © Rymi
|