params
Parameters for AI that can be passed in ai.params at the top level of the ai method.
These parameters control the fundamental behavior and capabilities of the AI agent, including model selection, conversation management, and advanced features like thinking and vision.
Properties
ai.params
An object that accepts the following properties.
params.ai_model
The AI model that the AI Agent will use during the conversation.
params.ai_name
Sets the name the AI agent responds to for wake/activation purposes. When using enable_pause, start_paused, or speak_when_spoken_to, the user must say this name to get the agent’s attention. The name matching is case-insensitive.
params.app_name
A custom identifier for the AI application instance. This name is included in webhook payloads (post_prompt_url, SWAIG function calls), allowing backend systems to identify which AI configuration made the request.
params.conscience
Sets the prompt which binds the agent to its purpose. This prompt helps reinforce the AI’s behavior after SWAIG function calls.
It is used to reinforce the AI agent’s behavior and guardrails throughout the conversation.
params.convo
Injects pre-existing conversation history into the AI session at startup. This allows you to seed the AI agent with context from a previous conversation or provide example interactions.
convo[].role
The role of the message sender. Valid values:
user- A message from the human caller/user interacting with the AI agent.assistant- A message from the AI agent itself.system- A system message providing instructions or context to guide the AI’s behavior.
convo[].content
The text content of the message.
convo[].lang
The language code for the message. Uses standard ISO language codes such as en, en-US, es, fr, de, etc.
params.conversation_id
Used by check_for_input and save_conversation to identify an individual conversation.
params.conversation_sliding_window
Sets the size of the sliding window for conversation history. This limits how much conversation history is sent to the AI model.
params.direction
Forces the direction of the call to the assistant. Valid values are inbound and outbound.
params.enable_inner_dialog
Enables the inner dialog feature, which runs a separate AI process in the background that analyzes the conversation and provides real-time insights to the main AI agent. This gives the agent a form of “internal thought process” that can help it make better decisions.
params.enable_pause
Enables the pause/resume functionality for the AI agent. When enabled, a pause_conversation function is automatically added that the AI can call when the user says things like “hold on”, “wait”, or “pause”. While paused, the agent stops responding until the user speaks the agent’s name (set via ai_name) to resume. Cannot be used together with speak_when_spoken_to.
params.enable_thinking
Enables thinking output for the AI Agent. When set to true, the AI Agent will be able to utilize thinking capabilities. This may introduce a little bit of latency as the AI will use an additional turn in the conversation to think about the query.
params.enable_turn_detection
Enables intelligent turn detection that monitors partial speech transcripts for sentence-ending punctuation. When detected, the system can proactively finalize the speech recognition, reducing latency before the AI responds. Works with turn_detection_timeout.
params.enable_vision
Enables visual input processing for the AI Agent. When set to true, the AI Agent will be able to utilize visual processing capabilities. The image used for visual processing will be gathered from the user’s camera if video is available on the call, leveraging the get_visual_input function.
params.languages_enabled
Allows multilingualism when true.
params.local_tz
The local timezone setting for the AI. Value should use IANA TZ ID
params.save_conversation
Send a summary of the conversation after the call ends. This requires post_prompt_url to be set and the conversation_id defined. This eliminates the need for a post_prompt in the ai parameters.
params.summary_mode
Summary generation mode. Valid values: "string", "original".
params.thinking_model
The AI model that the AI Agent will use when utilizing thinking capabilities.
params.transfer_summary
Pass a summary of a conversation from one AI agent to another. For example, transfer a call summary between support agents in two departments.
params.vision_model
The AI model that the AI Agent will use when utilizing vision capabilities.
params.wait_for_user
When false, AI agent will initialize dialogue after call is setup. When true, agent will wait for the user to speak first.
Speech Recognition
Configure how the AI agent processes and understands spoken input, including speaker identification, voice activity detection, and transcription settings.
params.asr_diarize
If true, enables speaker diarization in ASR (Automatic Speech Recognition). This will break up the transcript into chunks, with each chunk containing a unique identity (e.g speaker1, speaker2, etc.) and the text they spoke.
params.asr_smart_format
Enables smart formatting in ASR (Automatic Speech Recognition). This improves the formatting of numbers, dates, times, and other entities in the transcript.
params.asr_speaker_affinity
If true, will force the AI Agent to only respond to the speaker who responds to the AI Agent first. Any other speaker will be ignored.
params.end_of_speech_timeout
Amount of silence, in ms, at the end of an utterance to detect end of speech. Allowed values from 0-10,000.
params.energy_level
Amount of energy necessary for bot to hear you (in dB). Allowed values from 0.0-100.0.
params.first_word_timeout
Amount of time, in ms, to wait for the first word after speech is detected. Allowed values from 0-10,000.
params.llm_diarize_aware
If true, the AI Agent will be involved with the diarization process. Users can state who they are at the start of the conversation and the AI Agent will be able to correctly identify them when they are speaking later in the conversation.
params.openai_asr_engine
The ASR (Automatic Speech Recognition) engine to use. Common values include deepgram:nova-2, deepgram:nova-3, and other supported ASR engines.
Speech Synthesis
Customize the AI agent’s voice output, including volume control, voice characteristics, emotional range, and video avatars for visual interactions.
params.ai_volume
Adjust the volume of the AI. Allowed values from -50-50.
params.max_emotion
Maximum emotion intensity for text-to-speech. Allowed values from 1-30.
params.speech_gen_quick_stops
Number of quick stops for speech generation. Allowed values from 0-10.
params.tts_number_format
The format of the number the AI will reference the phone number. Valid values: international (e.g. +12345678901) or national (e.g. (234) 567-8901).
params.video_idle_file
URL of a video file to play when AI is idle. Only works for calls that support video.
params.video_listening_file
URL of a video file to play when AI is listening to the user speak. Only works for calls that support video.
params.video_talking_file
URL of a video file to play when AI is talking. Only works for calls that support video.
params.eleven_labs_similarity
The similarity slider dictates how closely the AI should adhere to the original voice when attempting to replicate it. The higher the similarity, the closer the AI will sound to the original voice. Valid values range from 0.0 to 1.0. Deprecated: Use languages[].params.similarity instead.
params.eleven_labs_stability
The stability slider determines how stable the voice is and the randomness between each generation. Lowering this slider introduces a broader emotional range for the voice. Valid values range from 0.0 to 1.0. Deprecated: Use languages[].params.stability instead.
Interruption & Barge Control
Manage how the AI agent handles interruptions when users speak over it, including when to stop speaking, acknowledge interruptions, or continue regardless.
params.acknowledge_interruptions
Instructs the agent to acknowledge crosstalk and confirm user input when the user speaks over the agent. Can be boolean or a positive integer specifying the maximum number of interruptions to acknowledge.
params.barge_functions
Allow functions to be called during barging. When false, functions are not executed if the user is speaking.
params.barge_match_string
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.
params.barge_min_words
Defines the number of words that must be input before triggering barge behavior. Allowed values from 1-99.
params.enable_barge
Controls when user can interrupt the AI. Valid values: "complete", "partial", "all", or boolean. Set to false to disable barging.
params.interrupt_on_noise
When enabled, barges agent upon any sound interruption longer than 1 second. Can be boolean or a positive integer specifying the threshold.
params.interrupt_prompt
A prompt that is used to help the AI agent respond to interruptions.
Default: “The user didn’t wait for you to finish responding and started talking over you. As part of your next response, make a comment about how you were both talking at the same time and verify you properly understand what the user said.”
params.transparent_barge
When enabled, the AI will not respond to the user’s input when the user is speaking over the agent. The agent will wait for the user to finish speaking before responding. Additionally, any attempt the LLM makes to barge will be ignored and scraped from the conversation logs.
params.transparent_barge_max_time
Maximum duration for transparent barge mode. Allowed values from 0-60,000 ms.
Timeouts & Delays
Set various timing parameters that control wait times, response delays, and session limits to optimize the conversation flow and prevent dead air.
params.attention_timeout
Amount of time, in ms, to wait before prompting the user to respond. Allowed values: 0 (to disable) or 10,000-600,000.
params.attention_timeout_prompt
A custom prompt that is fed into the AI when the attention_timeout is reached.
params.digit_timeout
Time, in ms, at the end of digit input to detect end of input. Allowed values from 0-30,000.
params.hard_stop_prompt
A final prompt that is fed into the AI when the hard_stop_time is reached.
params.hard_stop_time
Specifies the maximum duration for the AI Agent to remain active before it exits the session. After the timeout, the AI will stop responding, and will proceed with the next SWML instruction. Time format: 30s (seconds), 2m (minutes), 1h (hours), or combined 1h45m30s.
params.inactivity_timeout
Amount of time, in ms, to wait before exiting the app due to inactivity. Allowed values: 0 (to disable) or 10,000-3,600,000.
params.initial_sleep_ms
Amount of time, in ms, to wait before the AI Agent starts processing. Allowed values from 0-300,000.
params.outbound_attention_timeout
Sets a time duration for the outbound call recipient to respond to the AI agent before timeout. Allowed values from 10,000-600,000 ms.
params.speech_event_timeout
Timeout for speech events processing. Allowed values from 0-10,000 ms.
params.speech_timeout
Overall speech timeout (developer mode only). Allowed values from 0-600,000 ms.
Audio & Media
Control background audio, hold music, and greeting messages to enhance the caller experience during different phases of the conversation.
params.background_file
URL of audio file to play in the background while AI plays in foreground.
params.background_file_loops
Maximum number of times to loop playing the background file.
params.background_file_volume
Defines background_file volume. Allowed values from -50 to 50.
params.hold_music
A URL for the hold music to play, accepting WAV, mp3, and FreeSWITCH tone_stream.
params.hold_on_process
Enables hold music during SWAIG processing.
params.static_greeting
The static greeting to play when the call is answered. This will always play at the beginning of the call.
params.static_greeting_no_barge
If true, the static greeting will not be interrupted by the user if they speak over the greeting. If false, the static greeting can be interrupted by the user if they speak over the greeting.
SWAIG Functions
Configure SignalWire AI Gateway (SWAIG) function capabilities, including permissions, execution timing, and data persistence across function calls.
params.function_wait_for_talking
If true, the AI will wait for any filler to finish playing before executing a function. If false, the AI will asynchronously execute a function while playing a filler.
params.functions_on_no_response
Execute functions when the user doesn’t respond (on attention timeout).
params.swaig_allow_settings
Allows tweaking any of the indicated settings, such as barge_match_string, using the returned SWML from the SWAIG function.
params.swaig_allow_swml
Allows your SWAIG to return SWML to be executed.
params.swaig_post_conversation
Post entire conversation to any SWAIG call.
params.swaig_set_global_data
Allows SWAIG functions to set global data that persists across function calls.
Input & DTMF
Handle dual-tone multi-frequency (DTMF) input and configure input polling for integrating external data sources during conversations.
params.digit_terminators
DTMF digit, as a string, to signal the end of input (ex: ”#”)
params.input_poll_freq
Check for input function with check_for_input. Allowed values from 1,000-10,000 ms. Example use case: Feeding an inbound SMS to AI on a voice call, eg., for collecting an email address or other complex information.
Debug & Development
Enable debugging tools, logging, and performance monitoring features to help developers troubleshoot and optimize their AI agent implementations.
params.audible_debug
If true, the AI will announce the function that is being executed on the call.
params.audible_latency
Announce latency information during the call for debugging purposes.
params.cache_mode
Enable response caching to improve performance for repeated queries.
params.debug
Enables debug mode for the AI session. When set to true or a positive integer, additional debug information is logged and may be included in webhook payloads. Higher integer values increase verbosity.
params.debug_webhook_level
Enables debugging to the set URL. Allowed values from 0-2. Level 0 disables, 1 provides basic info, 2 provides verbose info.
params.debug_webhook_url
Each interaction between the AI and end user is posted in real time to the established URL. Authentication can also be set in the url in the format of username:password@url.
params.enable_accounting
Enable usage accounting and tracking for billing and analytics purposes.
params.verbose_logs
Enable verbose logging (developer mode only).
Inner Dialog
Configure the inner dialog feature, which enables a secondary AI process to analyze conversations in real-time and provide insights to the main AI agent.
params.inner_dialog_model
Specifies the AI model to use for the inner dialog feature. If not set, the main ai_model is used. This allows you to use a different (potentially faster or cheaper) model for background analysis.
params.inner_dialog_prompt
The system prompt that guides the inner dialog AI’s behavior. This prompt shapes how the background AI analyzes the conversation and what kind of insights it provides to the main agent.
params.inner_dialog_synced
When enabled, synchronizes the inner dialog with the main conversation flow. This ensures the inner dialog AI waits for the main conversation turn to complete before providing its analysis, rather than running fully asynchronously.
Pause & Wake
Control the agent’s listening behavior, including pause/resume functionality and activation triggers for hands-free scenarios.
params.speak_when_spoken_to
When enabled, the AI agent remains silent until directly addressed by name (set via ai_name). This creates a “push-to-talk” style interaction where the agent only responds when explicitly called upon, useful for scenarios where the agent should listen but not interrupt.
params.start_paused
When enabled, the AI agent starts in a paused state. The agent will not respond to any input until the user speaks the agent’s name (set via ai_name) to activate it. This is useful for scenarios where you want the agent to wait for explicit activation.
params.wake_prefix
Specifies an additional prefix that must be spoken along with the agent’s name to wake the agent. For example, if ai_name is “assistant” and wake_prefix is “hey”, the user would need to say “hey assistant” to activate the agent.
Advanced Configuration
Fine-tune advanced AI behavior settings including response limits, data persistence, prompt formatting, and voice activity detection.
params.max_response_tokens
Sets the maximum number of tokens the AI model can generate in a single response. Allowed values from 1 to 16384. This helps control response length and costs.
params.persist_global_data
When enabled, global_data persists across multiple AI agent invocations within the same call. This allows data set by SWAIG functions to be retained if the AI agent is invoked multiple times during a single call session.
params.pom_format
Specifies the output format for structured prompts sent to the AI model. Valid values are markdown or xml. This affects how system prompts and context are formatted when sent to the underlying language model.
params.swaig_post_swml_vars
Controls whether SWML variables are included in SWAIG function webhook payloads. When set to true, all SWML variables are posted. When set to an array of strings, only the specified variable names are included in the payload.
params.turn_detection_timeout
Time in milliseconds to wait after detecting a potential end-of-turn before finalizing speech recognition. Works with enable_turn_detection. Lower values make the agent more responsive but may cut off users mid-sentence. Allowed values from 0 to 10000.
params.vad_config
Configures Silero Voice Activity Detection (VAD) settings. Format: threshold or threshold:frame_ms. The threshold (0-100) sets sensitivity for voice detection, and optional frame_ms (16-40) sets the analysis frame duration in milliseconds.
