Create an AI agent with a prompt.
The only required parameter is
prompt. But the others are quite powerful, so we recommend trying them out!
|Establishes the initial set of instructions and settings to configure the agent.
This is a required parameter.
|The final set of instructions and configuration settings to send to the agent.
|The URL to which to send status callbacks and reports.
|Auth username for
|Auth password for
|A JSON object containing parameters as key-value pairs.
|An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue.
|An array of hints (as strings) to provide context to the dialogue.
|An array of JSON objects defining supported languages in the conversation.
|An array of JSON objects to clarify the AI's pronunciation of words or expressions.
|Enable verbose logging.
|A URL for the hold music to play, accepting WAV, mp3, and FreeSWITCH tone_stream.
|Enables hold music during SWAIG processing.
|Each interaction between the AI and end user is posted in real time to the established URL.
|Enables debugging to the set URL. If a URL is set, this param defaults to 1.
|Instructs the agent to acknowledge crosstalk and confirm user input when the user speaks over the agent.
|Provide a prompt for the agent to handle crosstalk.
|When enabled, barges agent upon any sound interruption longer than 1 second.
|Check for input function with
check_for_input. Example use case: Feeding an inbound SMS to AI on a voice call, eg., for collecting an email address or other complex information.
|Set the AI volume with numerical values between
|Takes a string, including a regular expression, defining barge behavior. For example, this param can direct the AI to stop when the word "hippopotomus" is input.
|Defines the number of words that must be input before triggering barge behavior, in a range of 1-99.
|Allows your SWAIG to return SWML to be executed.
|Allows tweaking any of the indicated settings, such as barge_match_string, using the returned SWML from the SWAIG function.
|Post entire conversation to any SWAIG call.
save_conversation to identify an individual conversation.
|Pass a summary of a conversation from one AI agent to another. For example, transfer a call summary between support agents in two departments.
|Performs an additional call to save the current conversation summary by conversation ID. Use this param to preserve conversation context between calls.
|Takes a time zone string. For example: UTC+5, America/New_York, or any other convention defined by the International Bureau of Weights and Measures (BIPM).
|Defines a file via URL to play background noise.
background_file behavior to loop if
background_file volume within a range of
|Sets time duration to wait for DTMF before timing out, in a range from
|Sets a digit, such as a pound (
#) sign, to terminate input. Fun fact: The pound sign is also known as an "octothorp."
|Sets a time duration for the agent to wait after speech before timing out, in a range between
|Sets voice detection threshold for user speech, in a range from
|Sets a time duration for the user to respond to the AI agent before timeout, in a range from
|Sets a time duration for the user to speak before timeout, in a range from
|Sets a time duration for the outbound call recipient to respond to the AI agent before timeout, in a range from
|Allows multilingualism when
|Sets the prompt which binds the agent to its purpose.
|A powerful and flexible environmental variable which can accept arbitrary data. All contained information can be accessed and expanded within the prompt - for example, by using a template string.