Skip to main content
PUT
/
api
/
agents
/
{agent_id}
Update Agent
curl --request PUT \
  --url https://api.getello.ai/api/agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "type": "inbound",
  "name": "My Inbound Agent",
  "greeting": "Hello! How can I assist you today?",
  "prompt": "You are a helpful AI Agent focused on providing accurate and friendly responses.",
  "knowledgeBases": [
    "kb_001",
    "kb_002"
  ]
}
'
{
  "status": 200,
  "message": "Agent updated successfully",
  "data": {
    "_id": "683c06debc7538418958bdb9",
    "workspaceId": "683c0129ea0c6f3e9b2ae326",
    "name": "My Inbound Agent",
    "type": "inbound",
    "category": "general",
    "description": "AI Agent for voice calls",
    "image": "https://voicemart.ai/assistant-icons/default.png",
    "features": [],
    "popularity": 0,
    "voiceConfig": {
      "provider": "elevenlabs",
      "voiceId": "emily",
      "language": "en-US",
      "patienceLevel": 1,
      "speed": 1,
      "pitch": 1,
      "latency": 0.5,
      "stability": 0.5,
      "styleExaggeration": 0.75,
      "similarity": 0.8,
      "voicePromptType": null,
      "voicePrompt": null
    },
    "aiModel": {
      "provider": "openai",
      "model": "gpt-4",
      "temperature": 0.7,
      "maxTokens": 200
    },
    "callConfig": {
      "timeZone": "IST",
      "maxDuration": 600,
      "voicemailDetection": {
        "enabled": true,
        "type": "ml-based"
      },
      "recordingEnabled": true,
      "transcriptionEnabled": true,
      "speakerBoost": false,
      "idleReminders": [
        false,
        0.75
      ],
      "limitCallDuration": [
        false,
        20
      ]
    },
    "fillerWords": true,
    "status": true,
    "timezone": "India",
    "greeting": "Hello! How can I assist you today?",
    "prompt": "You are a helpful AI Agent focused on providing accurate and friendly responses.",
    "knowledgeBases": [],
    "deployment": {
      "status": "draft",
      "version": 1
    },
    "createdAt": "2025-06-01T07:53:02.509000",
    "updatedAt": "2025-06-01T09:16:05.556000"
  }
}

Authorizations

X-API-Key
string
header
required

Path Parameters

agent_id
string
required

Unique identifier of the agent to update.

Example:

"683c06debc7538418958bdb9"

Body

application/json
type
enum<string>
required

The type of agent (e.g., inbound,outbound).

Available options:
inbound,
outbound,
chat
Example:

"inbound"

name
string

Optional name of the agent.

Example:

"My Inbound Agent"

greeting
string

Greeting message for the agent.

Example:

"Hello! How can I assist you today?"

prompt
string

Prompt or personality configuration for the agent.

Example:

"You are a helpful AI Agent focused on providing accurate and friendly responses."

knowledgeBases
string[]

List of knowledge base IDs linked to this agent.

Example:
["kb_001", "kb_002"]

Response

Agent updated successfully

status
integer
Example:

200

message
string
Example:

"Agent updated successfully"

data
object
Example:
{
"_id": "683c06debc7538418958bdb9",
"workspaceId": "683c0129ea0c6f3e9b2ae326",
"name": "My Inbound Agent",
"type": "inbound",
"category": "general",
"description": "AI Agent for voice calls",
"image": "https://voicemart.ai/assistant-icons/default.png",
"features": [],
"popularity": 0,
"voiceConfig": {
"provider": "elevenlabs",
"voiceId": "emily",
"language": "en-US",
"patienceLevel": 1,
"speed": 1,
"pitch": 1,
"latency": 0.5,
"stability": 0.5,
"styleExaggeration": 0.75,
"similarity": 0.8,
"voicePromptType": null,
"voicePrompt": null
},
"aiModel": {
"provider": "openai",
"model": "gpt-4",
"temperature": 0.7,
"maxTokens": 200
},
"callConfig": {
"timeZone": "IST",
"maxDuration": 600,
"voicemailDetection": { "enabled": true, "type": "ml-based" },
"recordingEnabled": true,
"transcriptionEnabled": true,
"speakerBoost": false,
"idleReminders": [false, 0.75],
"limitCallDuration": [false, 20]
},
"fillerWords": true,
"status": true,
"timezone": "India",
"greeting": "Hello! How can I assist you today?",
"prompt": "You are a helpful AI Agent focused on providing accurate and friendly responses.",
"knowledgeBases": [],
"deployment": { "status": "draft", "version": 1 },
"createdAt": "2025-06-01T07:53:02.509000",
"updatedAt": "2025-06-01T09:16:05.556000"
}