Create Voice Agent Route

POST

voice-agents

Authorizations

Authorization

string

headerrequired

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

voice

enum<string>

default: ar-msa

Available options:

ar-msa,

en-default,

ar-gulf

pokeMessages

string[]

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

realTime

boolean

default: false

silenceThreshold

integer

default: 800

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

string

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

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.

googleCalendarSettings

object

Send it only if the tools.googleCalendar is true.

googleCalendarSettings.calendarId

string

The calendar id from the Google Calendar integration response.

googleCalendarSettings.eventTitle

string

default: New meeting by {agentName}

A customized event title to be written to the booked meeting by the system.

googleCalendarSettings.calendarName

string

The calendar name from the Google Calendar integration response.

googleCalendarSettings.accessToken

string

The access token from the Google Calendar integration response.

googleCalendarSettings.refreshToken

string

The refresh token from the Google Calendar integration APIs.

googleCalendarSettings.meetingDuration

number

googleCalendarSettings.timezone

enum<string>

Available options:

Pacific/Niue,

Pacific/Pago_Pago,

Pacific/Honolulu,

Pacific/Rarotonga,

Pacific/Tahiti,

Pacific/Marquesas,

America/Adak,

Pacific/Gambier,

America/Anchorage,

America/Juneau,

America/Metlakatla,

America/Nome,

America/Sitka,

America/Yakutat,

Pacific/Pitcairn,

America/Dawson,

America/Dawson_Creek,

America/Creston,

America/Whitehorse,

America/Phoenix,

America/Fort_Nelson,

America/Vancouver,

America/Los_Angeles,

America/Tijuana,

America/Hermosillo,

Pacific/Galapagos,

America/Boise,

America/Denver,

America/Inuvik,

America/Yellowknife,

America/Cambridge_Bay,

America/Ojinaga,

America/Edmonton,

Pacific/Easter,

America/Mazatlan,

America/Chihuahua,

America/Belize,

America/Guatemala,

America/Costa_Rica,

America/Managua,

America/Regina,

America/El_Salvador,

America/Swift_Current,

America/Tegucigalpa,

America/Rio_Branco,

America/Eirunepe,

America/Cancun,

America/Atikokan,

America/Panama,

America/Jamaica,

America/Bogota,

America/Lima,

America/Bahia_Banderas,

America/North_Dakota/Beulah,

America/Winnipeg,

America/Matamoros,

America/Menominee,

America/Merida,

America/Mexico_City,

America/Monterrey,

America/Indiana/Knox,

America/North_Dakota/New_Salem,

America/Rankin_Inlet,

America/Resolute,

America/Rainy_River,

America/Indiana/Tell_City,

America/North_Dakota/Center,

America/Chicago,

America/Guayaquil,

America/Boa_Vista,

America/Campo_Grande,

America/Cuiaba,

America/Manaus,

America/Porto_Velho,

America/Barbados,

America/Blanc-Sablon,

America/Curacao,

America/Martinique,

America/Port_of_Spain,

America/Puerto_Rico,

America/Santo_Doming,

America/La_Paz,

America/Caracas,

America/Indiana/Vevay,

America/Indiana/Vincennes,

America/Grand_Turk,

America/Detroit,

America/Iqaluit,

America/Indiana/Indianapolis,

America/Kentucky/Louisville,

America/Indiana/Marengo,

America/Kentucky/Monticello,

America/Nassau,

America/Nipigon,

America/New_York,

America/Pangnirtung,

America/Indiana/Petersburg,

America/Port-au-Prince,

America/Thunder_Bay,

America/Toronto,

America/Indiana/Winamac,

America/Guyana,

America/Havana,

America/Asuncion,

America/Santiago,

America/Argentina/Buenos_Aires,

America/Argentina/Jujuy,

America/Argentina/Catamarca,

America/Argentina/Cordoba,

America/Argentina/La_Rioja,

America/Argentina/Mendoza,

America/Argentina/Rio_Gallegos,

America/Argentina/Salta,

America/Argentina/San_Luis,

America/Argentina/San_Juan,

America/Argentina/Tucuman,

America/Argentina/Ushuaia,

Atlantic/Bermuda,

America/Halifax,

America/Glace_Bay,

America/Goose_Bay,

America/Moncton,

America/Thule,

America/Araguaina,

America/Bahia,

America/Belem,

America/Maceio,

America/Recife,

America/Sao_Paulo,

America/Santarem,

America/Fortaleza,

Antarctica/Palmer,

America/Punta_Arenas,

Antarctica/Rothera,

America/Paramaribo,

America/Montevideo,

Atlantic/Stanley,

America/Cayenne,

America/St_Johns,

America/Nuuk,

America/Miquelon,

America/Noronha,

Atlantic/South_Georgia,

Atlantic/Cape_Verde,

Atlantic/Azores,

America/Scoresbysund,

UTC,

Etc/GMT,

Africa/Abidjan,

Africa/Accra,

Africa/Bissau,

America/Danmarkshavn,

Africa/Monrovia,

Atlantic/Reykjavik,

Africa/Sao_Tome,

Europe/London,

Africa/Lagos,

Africa/Ndjamena,

Atlantic/Canary,

Europe/Lisbon,

Atlantic/Madeira,

Atlantic/Faroe,

Africa/El_Aaiun,

Europe/Dublin,

Africa/Casablanca,

Africa/Algiers,

Africa/Tunis,

Africa/Cairo,

