For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
ReferenceGuides
ReferenceGuides
  • Core
    • Introduction to SWML
    • Expressions
    • Template functions
    • Variables
    • Errors
  • Calling
    • Overview
    • ai
    • ai_sidecar
      • params
      • prompt
      • SWAIG
    • amazon_bedrock
    • answer
    • cond
    • connect
    • denoise
    • detect_machine
    • enter_queue
    • execute
    • goto
    • hangup
    • join_conference
    • join_room
    • label
    • live_transcribe
    • live_translate
    • pay
    • play
    • prompt
    • receive_fax
    • record
    • record_call
    • request
    • return
    • send_digits
    • send_fax
    • send_sms
    • set
    • sip_refer
    • sleep
    • stop_denoise
    • stop_record_call
    • stop_tap
    • switch
    • tap
    • transcribe
    • transcribe_stop
    • transfer
    • unset
    • user_event
  • Messaging
    • Overview
    • execute
    • goto
    • label
    • receive
    • reply
    • request
    • return
    • switch
    • transfer
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Properties
  • Reaction
  • Summaries
  • Transcription
  • Debug
Callingai_sidecar

params

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

prompt

Next
Built with

Tuning options that can be passed in ai_sidecar.params of the ai_sidecar method. All of these parameters are optional.

Properties

ai_sidecar.params
object

An object that accepts the following properties.

Reaction

Control how often the sidecar evaluates the conversation, how quickly it reacts to the customer, and whether tool actions take effect on the call.

params.idle_timeout_ms
integerDefaults to 200

How long the customer can be silent, in milliseconds, after they finish speaking before the sidecar evaluates the conversation. Lower values make the sidecar react faster. If the agent speaks while the customer’s turn is still pending, the sidecar evaluates immediately without waiting. Range: 50-5000.

params.min_interval_ms
integerDefaults to 0

The minimum time, in milliseconds, between evaluations — a throttle that limits how often the sidecar runs on a busy call. Range: 0-60000.

params.max_iters_per_tick
integerDefaults to 5

The maximum number of tool calls the sidecar will chain within a single evaluation before it must produce its advice. Range: 1-20.

params.max_history_tokens
integerDefaults to 8000

The token budget for the sidecar’s running conversation history. When the history grows past this, the oldest messages are dropped. Range: 1000-200000.

params.act_on_channel
booleanDefaults to true

Whether actions returned by your tools (such as transferring or hanging up the call) take effect on the call, or are only reported as callbacks.

Summaries

Generate summaries when the call ends.

params.final_summary
booleanDefaults to false

Whether to generate a closing summary of the sidecar’s session when the call ends. The result is included in the final callback.

params.ai_summary
booleanDefaults to false

Whether to generate an end-of-call summary of the conversation itself, distinct from final_summary (which summarizes the sidecar’s session).

params.ai_summary_prompt
string

A custom prompt for the end-of-call conversation summary.

params.summary_model
stringDefaults to gpt-4o-mini

The model used for the end-of-call conversation summary, distinct from model (the sidecar’s own model). Suggested values: gpt-4o-mini, gpt-4.1-mini, gpt-4.1-nano.

Transcription

Configure speech recognition and per-utterance callbacks.

params.live_events
booleanDefaults to false

Whether to emit a callback for each utterance the speech recognizer produces.

params.verbose_utterances
booleanDefaults to false

Whether each utterance callback includes full speech-recognition detail, such as word timings and alternatives. This increases the callback size, so leave it off unless you need it.

params.speech_engine
stringDefaults to deepgram

The speech recognition engine to use. Possible values: deepgram, google.

params.speech_timeout
integer

How long, in milliseconds, the recognizer waits before finalizing speech. Defaults to the speech engine’s own default.

params.vad_silence_ms
integer

The amount of silence, in milliseconds, used to detect the end of speech. Defaults to the speech engine’s own default.

params.vad_thresh
integer

How sensitively the recognizer detects speech. Defaults to the speech engine’s own default.

params.transcribe_prompt
string

A bias prompt passed to the speech recognizer to improve accuracy on expected terms, such as product or company names. This is distinct from the operator prompt.

Debug

Enable extra logging to help troubleshoot a sidecar.

params.debug_level
integerDefaults to 0

Speech-engine debug verbosity. Range: 0-100.

params.debug
booleanDefaults to false

Whether to enable verbose logging for the sidecar.