Update Agent

curl --request PUT \
  --url https://api.inya.ai/platform/v1/agents/{botId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "greetingMessage": "Welcome! How may I assist you?",
  "endMessage": "Thank you for calling. Have a great day!"
}
'

{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Agent updated successfully",
  "response": {
    "botId": "fb79920229d144608ebf665a10e50275"
  }
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

PUT

agents

{botId}

curl --request PUT \
  --url https://api.inya.ai/platform/v1/agents/{botId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "greetingMessage": "Welcome! How may I assist you?",
  "endMessage": "Thank you for calling. Have a great day!"
}
'

{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Agent updated successfully",
  "response": {
    "botId": "fb79920229d144608ebf665a10e50275"
  }
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

Overview

Update an existing voice agent’s configuration. All request body fields are optional — only the fields you include are modified. Unspecified fields retain their current values. This endpoint is the primary way to configure an agent’s ASR, LLM, TTS, language settings, advance settings, and integrations.

Required Permission

agents

Path Parameters

Name	Type	Required	Description
`botId`	string	Yes	Unique agent identifier.

Top-Level Request Body Fields

Field	Type	Description
`botName`	string	New display name for the agent.
`description`	string	Updated agent description.
`greetingMessage`	string	Opening message spoken at the start of each call.
`endMessage`	string	Closing message spoken before the call ends.
`systemPrompt`	string	LLM system prompt. Supports Jinja2 template variables (e.g. `{{ customer_name }}`).
`hasDynamicGreeting`	boolean	Enable fetching the greeting from an external API at call start.
`dynamicInitialMessageConfig`	object	`{ hasHeaders, method, url, headers[{ id, key, value }] }` — webhook config for dynamic greeting.
`botDetails`	object	`{ language: string[] (max 3), region, timeZone, description }`
`asrParams`	object	`{ provider, model, language }` — the selected model must support all configured languages.
`llmParams`	object	`{ provider, model, temperature (0.0–1.0), maxTokens (1–4096) }`
`ttsParams`	object	`{ provider, voice, language, ttsRate (0.5–2.0), enableCaching }`
`advanceSettings`	object	ASR advance settings. See table below.
`languageSwitch`	boolean	Enable automatic language switching mid-call.
`explicitLanguageSwitch`	boolean	Use explicit language switch mode (agent asks the caller to confirm).
`languageSwitchMode`	string	`'implicit'` or `'explicit'`. Controls how language switch is initiated.
`minWordsForLangSwitch`	integer	Minimum words in the non-primary language before switching. Must be >= 1. Default: `2`.
`callTransferConfig`	object	`{ description, defaultTransferMessage, details[{ phoneNumber, countryCode, prompt, message }] }`
`callTransferConfigStatus`	boolean	Enable or disable call transfer functionality.
`preCall`	object	`{ preCallVariableStatus, preCallParams: { primaryVariable, variables[] } }`
`enableVoiceMailDetection`	boolean	Enable the voicemail detection feature.
`voiceMailDetectionConfig`	object	`{ enabled, maxDetectionRetries (>=1), maxVoicemailMessageWaitTime (>=1), voiceMailResponse, postDetectionActions[] }`
`hasPostCallTrigger`	boolean	Enable or disable the post-call webhook.
`postCallTriggerAPIConfig`	object	`{ hasHeaders, method ('GET' \| 'POST'), url, headers[{ id, key, value }] }`

`advanceSettings` Fields

Field	Type	Range / Notes
`barge`	boolean	Enable or disable caller barge-in.
`initialMessageBarge`	boolean	Allow the caller to interrupt the opening greeting.
`useDenoiser`	boolean	Apply background noise filtering.
`suppressionLevel`	integer	Noise suppression level: 20–100.
`enableItnForAsr`	boolean	Apply Inverse Text Normalization to ASR output.
`maxSpeechDuration`	number	Maximum utterance duration in seconds: 1–240.
`speechInitialSilenceTimeout`	number	Silence threshold before ASR activates: 10–30s (streaming) or 10–60s (others).
`endSilenceTimeout`	number	End-of-speech silence in milliseconds. Stored directly.
`speechSegmentationSilenceTimeout`	number	Utterance segmentation silence gap: 0.1–5s. Streaming models only.
`minWordsForBargeIn`	integer	Minimum words before a barge-in registers: 1–5. Streaming ASR only.
`minTimeToBarge`	number	Minimum elapsed time before barge-in is accepted: 0.1–3s. Non-streaming ASR only.
`asrPreemptive`	boolean	Enable Fast Streaming mode. Fast REST ASR models only.
`enableDtmf`	boolean	Accept DTMF keypad input during the call.
`phraseConfig.phrase`	string[]	Custom vocabulary hint phrases. Maximum 100 entries. Vocabulary-capable models only.
`phraseConfig.phraseWeight`	number	Recognition bias weight for custom vocabulary: 0.0–2.0.

Sending an advanceSettings field that is not supported by the current ASR model returns HTTP 400. Use Get Transcriber Config to verify model compatibility before updating.

ASR Model Compatibility — `advanceSettings` Reference

Each advanceSettings field is valid only for specific ASR model types. Sending an incompatible field returns HTTP 400.

Setting	Valid For	Supported Models
`minWordsForBargeIn`	Streaming only	`gnani_asr`, `microsoft_streaming`, `elevenlabs_streaming`, `gladia_streaming`, `gemini-2.5-flash-native-audio-preview-09-2025`
`minTimeToBarge`	Non-streaming (REST) only	`microsoft_rest`, `elevenlabs_rest`
`speechSegmentationSilenceTimeout`	Streaming + select REST	`microsoft_streaming`, `elevenlabs_streaming`, `microsoft_rest`
`phraseConfig.phrase`	Vocabulary-capable models only	`microsoft_streaming`, `gnani_asr`, `elevenlabs_streaming`, `elevenlabs_rest`
`asrPreemptive`	Fast REST models only	`elevenlabs_rest`
`speechInitialSilenceTimeout` (max 30s)	Streaming + select REST	`microsoft_streaming`, `elevenlabs_streaming`, `microsoft_rest`
`speechInitialSilenceTimeout` (max 60s)	Other models	`gnani_asr`, `gladia_streaming`, `gemini-2.5-flash-native-audio-preview-09-2025`
`barge`, `useDenoiser`, `enableDtmf`, `maxSpeechDuration`	All models	Any

Example cURL

Update Messages

curl -X PUT "https://api.inya.ai/platform/v1/agents/fb79920229d144608ebf665a10e50275" \
  -H "x-api-key: <your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "greetingMessage": "Hello, how can I help you today?",
    "endMessage": "Thank you for calling. Have a great day!"
  }'

