Quickstart

Get your first AI voice agent making calls in under 5 minutes.

1. Get Your API Key

Sign up at rymi.ai and grab your API key from the dashboard.

export RYMI_API_KEY="your_api_key_here"

2. Create an Agent

curl -X POST https://api.rymi.ai/v1/agents \
  -H "Authorization: Bearer $RYMI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Alex - Sales Agent",
    "system_prompt": "You are Alex, a friendly sales assistant for TechCorp. Your goal is to qualify inbound leads by asking about their company size and budget. Be warm, concise, and professional."
  }'

3. Buy a Phone Number

# Search for available numbers
curl -X POST https://api.rymi.ai/v1/numbers/search \
  -H "Authorization: Bearer $RYMI_API_KEY" \
  -d '{ "iso": "US" }'

# Purchase one
curl -X POST https://api.rymi.ai/v1/numbers/buy \
  -H "Authorization: Bearer $RYMI_API_KEY" \
  -d '{ "number": "15551234567" }'

4. Attach the Number to Your Agent

curl -X POST https://api.rymi.ai/v1/numbers/15551234567/attach \
  -H "Authorization: Bearer $RYMI_API_KEY" \
  -d '{ "agent_id": "YOUR_AGENT_ID" }'

That's it! Call the number and your AI agent will answer.

5. Run an Outbound Campaign (Optional)

# Create a campaign
curl -X POST https://api.rymi.ai/v1/campaigns \
  -H "Authorization: Bearer $RYMI_API_KEY" \
  -d '{
    "agent_id": "YOUR_AGENT_ID",
    "name": "Q1 Sales Outreach",
    "call_from_number": "15551234567"
  }'

# Upload contacts
curl -X POST https://api.rymi.ai/v1/campaigns/CAMPAIGN_ID/contacts \
  -H "Authorization: Bearer $RYMI_API_KEY" \
  -d '{
    "contacts": [
      { "phone_number": "15559990001", "variables": { "name": "Alice" } },
      { "phone_number": "15559990002", "variables": { "name": "Bob" } }
    ]
  }'

# Launch!
curl -X POST https://api.rymi.ai/v1/campaigns/CAMPAIGN_ID/start \
  -H "Authorization: Bearer $RYMI_API_KEY"

What's Next?

• Set up webhooks to receive real-time call events
• Add DNC compliance to stay within regulations
• Monitor costs with the analytics endpoint
• Learn about Plivo integration for advanced configuration