API Reference
Welcome to the Rymi Voice API. Build, deploy, and manage AI-powered voice agents entirely through REST endpoints.
Base URL
https://api.rymi.ai/v1Authentication
All endpoints require a Bearer token in the Authorization header:
bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.rymi.ai/v1/agents| Header | Value |
|---|---|
Authorization | Bearer <YOUR_API_KEY> |
Content-Type | application/json |
Rate Limits
The API enforces limits per-API-key and per-IP address. The backend architecture supports configurable burst capacity.
| Plan | Requests/min | Concurrent Calls | Burst Allowance |
|---|---|---|---|
| Free | 60 | 1 | 5 requests |
| Go | 300 | 10 | 25 requests |
| Plus | 1000 | 50 | 100 requests |
| Custom | Unlimited | Custom | Custom |
Error Format
All errors follow a consistent structure:
json
{
"error": "Human-readable error message"
}| HTTP Code | Meaning |
|---|---|
200 | Success |
201 | Resource created |
400 | Bad request / validation error |
401 | Missing or invalid API key |
404 | Resource not found |
500 | Internal server error |
Resources
- Agents — Create and manage AI voice personas
- Numbers — Search, purchase, and manage phone numbers
- Campaigns — Orchestrate outbound call batches
- Calls — Monitor active calls and retrieve transcripts
- Webhooks — Register event notification endpoints
- Compliance — Manage Do-Not-Call lists
- Analytics — Track costs and performance