Agents

Agents are AI voice personas. Each agent has a name, system prompt, voice configuration, and behavioral traits that define how it interacts with callers.

List Agents

GET /agents

Response 200

{
  "agents": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Priya - Sales Specialist",
      "system_prompt": "You are Priya, a friendly sales agent...",
      "voice": "hi-IN-Wavenet-A",
      "description": "Insurance sales specialist for the Indian market",
      "created_at": "2026-03-01T10:00:00Z"
    }
  ]
}

Create Agent

POST /agents

Request Body

Field	Type	Required	Description
name	string	✅	Human-readable agent name
system_prompt	string	✅	LLM system instructions
voice	string	—	TTS voice ID
description	string	—	Short description
script	string	—	Conversation script template
fallback_message	string	—	Default response when agent can't understand
objection_handlers	string[]	—	Pre-built responses to common objections

curl -X POST https://api.rymi.ai/v1/agents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Priya - Sales Specialist",
    "system_prompt": "You are Priya, a friendly insurance sales agent..."
  }'

Response 201

{ "status": "created" }

Get Agent

GET /agents/:id

Response 200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Priya - Sales Specialist",
  "system_prompt": "You are Priya..."
}

Update Agent

PUT /agents/:id

Pass only the fields you want to update.

curl -X PUT https://api.rymi.ai/v1/agents/550e8400-... \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{ "system_prompt": "Updated instructions..." }'

Response 200

{ "status": "updated", "id": "550e8400-..." }

Delete Agent

DELETE /agents/:id

WARNING

Deleting an agent will cascade-delete all associated number mappings and campaigns.

Response 200

{ "status": "deleted", "id": "550e8400-..." }

Generate Agent with AI coming soon

POST /agents/generate

Describe your ideal agent in plain English and Rymi will use AI to generate a complete persona configuration.

curl -X POST https://api.rymi.ai/v1/agents/generate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "prompt": "A friendly female sales agent who speaks Hindi with a Delhi accent and can sell insurance plans"
  }'