Full Configuration Update

curl -X PUT "https://api.inya.ai/platform/v1/agents/fb79920229d144608ebf665a10e50275" \
  -H "x-api-key: <your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "botName": "Support Agent v2",
    "description": "Handles inbound support and billing queries.",
    "greetingMessage": "Hello, how can I help you today?",
    "endMessage": "Thank you for calling. Have a great day!",
    "systemPrompt": "You are a helpful support agent for {{ company_name }}.",
    "hasDynamicGreeting": false,
    "botDetails": {
      "language": ["en-IN", "hi-IN"],
      "region": "asia",
      "timeZone": "Asia/Kolkata"
    },
    "asrParams": {
      "provider": "gnani",
      "model": "gnani_asr",
      "language": "en-IN"
    },
    "llmParams": {
      "provider": "gnani",
      "model": "Pampa Go",
      "temperature": 0.7,
      "maxTokens": 400
    },
    "ttsParams": {
      "provider": "gnani",
      "voice": "Pranav",
      "language": "en-IN",
      "ttsRate": 1.2,
      "enableCaching": true
    },
    "advanceSettings": {
      "barge": true,
      "initialMessageBarge": false,
      "useDenoiser": true,
      "suppressionLevel": 80,
      "enableItnForAsr": false,
      "maxSpeechDuration": 15,
      "speechInitialSilenceTimeout": 10.0,
      "endSilenceTimeout": 800,
      "enableDtmf": false,
      "phraseConfig": {
        "phrase": ["billing", "refund", "account"],
        "phraseWeight": 1.0
      }
    },
    "languageSwitch": true,
    "languageSwitchMode": "explicit",
    "minWordsForLangSwitch": 2,
    "preCall": {
      "preCallVariableStatus": true,
      "preCallParams": {
        "primaryVariable": "customer_name",
        "variables": [
          { "variable": "customer_name", "sampleValue": "Alice", "description": "Customer full name" },
          { "variable": "account_id", "sampleValue": "ACC123", "description": "Customer account ID" }
        ]
      }
    },
    "enableVoiceMailDetection": true,
    "voiceMailDetectionConfig": {
      "enabled": true,
      "maxDetectionRetries": 2,
      "maxVoicemailMessageWaitTime": 3,
      "voiceMailResponse": "We tried to reach you. Please call us back.",
      "postDetectionActions": []
    },
    "callTransferConfig": {
      "description": "Transfer to live support agent",
      "defaultTransferMessage": "Please hold. Transferring you now.",
      "details": [
        { "phoneNumber": "9876500000", "countryCode": "+91", "prompt": "Transfer", "message": "Hold on" }
      ]
    },
    "callTransferConfigStatus": false,
    "hasPostCallTrigger": true,
    "postCallTriggerAPIConfig": {
      "hasHeaders": false,
      "method": "POST",
      "url": "https://your-server.example.com/call_status",
      "headers": null
    }
  }'

