POST
/
v1
/
voice-agents
curl --request POST \
  --url https://api.tryhamsa.com/v1/voice-agents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agentName": "<string>",
  "greetingMessage": "Hello, how can I help you today?",
  "preamble": "You are a helpful assistant that will answer users questions.",
  "lang": "ar",
  "pokeMessages": [],
  "realTime": false,
  "silenceThreshold": 800,
  "interrupt": false,
  "outcome": null,
  "voiceId": "1f3396aa-24e3-4523-b4ef-7dd4adb8fab9",
  "tools": {
    "googleCalendar": false,
    "genderDetection": false,
    "smartCallEnd": false
  },
  "params": {},
  "googleCalendarSettings": {
    "calendarId": "<string>",
    "eventTitle": "New meeting by {agentName}",
    "calendarName": "<string>",
    "accessToken": "<string>",
    "refreshToken": "<string>",
    "meetingDuration": 123,
    "timezone": "Pacific/Niue",
    "freeSlots": {
      "Monday": [
        {
          "from": "<string>",
          "to": "<string>"
        }
      ],
      "Tuesday": [
        {
          "from": "<string>",
          "to": "<string>"
        }
      ],
      "Wednesday": [
        {
          "from": "<string>",
          "to": "<string>"
        }
      ],
      "Thursday": [
        {
          "from": "<string>",
          "to": "<string>"
        }
      ],
      "Friday": [
        {
          "from": "<string>",
          "to": "<string>"
        }
      ],
      "Saturday": [
        {
          "from": "<string>",
          "to": "<string>"
        }
      ],
      "Sunday": [
        {
          "from": "<string>",
          "to": "<string>"
        }
      ]
    }
  }
}'
{
  "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>",
    "projectId": "<string>",
    "apiKeyId": "<string>",
    "voiceRecordId": "<string>",
    "voiceRecord": {},
    "tools": {
      "id": "<string>",
      "calendarName": "<string>",
      "accessToken": "<string>",
      "refreshToken": "<string>",
      "freeSlots": {
        "Monday": [
          [
            {
              "from": "<string>",
              "to": "<string>"
            }
          ]
        ],
        "Tuesday": [
          [
            {
              "from": "<string>",
              "to": "<string>"
            }
          ]
        ],
        "Wednesday": [
          [
            {
              "from": "<string>",
              "to": "<string>"
            }
          ]
        ],
        "Thursday": [
          [
            {
              "from": "<string>",
              "to": "<string>"
            }
          ]
        ],
        "Friday": [
          [
            {
              "from": "<string>",
              "to": "<string>"
            }
          ]
        ],
        "Saturday": [
          [
            {
              "from": "<string>",
              "to": "<string>"
            }
          ]
        ],
        "Sunday": [
          [
            {
              "from": "<string>",
              "to": "<string>"
            }
          ]
        ]
      },
      "meetingDuration": 123,
      "timezone": "<string>",
      "voiceAgentToolsId": "<string>",
      "calendarId": "<string>",
      "eventTitle": "<string>"
    },
    "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>'

Body

application/json
​
agentName
string
required
​
greetingMessage
string
default:Hello, how can I help you today?

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

​
preamble
string
default:You are a helpful assistant that will answer users questions.

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

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

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

​
realTime
boolean
default:false
​
silenceThreshold
integer
default:800

The silence threshold in milliseconds. Minimum value is 1 millisecond.

Required range: x >= 1
​
interrupt
boolean
default:false
​
outcome
string

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

​
voiceId
enum<string>

You can find predefined voices in the voice agents dashboard, under the language tab

Available options:
1f3396aa-24e3-4523-b4ef-7dd4adb8fab9,
29709a36-7703-497f-b6e5-0d39b873f77d,
37665327-bfc7-4edf-a362-596a379865dc,
60ef35b1-056a-47d9-8f8f-6571f2106560,
8f14b3ee-beb6-4f9a-9819-02b45f7d48ff,
a2404aca-2c6d-47c7-ae9c-5ea317a30e60,
b1d24f8c-6d60-4fb5-8d06-708ba1bc89c2,
d23c0832-a642-4a59-8e93-fd0924abc46e,
d981c03a-2868-4de2-b097-e11ec231413c
​
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.

​
googleCalendarSettings
object

Send it only if the tools.googleCalendar is true.

Response

200
application/json
Successful response
​
success
boolean
default:false
​
message
string
default:success
​
data
object