Europe/Kaliningrad,

Africa/Tripoli,

Antarctica/Troll,

Africa/Windhoek,

Africa/Juba,

Africa/Maputo,

Africa/Khartoum,

Europe/Amsterdam,

Europe/Andorra,

Europe/Belgrade,

Europe/Berlin,

Europe/Brussels,

Europe/Budapest,

Europe/Warsaw,

Europe/Vienna,

Europe/Gibraltar,

Europe/Copenhagen,

Europe/Luxembourg,

Europe/Madrid,

Europe/Malta,

Europe/Monaco,

Europe/Oslo,

Europe/Paris,

Europe/Prague,

Europe/Rome,

Africa/Ceuta,

Europe/Stockholm,

Europe/Tirane,

Europe/Zurich,

Africa/Johannesburg,

Europe/Volgograd,

Africa/Nairobi,

Asia/Amman,

Europe/Athens,

Asia/Beirut,

Europe/Bucharest,

Europe/Vilnius,

Asia/Gaza,

Asia/Damascus,

Europe/Zaporozhye,

Europe/Kiev,

Europe/Chisinau,

Asia/Nicosia,

Europe/Riga,

Europe/Sofia,

Europe/Tallinn,

Europe/Uzhgorod,

Asia/Hebron,

Europe/Helsinki,

Asia/Jerusalem,

Europe/Kirov,

Europe/Minsk,

Europe/Moscow,

Europe/Simferopol,

Asia/Baghdad,

Asia/Qatar,

Asia/Riyadh,

Antarctica/Syowa,

Europe/Istanbul,

Asia/Famagusta,

Asia/Baku,

Asia/Yerevan,

Europe/Astrakhan,

Asia/Tbilisi,

Indian/Mauritius,

Asia/Dubai,

Indian/Reunion,

Europe/Samara,

Europe/Saratov,

Indian/Mahe,

Europe/Ulyanovsk,

Asia/Kabul,

Asia/Tehran,

Asia/Yekaterinburg,

Asia/Aqtau,

Asia/Aqtobe,

Asia/Atyrau,

Asia/Qyzylorda,

Asia/Oral,

Indian/Maldives,

Antarctica/Mawson,

Asia/Karachi,

Asia/Dushanbe,

Asia/Ashgabat,

Asia/Samarkand,

Asia/Tashkent,

Indian/Kerguelen,

Asia/Kolkata,

Asia/Colombo,

Asia/Kathmandu,

Asia/Dhaka,

Asia/Thimphu,

Antarctica/Vostok,

Asia/Almaty,

Asia/Qostanay,

Indian/Chagos,

Asia/Bishkek,

Asia/Omsk,

Asia/Urumqi,

Indian/Cocos,

Asia/Yangon,

Asia/Barnaul,

Antarctica/Davis,

Asia/Jakarta,

Asia/Pontianak,

Asia/Bangkok,

Asia/Ho_Chi_Minh,

Asia/Krasnoyarsk,

Asia/Novokuznetsk,

Asia/Novosibirsk,

Indian/Christmas,

Asia/Tomsk,

Asia/Hovd,

Asia/Brunei,

Asia/Hong_Kong,

Australia/Perth,

Asia/Irkutsk,

Asia/Macau,

Asia/Shanghai,

Asia/Kuala_Lumpur,

Asia/Kuching,

Asia/Singapore,

Asia/Taipei,

Asia/Ulaanbaatar,

Asia/Choibalsan,

Asia/Manila,

Asia/Makassar,

Australia/Eucla,

Asia/Jayapura,

Asia/Dili,

Asia/Pyongyang,

Asia/Seoul,

Pacific/Palau,

Asia/Khandyga,

Asia/Chita,

Asia/Yakutsk,

Asia/Tokyo,

Australia/Adelaide,

Australia/Broken_Hill,

Australia/Darwin,

Asia/Vladivostok,

Asia/Ust-Nera,

Antarctica/Macquarie,

Australia/Melbourne,

Australia/Sydney,

Australia/Hobart,

Australia/Brisbane,

Australia/Lindeman,

Antarctica/DumontDUrville,

Pacific/Port_Moresby,

Pacific/Chuuk,

Pacific/Guam,

Australia/Lord_Howe,

Pacific/Bougainville,

Pacific/Efate,

Antarctica/Casey,

Pacific/Kosrae,

Asia/Magadan,

Pacific/Noumea,

Pacific/Norfolk,

Pacific/Pohnpei,

Asia/Sakhalin,

Pacific/Guadalcanal,

Asia/Srednekolymsk,

Asia/Anadyr,

Pacific/Kwajalein,

Pacific/Majuro,

Pacific/Nauru,

Pacific/Auckland,

Pacific/Tarawa,

Asia/Kamchatka,

Pacific/Funafuti,

Pacific/Wallis,

Pacific/Wake,

Pacific/Fiji,

Pacific/Chatham,

Pacific/Apia,

Pacific/Enderbury,

Pacific/Fakaofo,

Pacific/Tongatapu

googleCalendarSettings.freeSlots

object

You can choose what days to send and what days to leave!

Response

200 - application/json

error

boolean

data

object

Transcribe Route Clone Voice Agent Route

API Documentation

SDK Documentation

Voice Enablement

Transcription Routes

Voice Agents Routes

Voice Agents Conversations Routes

AI Content Routes

Job Routes

Project Routes

API Statistics Routes

Create Voice Agent Route

Authorizations

Body

Response