Sign in

v1

latestOpenAPI 3.0.02026-07-2633090.6 KB
agent

Edit Assistant

Updates an existing assistant with new configuration settings. Each operation requires specific fields to be provided.

patch/agent/v1

Headers

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

(Required) Your Ringg AI API key.

Request body

operation'attach_inbound_number' | 'remove_inbound_number' | 'attach_kb' | 'remove_kb' | 'edit_custom_vars' | 'edit_language' | 'edit_voice' | 'edit_prompt' | 'edit_noise_settings' | 'edit_agent_display_name' | 'edit_intro_message' | 'edit_query_phrases' | 'edit_dtmf_settings' | 'edit_vad_settings' | 'edit_agent_whitelisted_domains' | 'edit_voice_speed' | 'edit_extract_callee_name' | 'edit_vocab' | 'edit_api_settings' | 'edit_secondary_language' | 'edit_secondary_voice' required
agent_idstring required
agent_display_namestring
language'en-US' | 'en-IN' | 'hi-IN' | 'ta-IN' | 'te-IN' | 'kn-IN' | 'mr-IN' | 'gu-IN' | 'ar-AE'
voice_idstring
secondary_voice_idstring
secondary_language'en-US' | 'en-IN' | 'hi-IN' | 'ta-IN' | 'te-IN' | 'kn-IN' | 'mr-IN' | 'gu-IN' | 'ar-AE'
custom_variablesstring[]
number_idstring
kb_idstring
whitelisted_domainsstring[]
voice_speednumber

Example request

{
  "operation": "edit_agent_display_name",
  "agent_id": "830f767a-397e-4b39-82ff-235cd344e2f9",
  "agent_display_name": "Updated Sales Assistant",
  "language": "en-US",
  "voice_id": "3b5c7d2a-8e9f-4a1b-9c6d-2e5f8a7b3c4d",
  "secondary_voice_id": "4c6d8e3b-9f0a-5b2c-ad7e-3f6a9b8c5d7e",
  "secondary_language": "hi-IN",
  "agent_prompt": "You are a helpful sales assistant.",
  "custom_variables": [
    "callee_name",
    "mobile_number",
    "company",
    "lead_source"
  ],
  "number_id": "5d7f9a2b-1c3e-4f6a-8b9c-0d1e2f3a4b5c",
  "kb_id": "7a9c2d5e-4f6b-1a2b-3c4d-5e6f7a8b9c0d",
  "whitelisted_domains": [
    "https://www.ringg.ai",
    "https://example.com"
  ],
  "voice_speed": 1.2
}

Response

Successful Response: Assistant updated successfully.

messagestring
agent_idstring

Example response

{
  "message": "Agent updated successfully!",
  "agent_id": "830f767a-397e-4b39-82ff-235cd344e2f9"
}