Sign in

v1

latestOpenAPI 3.0.02026-07-2633090.6 KB
agent

Create Agent

Creates a new AI agent with the specified configuration. The agent will be created with a single prompt-based flow.

post/public/agent

Headers

X-API-KEYstring required
Example:7251cb4b-3373-43a4-844c-b27a1d45e0c9

(Required) Your Ringg AI API key.

Request body

agent_namestring required

(Required) Name of the agent

introduction_and_objectivestring required

(Required) Introduction and objective of the agent

response_guidelinesstring required

(Required) Guidelines for how the agent should respond

taskstring required

(Required) The task the agent should perform

faqstring

(Optional) FAQ content for the agent

sample_conversationsstring

(Optional) Example conversations for the agent. Use \n for newlines between turns.

primary_language'en-US' | 'en-IN' | 'hi-IN' | 'ta-IN' | 'te-IN' | 'bn-IN' | 'mr-IN' | 'kn-IN' | 'ka-IN' required

(Required) Primary language locale for the agent

secondary_language'en-US' | 'en-IN' | 'hi-IN' | 'ta-IN' | 'te-IN' | 'bn-IN' | 'mr-IN' | 'kn-IN' | 'ka-IN'

(Optional) Secondary language locale for the agent

voice_idstring uuid required

(Required) Internal AgentVoice ID (UUID). Get available voices from the Get Assistant Voices endpoint.

intro_messagestring required

(Required) Introduction message the agent will speak when the call starts

agent_type'inbound' | 'outbound' | 'outbound_inbound'

(Required) Type of agent. Defaults to outbound.

custom_variablesstring[]

(Optional) Custom variables for the agent. For outbound agents, callee_name and mobile_number are always included automatically.

Example request

{
  "agent_name": "My Sales Agent",
  "introduction_and_objective": "You are a customer support agent for Acme Corp.",
  "response_guidelines": "Be polite, helpful, and concise. Always confirm understanding.",
  "task": "Help customers with their orders and answer product questions.",
  "faq": "Q: What are your hours? A: We are open 9am-6pm IST.",
  "sample_conversations": "User: Hi\nAgent: Hello! How can I help you today?",
  "primary_language": "en-IN",
  "secondary_language": "hi-IN",
  "voice_id": "02ad256b-092b-4048-bea0-5af46a452b98",
  "intro_message": "Hello, this is Sarah from Acme Corp. How can I assist you today?",
  "agent_type": "outbound",
  "custom_variables": [
    "callee_name",
    "mobile_number",
    "company",
    "lead_source"
  ]
}

Response

Agent created successfully.

successboolean
messagestring

Example response

{
  "success": true,
  "data": {
    "id": "edd618d3-f473-4ac1-b5fa-f1a3981666ff",
    "version": "v1",
    "created_at": "2024-12-16T13:03:29.947147+00:00"
  },
  "message": "Agent created successfully"
}