Skip to main content
PATCH
/
v1
/
voice-agents
/
{voiceAgentId}
Update an existing voice agent
curl --request PATCH \
  --url https://api.tryhamsa.com/v1/voice-agents/{voiceAgentId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agentName": "<string>",
  "greetingMessage": "<string>",
  "preamble": "<any>",
  "lang": "ar",
  "pokeMessages": [
    "<string>"
  ],
  "realTime": true,
  "silenceThreshold": 123,
  "interrupt": true,
  "outcome": "<string>",
  "outcomeResponseShape": {
    "type": "object",
    "properties": {
      "test": {
        "type": "number",
        "description": "Hello world from Hamsa AI!"
      }
    },
    "required": [
      "test"
    ]
  },
  "webhookUrl": "https://example.com/webhook",
  "webhookAuth": {
    "authKey": "Token",
    "authSecret": "Secret"
  },
  "voiceId": "ab55c68b-091b-43b4-a55a-0be82093cd23",
  "tools": {
    "genderDetection": false,
    "smartCallEnd": false
  },
  "params": {}
}'
{
  "success": false,
  "message": "success",
  "data": {
    "id": "<string>",
    "agentName": "<string>",
    "greetingMessage": "<string>",
    "description": "<string>",
    "preamble": "<string>",
    "lang": "<string>",
    "pokeMessages": [
      "<string>"
    ],
    "realTime": true,
    "silenceThreshold": 123,
    "interrupt": true,
    "outcome": "<string>",
    "outcomeResponseShape": {
      "type": "object",
      "properties": {
        "test": {
          "type": "number",
          "description": "Hello world from Hamsa AI!"
        }
      },
      "required": [
        "test"
      ]
    },
    "projectId": "<string>",
    "apiKeyId": "<string>",
    "voiceRecordId": "<string>",
    "voiceRecord": {},
    "webhookUrl": "https://example.com/webhook",
    "webhookAuth": {
      "authKey": "Token",
      "authSecret": "Secret"
    },
    "params": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token <api-key>'

Path Parameters

​
voiceAgentId
string
required

Body

application/json
​
agentName
string
​
greetingMessage
string

Greeting Message can be customized by adding params like: {{name}}, to make the message more personal!

​
preamble
any

Preamble can be customized by adding params like: {{agentName}}, to make the prompt more specific and context aware!

​
lang
enum<string>
Available options:
ar,
en
​
pokeMessages
string[]

The messages to say to the user when he doesn't respond!

​
realTime
boolean
​
silenceThreshold
integer
​
interrupt
boolean
​
outcome
string

A prompt to take the conversation and transform it to anything you like, like creating an article out of the conversation!

​
outcomeResponseShape
object

Recursive OpenAPI-style shape with 'type', 'properties', 'required', 'items', ...etc. Please refer to the OpenAPI Outcome Response Instructions above for more information.

Example:
{
  "type": "object",
  "properties": {
    "test": {
      "type": "number",
      "description": "Hello world from Hamsa AI!"
    }
  },
  "required": ["test"]
}
​
webhookUrl
string<uri> | null
Example:

"https://example.com/webhook"

​
webhookAuth
object

Authorization header to be sent in this format: Authorization: [authKey] [authSecret]

​
voiceId
enum<string>

For trying voices and choosing one by yourself, or event cloning a voice, please visit Hamsa Agents platform voices tab here.

Available options:
ab55c68b-091b-43b4-a55a-0be82093cd23,
79f81a3b-10f7-4eea-b0aa-5bd0b887d8cd,
f87b58a6-dd88-4f77-86e4-10099e8412c8,
35189a1c-afbd-4ab7-9aa2-1af88c70ac63,
88d45604-12e9-4f7a-93bf-e16cf04c9214,
2ef6405e-7313-4b5e-b738-b0536ed0a36a,
9bead147-7ae5-47aa-80d3-f54668568a69,
e2803890-f4dd-46f7-bfc6-1d3dc761c8ae,
ac5ca565-175c-48d8-98dc-2fccc906cf4b,
fb4d10c0-295d-43a9-9d8e-8775144b4b23,
3c249172-a61a-4a72-9375-1591b73d7ef6,
21f9d3fc-ae8b-41a2-9165-a3186433ae3c,
8e9f526c-eb30-417d-9e7a-65f704917fcc,
8a97dfe8-fe9d-40c5-8f94-7bf9b142e254
​
tools
object
​
params
object

Set the params you define in the greeting message or preamble fields here, the key is the same as the param and the value is the param value. Press 'Add new property' below to set the param name then press enter, after that add the value.

Response

Successful response

​
success
boolean
default:false
​
message
string
default:success
​
data
object