Response

Success (200)

{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Agent updated successfully",
  "response": { "botId": "fb79920229d144608ebf665a10e50275" }
}

Error Responses

400 Bad Request - Validation error

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Selected ASR model does not support selected languages. Please check /platform/v1/agents/config/transcriber_config"
}

403 Forbidden - Insufficient permissions or agent not found

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "QA role does not have permission to create/update agents"
}

403 Forbidden - Agent does not exist or not accessible

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "User does not have access to this bot"
}

409 Conflict - Agent name already taken

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "An agent named 'Support Agent v2' already exists in your organization"
}

Configuring a Multilingual Agent

Set botDetails.language to an array of up to three language codes. The selected ASR model must support every language in the list — use Get Transcriber Config with multiple language parameters to identify compatible options. The TTS voice must also support all configured languages — use Get TTS Config similarly. LLM models are language-agnostic.

curl -X PUT "https://api.inya.ai/platform/v1/agents/fb79920229d144608ebf665a10e50275" \
  -H "x-api-key: <your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "botDetails": { "language": ["en-IN", "hi-IN"] },
    "asrParams": {
      "provider": "microsoft",
      "model": "microsoft_streaming_multilingual",
      "language": "en-IN"
    },
    "ttsParams": {
      "provider": "gnani",
      "voice": "Nalini",
      "language": "en-IN"
    },
    "languageSwitch": true,
    "languageSwitchMode": "explicit",
    "minWordsForLangSwitch": 2
  }'

Use Cases

Updating agent messages for seasonal campaigns or new use cases
Fine-tuning the system prompt based on observed performance
Switching ASR, LLM, or TTS providers and models
Enabling advanced features like voicemail detection or call transfer
Configuring a post-call webhook for CRM updates or analytics pipelines

Always validate your ASR and TTS selections against the Agent Config API before updating. This ensures the selected provider/model combination supports all configured languages.

Save the requestId from every response. You will need it if you contact Inya support to trace a specific request.

Authorizations

x-api-key

string

header

required

API key with 'agents' permission

Path Parameters

botId

string

required

Unique identifier of the agent

Body

application/json

botName

string

description

string

greetingMessage

string

endMessage

string

systemPrompt

string

Supports Jinja2 template variables, e.g. {{ customer_name }}

hasDynamicGreeting

boolean

dynamicInitialMessageConfig

object

Show child attributes

botDetails

object

Show child attributes

asrParams

object

Show child attributes

llmParams

object

Show child attributes

ttsParams

object

Show child attributes

advanceSettings

object

Show child attributes

languageSwitch

boolean

explicitLanguageSwitch

boolean

languageSwitchMode

enum<string>

Available options:

implicit,

explicit

minWordsForLangSwitch

integer

default:2

Required range: x >= 1

callTransferConfig

object

Show child attributes

callTransferConfigStatus

boolean

preCall

object

Show child attributes

enableVoiceMailDetection

boolean

voiceMailDetectionConfig

object

Show child attributes

hasPostCallTrigger

boolean

postCallTriggerAPIConfig

object

Show child attributes

Response

Agent updated successfully

status

string

Example:

"success"

requestId

string

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

message

string

response

object

Getting Started

Agents API

Conversations API

Agent Config API

Agent FAQ API

Chat SDK API

Reference

Overview

Required Permission

Path Parameters

Top-Level Request Body Fields

`advanceSettings` Fields

ASR Model Compatibility — `advanceSettings` Reference

Example cURL

Update Messages

Full Configuration Update

Response

Success (200)

Error Responses

Configuring a Multilingual Agent

Use Cases

Authorizations

Path Parameters

Body

Response

​Overview

​Required Permission

​Path Parameters

​Top-Level Request Body Fields

​advanceSettings Fields

​ASR Model Compatibility — advanceSettings Reference

​Example cURL

​Update Messages

​Full Configuration Update

​Response

​Success (200)

​Error Responses

​Configuring a Multilingual Agent

​Use Cases

Authorizations

Path Parameters

Body

Response

Overview

Required Permission

Path Parameters

Top-Level Request Body Fields

`advanceSettings` Fields

ASR Model Compatibility — `advanceSettings` Reference

Example cURL

Update Messages

Full Configuration Update

Response

Success (200)

Error Responses

Configuring a Multilingual Agent

Use Cases