Rymi Python SDK
The official Python wrapper for the Rymi Voice AI API — build and run AI voice agents from any Python app.
Manage agents (including multi-language and full model-stack control), phone numbers, calls, knowledge sources, evaluations, usage, and templates — plus webhook verification.
Documentation · API Reference · Dashboard · Node SDK · MCP Server
✨ Why Rymi
| 🎙️ Voice agents | Full STT → LLM → TTS stack control, per-channel fallbacks, and multi-language support. |
| ☎️ Telephony | Register numbers, place outbound calls, and observe them live. |
| 📚 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. |
| 🔒 Secure by default | Built-in webhook signature verification; keys read from the environment. |
📦 Installation
pip install rymi
Requires Python 3.8+.
🚀 Quick Start
import os
from rymi import Rymi
# Automatically picks up RYMI_API_KEY from the environment
client = Rymi()
# Or pass it explicitly
# client = Rymi(api_key="rymi_live_...")
agents = client.agents.list()
for agent in agents["agents"]:
print(agent["name"])
Tip: Keep your secret key in
RYMI_API_KEYand let the client read it — never hard-code secret keys.
🧩 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 |
Create a secret key (create(kind, scopes, label), response field key) and read it (self()). Also manage publishable keys |
billing |
Usage summaries, balance, and set_country (billing country, locked after the first paid invoice) |
templates |
Prebuilt agent templates |
webhooks |
Create webhooks and verify incoming signatures |
dnc |
Do-not-call list management |
campaigns |
Outbound/inbound calling campaigns: members, launch/pause, reports, improvement suggestions, inbound routes, and the lead-intake URL (campaigns.intake) |
contacts |
Contacts and per-channel consent |
compliance |
Attestations, plus workspace settings: get_settings, update_settings, preview_settings |
accounts |
list, get, update, list_members, add_member, update_member, remove_member, workspaces (this month's calls, minutes, and credits) |
workspaces |
List, create, update, and delete empty workspaces (delete(id), account Owner; cannot_delete_primary for the primary). usage, list_members, add_member (admin, editor, client, viewer), remove_member. Pass workspace (or RYMI_WORKSPACE), or call with_workspace(id) |
tool_secrets |
Secrets for API-tool headers, referenced as {{secrets.NAME}} |
📖 Documentation
Full reference and guides: docs.rymi.live/api/sdk-python
PyPI: pypi.org/project/rymi
📄 License
MIT © Rymi
Metadata
Release files for rymi 1.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| rymi-1.7.0.tar.gz | 22.5 kB | With provenance | Details for rymi-1.7.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| rymi-1.7.0-py3-none-any.whl | Python 3 | none | any | Details for rymi-1.7.0-py3-none-any.whl |
Total release size: 45.1 kB
Release files / rymi-1.7.0.tar.gz
| Download URL | rymi-1.7.0.tar.gz |
|---|---|
| Size | 22.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
eeba3318869543c8af4006fec4005a8d213b521b1566856058eadadf6752d73d
|
|
BLAKE2b-256 checksum How to use checksums |
317a1aa7f258b2a58ed3d0b6c9d5ea830575d617953056bac0f1c538961a703f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.
Transparency logRelease files / rymi-1.7.0-py3-none-any.whl
| Download URL | rymi-1.7.0-py3-none-any.whl |
|---|---|
| Size | 22.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
95da83133a34c579b8a4d7151d75c1d25a143b37f261a0bccd782a6d410f83c9
|
|
BLAKE2b-256 checksum How to use checksums |
3d6b3c5625156e792ca1693a1b42ae1c83fdad7b30c83f44528c17b62246f28f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.
Transparency logSecurity for rymi 1.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for rymi-1.7.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.