Skip to main content

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.

PyPI version Python versions PyPI downloads license

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_KEY and 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; pending_publish(id) shows a held edit on a phone line from Rymi
calls Place, list, and observe calls; fetch transcripts and recordings
phone_confirmation start(phone), request_code(phone) and status(phone) for a shared-test-line destination. start returns the WhatsApp link. The phone confirms it by sending the message
numbers Register and attach phone numbers
telephony Inspect carrier status and provisioned numbers; for a phone line from Rymi, line(), request_line(country), accept_line_terms() and submit_line_kyc(fields=, document=, submit=)
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; record_consent(phone, source=, consent_text=) records voice consent by phone number
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.11.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rymi 1.11.0
File Size Uploaded Provenance Actions
rymi-1.11.0.tar.gz 24.8 kB With provenance Details for rymi-1.11.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rymi 1.11.0
File Interpreter ABI Platform Actions
rymi-1.11.0-py3-none-any.whl Python 3 none any Details for rymi-1.11.0-py3-none-any.whl

Total release size: 49.4 kB

Release files / rymi-1.11.0.tar.gz

Download URL rymi-1.11.0.tar.gz
Size 24.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0fb8ba01059660f986ffcedc59957cb64d08c77ca68fe692b309eec946f2711b
BLAKE2b-256 checksum
How to use checksums
d625df280ed6bb01a09ce40fa416f5119414ea7e18ae7bc7ac6446c37c243dec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 13, 2026.

Transparency log

Release files / rymi-1.11.0-py3-none-any.whl

Download URL rymi-1.11.0-py3-none-any.whl
Size 24.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
057e69705deb14c93242a9e432b6a3bc76bd997cae0dc575396258cc2c6cc26b
BLAKE2b-256 checksum
How to use checksums
c9fedb7a4771d6bd9bb2c1d272ae69af5b55623201f30f107fc58ceeeaca2688
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 13, 2026.

Transparency log

Security for rymi 1.11.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.

Select from 2 files

Attestation for rymi-1.11.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 Nov 13, 2026.

Transparency log

A 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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page