--- title: "Get Resource" method: GET path: "/api/fabric/resources/{id}" tags: ["Resources"] --- # Get Resource `GET /api/fabric/resources/{id}` Returns a Resource by ID #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). ## Path parameters - `id` string, uuid, required — Universal Unique Identifier. ## Response `200` The request has succeeded. - union - ResourceResponseAI - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'ai_agent', required — The type of Resource - `ai_agent` AIAgent, required — An AI Agent configuration that extends the SWML AI object with additional API-specific properties. - `global_data` object — A key-value object for storing data that persists throughout the AI session. Can be set initially in the SWML script or modified during the conversation using the set_global_data action. The global_data object is accessible everywhere in the AI session: prompts, AI parameters, and SWML returned from SWAIG functions. Access properties using template strings (e.g. ${global_data.property_name}). - `hints` union[] — Hints help the AI agent understand certain words or phrases better. Words that can commonly be misinterpreted can be added to the hints to help the AI speak more accurately. - union - string - SWMLCallingHint - `hint` string, required — The hint to match. This will match the string exactly as provided - `pattern` string, required — A regular expression to match the hint against. This will ensure that the hint has a valid matching pattern before being replaced. - `replace` string, required — The text to replace the hint with. This will replace the portion of the hint that matches the pattern. - `ignore_case` union — If true, the hint will be matched in a case-insensitive manner. **Default:** `false`. - … - `languages` SWMLCallingLanguages[] — An array of JSON objects defining supported languages in the conversation. - union - SWMLCallingLanguagesWithSoloFillers - `name` string, required — Name of the language (e.g., 'French', 'English'). This value is used in the system prompt to instruct the LLM what language is being spoken. - `code` string, required — The language code for ASR (Automatic Speech Recognition) purposes. By default, SignalWire uses Deepgram's Nova-3 STT engine, so this value should match a code from Deepgram's Nova-3 language codes. If a different STT model was selected using the `openai_asr_engine` parameter, you must select a code supported by that engine. - `voice` string, required — Voice to use for the language. String format: `.`. Select engine from `gcloud`, `polly`, `elevenlabs`, `cartesia`, or `deepgram`. For example, `gcloud.fr-FR-Neural2-B`. - `model` string — The model to use for the specified TTS engine. For example, 'arcana'. - `emotion` 'auto' — Enables emotion detection for the set TTS engine. This allows the AI to express emotions when speaking. A global emotion or specific emotions for certain topics can be set within the prompt of the AI. IMPORTANT: Only works with [`Cartesia`](/docs/platform/voice/tts/cartesia) TTS engine. - `speed` 'auto' — The speed to use for the specified TTS engine. This allows the AI to speak at a different speed at different points in the conversation. The speed behavior can be defined in the prompt of the AI. IMPORTANT: Only works with [`Cartesia`](/docs/platform/voice/tts/cartesia) TTS engine. - `engine` string — The engine to use for the language. For example, 'elevenlabs'. - `params` SWMLCallingLanguageParams - … - `fillers` string[] — An array of strings to be used as fillers in the conversation. This will be used for both speech and function fillers if provided. - SWMLCallingLanguagesWithFillers - `name` string, required — Name of the language (e.g., 'French', 'English'). This value is used in the system prompt to instruct the LLM what language is being spoken. - `code` string, required — The language code for ASR (Automatic Speech Recognition) purposes. By default, SignalWire uses Deepgram's Nova-3 STT engine, so this value should match a code from Deepgram's Nova-3 language codes. If a different STT model was selected using the `openai_asr_engine` parameter, you must select a code supported by that engine. - `voice` string, required — Voice to use for the language. String format: `.`. Select engine from `gcloud`, `polly`, `elevenlabs`, `cartesia`, or `deepgram`. For example, `gcloud.fr-FR-Neural2-B`. - `model` string — The model to use for the specified TTS engine. For example, 'arcana'. - `emotion` 'auto' — Enables emotion detection for the set TTS engine. This allows the AI to express emotions when speaking. A global emotion or specific emotions for certain topics can be set within the prompt of the AI. IMPORTANT: Only works with [`Cartesia`](/docs/platform/voice/tts/cartesia) TTS engine. - `speed` 'auto' — The speed to use for the specified TTS engine. This allows the AI to speak at a different speed at different points in the conversation. The speed behavior can be defined in the prompt of the AI. IMPORTANT: Only works with [`Cartesia`](/docs/platform/voice/tts/cartesia) TTS engine. - `engine` string — The engine to use for the language. For example, 'elevenlabs'. - `params` SWMLCallingLanguageParams - … - `function_fillers` string[] — An array of strings to be used as fillers in the conversation when calling a `swaig function`. This helps the AI break silence between responses. The filler is played asynchronously during the function call. - `speech_fillers` string[] — An array of strings to be used as fillers in the conversation. This helps the AI break silence between responses. Note: `speech_fillers` are used between every 'turn' taken by the LLM, including at the beginning of the call. For more targeted fillers, consider using `function_fillers`. - `params` SWMLCallingAIParams - `acknowledge_interruptions` union — Instructs the agent to acknowledge crosstalk and confirm user input when the user speaks over the agent. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `ai_model` union — The model to use for the AI. Allowed values are `gpt-4o-mini`, `gpt-4.1-mini`, and `gpt-4.1-nano`. - 'gpt-4o-mini' | 'gpt-4.1-mini' | 'gpt-4.1-nano' - string - `ai_name` string — 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. - `ai_volume` union — Adjust the volume of the AI. Allowed values from `-50` - `50`. **Default:** `0`. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `app_name` string — A custom identifier for the AI application instance. This name is included in webhook payloads, allowing backend systems to identify which AI configuration made the request. - `asr_smart_format` union — If true, enables smart formatting in ASR (Automatic Speech Recognition). This improves the formatting of numbers, dates, times, and other entities in the transcript. **Default:** `false` - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `attention_timeout` union — Amount of time, in ms, to wait before prompting the user to respond. Allowed values from `10,000` - `600,000`. Set to `0` to disable. **Default:** `5000` ms (note: user-configurable values must be `0` or within the `10,000` - `600,000` range). - integer - 0 - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `attention_timeout_prompt` string — A custom prompt that is fed into the AI when the attention_timeout is reached. - `asr_diarize` union — 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. **Default:** `false` - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `asr_speaker_affinity` union — If true, will force the AI Agent to only respond to the speaker who reesponds to the AI Agent first. Any other speaker will be ignored. **Default:** `false` - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `audible_debug` union — If `true`, the AI will announce the function that is being executed on the call. **Default:** `false`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `audible_latency` union — If `true`, the AI will announce latency information during the call. Useful for debugging. **Default:** `false`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `background_file` string, uri — URL of audio file to play in the background while AI plays in foreground. - `background_file_loops` union — Maximum number of times to loop playing the background file. `undefined` means loop indefinitely. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `background_file_volume` union — Defines background_file volume within a range of `-50` to `50`. **Default:** `0`. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `enable_barge` union — Controls the barge behavior. Allowed values are `"complete"`, `"partial"`, `"all"`, or boolean. **Default:** `"complete,partial"` - string - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `enable_inner_dialog` union — 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. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `enable_pause` union — 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`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `enable_turn_detection` union — 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`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `barge_match_string` 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. - `barge_min_words` union — Defines the number of words that must be input before triggering barge behavior, in a range of `1-99`. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `barge_functions` union — If `true`, allows functions to be executed while the AI is being interrupted. **Default:** `true`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `cache_mode` union — If `true`, enables response caching for improved performance. **Default:** `false`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `conscience` string — Sets the prompt which binds the agent to its purpose. - `convo` SWMLCallingConversationMessage[] — 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. - `role` 'user' | 'assistant' | 'system', required - `content` string, required — The text content of the message. - `lang` string — Optional language code for the message (e.g., 'en', 'es', 'fr'). - `conversation_id` string — Used by `check_for_input` and `save_conversation` to identify an individual conversation. - `conversation_sliding_window` union — Sets the size of the sliding window for conversation history. This limits how much conversation history is sent to the AI model. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `debug_webhook_level` union — Enables debugging to the set URL. Allowed values from `0` - `2`. Default is `1` if url is set. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `debug_webhook_url` string, uri — Each interaction between the AI and end user is posted in real time to the established URL. - `debug` union — Enables debug mode for the AI session. When enabled, additional diagnostic information is logged including turn detection events, speech processing details, and internal state changes. - boolean - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `direction` union — Forces the direction of the call to the assistant. Valid values are `inbound` and `outbound`. - 'inbound' | 'outbound' - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `digit_terminators` string — DTMF digit, as a string, to signal the end of input (ex: '#') - `digit_timeout` union — Time, in ms, at the end of digit input to detect end of input. Allowed values from `0` - `30,000`. **Default:** `3000` ms. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `end_of_speech_timeout` union — Amount of silence, in ms, at the end of an utterance to detect end of speech. Allowed values from `250` - `10,000`. **Default:** `700` ms. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `enable_accounting` union — If `true`, enables usage accounting. The default is `false`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `enable_thinking` union — Enables thinking output for the AI Agent. When set to `true`, the AI Agent will be able to utilize thinking capabilities. **Important**: This may introduce a little bit of latency as the AI will use an additional turn in the conversation to think about the query. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `enable_vision` union — Enables visual input processing for the AI Agent. When set to `true`, the AI Agent will be able to utilize visual processing capabilities, while leveraging the `get_visual_input` function. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `energy_level` union — Amount of energy necessary for bot to hear you (in dB). Allowed values from `0.0` - `100.0`. **Default:** `52.0` dB. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `first_word_timeout` union — Amount of time, in ms, to wait for the first word after speech is detected. Allowed values from `0` - `10,000`. **Default:** `1000` ms. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `function_wait_for_talking` union — If `true`, the AI will wait for any `filler` to finish playing before executing a function. If `false`, the AI will execute a function asynchronously as the `filler` plays. **Default:** `false`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `functions_on_no_response` union — If `true`, functions can be executed when there is no user response after a timeout. **Default:** `false`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `hard_stop_prompt` string — A final prompt that is fed into the AI when the `hard_stop_time` is reached. - `hard_stop_time` string — Specifies the maximum duration fopr the AI Agent to remain active before it exists the session. After the timeout, the AI will stop responding, and will proceed with the next SWML instruction. **Time Format:** - Seconds Format: `30s` - Minutes Format: `2m` - Hours Format: `1h` - Combined Format: `1h45m30s` - `hold_music` string, uri — A URL for the hold music to play, accepting WAV, mp3, and FreeSWITCH tone_stream. - `hold_on_process` union — Enables hold music during SWAIG processing. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `inactivity_timeout` union — Amount of time, in ms, to wait before exiting the app due to inactivity. Allowed values from `10,000` - `3,600,000`. **Default:** `600000` ms (10 minutes). - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `inner_dialog_model` union — Specifies the AI model to use for the inner dialog feature. Can be set to a different (often smaller/faster) model than the main conversation model. Only used when `enable_inner_dialog` is `true`. - 'gpt-4o-mini' | 'gpt-4.1-mini' | 'gpt-4.1-nano' - string - `inner_dialog_prompt` string — 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. Only used when `enable_inner_dialog` is `true`. - `inner_dialog_synced` union — 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. Only used when `enable_inner_dialog` is `true`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `initial_sleep_ms` union — Amount of time, in ms, to wait before starting the conversation. Allowed values from `0` - `300,000`. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `input_poll_freq` union — 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. Allowed values from `1000` to `10000` ms. **Default:** `2000` ms. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `interrupt_on_noise` union — When enabled, barges agent upon any sound interruption longer than 1 second. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `interrupt_prompt` string — Provide a prompt for the agent to handle crosstalk. - `languages_enabled` union — Allows multilingualism when `true`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `local_tz` string — The local timezone setting for the AI. Value should use `IANA TZ ID` - `llm_diarize_aware` union — 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. **Default:** `false` - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `max_emotion` union — Sets the maximum emotion intensity for the AI voice. Allowed values from `1` - `30`. **Default:** `30`. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `max_response_tokens` union — Sets the maximum number of tokens the AI model can generate in a single response. Lower values produce shorter responses and reduce latency. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `openai_asr_engine` string — The ASR (Automatic Speech Recognition) engine to use. Common values include `nova-2` and `nova-3`. - `outbound_attention_timeout` union — Sets a time duration for the outbound call recipient to respond to the AI agent before timeout, in a range from `10000` to `600000`. **Default:** `120000` ms (2 minutes). - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `persist_global_data` union — When enabled, the `global_data` object is automatically saved to a channel variable and restored when a new AI session starts on the same call. This allows data to persist across multiple AI agent invocations within the same call. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `pom_format` 'markdown' | 'xml' — Specifies the output format for structured prompts when using the `pom` array in prompt definitions. Valid values are `markdown` or `xml`. - `save_conversation` union — Send a summary of the conversation after the call ends. This requires a `post_url` to be set in the ai parameters and the `conversation_id` defined below. This eliminates the need for a `post_prompt` in the ai parameters. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `speech_event_timeout` union — Amount of time, in ms, to wait for a speech event. Allowed values from `0` - `10,000`. **Default:** `1400` ms. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `speech_gen_quick_stops` union — Number of quick stops to generate for speech. Allowed values from `0` - `10`. **Default:** `3`. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `speech_timeout` union — Overall speech timeout, in ms. Allowed values from `0` - `600,000`. **Default:** `60000` ms. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `speak_when_spoken_to` union — When enabled, the AI agent remains silent until directly addressed by name (using `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. Cannot be used together with `enable_pause`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `start_paused` union — When enabled, the AI agent starts in a paused state and will not respond until the user speaks the agent's name (set via `ai_name`). Automatically enables `enable_pause`. This is useful for scenarios where you want the agent to wait for explicit activation. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `static_greeting` string — The static greeting to play when the call is answered. This will always play at the beginning of the call. - `static_greeting_no_barge` union — 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. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `summary_mode` union — Defines the mode for summary generation. Allowed values are `"string"` and `"original"`. - 'string' | 'original' - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `swaig_allow_settings` union — Allows tweaking any of the indicated settings, such as `barge_match_string`, using the returned SWML from the SWAIG function. **Default:** `true`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `swaig_allow_swml` union — Allows your SWAIG to return SWML to be executed. **Default:** `true`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `swaig_post_conversation` union — Post entire conversation to any SWAIG call. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `swaig_set_global_data` union — Allows SWAIG to set global data that persists across calls. **Default:** `true`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `swaig_post_swml_vars` union — 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. - boolean - string[] - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `thinking_model` union — The model to use for the AI's thinking capabilities. Allowed values are `gpt-4o-mini`, `gpt-4.1-mini`, and `gpt-4.1-nano`. - 'gpt-4o-mini' | 'gpt-4.1-mini' | 'gpt-4.1-nano' - string - `transparent_barge` union — 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. **Default:** `true`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `transparent_barge_max_time` union — Maximum time, in ms, for transparent barge mode. Allowed values from `0` - `60,000`. **Default:** `3000` ms. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `transfer_summary` union — Pass a summary of a conversation from one AI agent to another. For example, transfer a call summary between support agents in two departments. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `turn_detection_timeout` union — Time in milliseconds to wait after detecting a potential end-of-turn before finalizing speech recognition. A shorter timeout results in faster response times but may cut off the user if they pause mid-sentence. Set to `0` to finalize immediately. Only used when `enable_turn_detection` is `true`. - integer - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `tts_number_format` 'international' | 'national' — The format for the AI agent to reference phone numbers. Allowed values are `international` and `national`. **Default:** `international`. **Example:** - `international`: `+12345678901` - `national`: `(234) 567-8901` - `verbose_logs` union — Enable verbose logging. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `video_listening_file` string, uri — URL of a video file to play when AI is listening to the user speak. Only works for calls that support video. - `video_idle_file` string, uri — URL of a video file to play when AI is idle. Only works for calls that support video. - `video_talking_file` string, uri — URL of a video file to play when AI is talking. Only works for calls that support video. - `vision_model` union — The model to use for the AI's vision capabilities. Allowed values are `gpt-4o-mini`, `gpt-4.1-mini`, and `gpt-4.1-nano`. - 'gpt-4o-mini' | 'gpt-4.1-mini' | 'gpt-4.1-nano' - string - `vad_config` string — Configures Silero Voice Activity Detection (VAD) settings. Format: `"threshold"` or `"threshold:frame_ms"`. The threshold (0-100) sets sensitivity for detecting voice activity. The optional frame_ms (16-40) sets frame duration in milliseconds. - `wait_for_user` union — When false, AI agent will initialize dialogue after call is setup. When true, agent will wait for the user to speak first. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `wake_prefix` string — Specifies an additional prefix that must be spoken along with the agent's name (`ai_name`) to wake the agent from a paused state. For example, if `ai_name` is "computer" and `wake_prefix` is "hey", the user would need to say "hey computer" to activate the agent. - `eleven_labs_stability` union — 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. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `eleven_labs_similarity` union — 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. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `post_prompt` union - SWMLCallingAIPostPromptText - `max_tokens` integer — Limits the amount of tokens that the AI agent may generate when creating its response - `temperature` union — Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `top_p` union — Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `confidence` union — Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. Decreasing this value will reduce the pause after the user speaks, but may introduce false positives. **Default:** `0.6`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `presence_penalty` union — Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `frequency_penalty` union — Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `text` string, required — The instructions to send to the agent. - SWMLCallingAIPostPromptPom - `max_tokens` integer — Limits the amount of tokens that the AI agent may generate when creating its response - `temperature` union — Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `top_p` union — Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `confidence` union — Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. Decreasing this value will reduce the pause after the user speaks, but may introduce false positives. **Default:** `0.6`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `presence_penalty` union — Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `frequency_penalty` union — Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `pom` SWMLCallingPOM[], required — The instructions to send to the agent. - union — Regular section that requires either body or bullets. - … - `post_prompt_url` string, uri — The URL to which to send status callbacks and reports. Authentication can also be set in the url in the format of `username:password@url`. - `pronounce` SWMLCallingPronounce[] — An array of JSON objects to clarify the AI's pronunciation of words or expressions. - `replace` string, required — The expression to replace. - `with` string, required — The phonetic spelling of the expression. - `ignore_case` union — Whether the pronunciation replacement should ignore case. **Default:** `true`. - boolean - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `prompt` union, required - SWMLCallingAIPromptText - `max_tokens` integer — Limits the amount of tokens that the AI agent may generate when creating its response - `temperature` union — Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `top_p` union — Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `confidence` union — Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. Decreasing this value will reduce the pause after the user speaks, but may introduce false positives. **Default:** `0.6`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `presence_penalty` union — Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `frequency_penalty` union — Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `text` string, required — The instructions to send to the agent. - `contexts` SWMLCallingContexts - `default` union, required - … - SWMLCallingAIPromptPom - `max_tokens` integer — Limits the amount of tokens that the AI agent may generate when creating its response - `temperature` union — Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. **Default:** `1.0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `top_p` union — Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. **Default:** `1.0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `confidence` union — Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. Decreasing this value will reduce the pause after the user speaks, but may introduce false positives. **Default:** `0.6`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `presence_penalty` union — Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. **Default:** `0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `frequency_penalty` union — Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. **Default:** `0`. - number - string — A SWML variable reference for dynamic value substitution at runtime. Use the `${varname}` or `%{varname}` syntax to reference variables that will be resolved when the SWML is executed. Variables can be: - **SignalWire-provided variables**: System variables like `${call.from}`, `${call.to}`, `${call.direction}`, etc. - **User-defined variables**: Custom variables set via `set_global_data` action or passed in the initial SWML script's `global_data` object. - **Function return values**: Variables populated from SWAIG function responses. Example: `${global_data.customer_name}` will be replaced with the value of `customer_name` from the global_data object at runtime. - `pom` SWMLCallingPOM[], required — Prompt Object Model (POM) is a structured data format for composing, organizing, and rendering prompt instructions for AI agents. POM ensures that the prompt is structured in a way that is best for the AI agent to understand and execute. The first item in the array MUST be FirstPOMSection (with optional title). All subsequent items MUST be PomSection (with required title and body). - union — Regular section that requires either body or bullets. - … - `contexts` SWMLCallingContexts - `default` union, required - … - `SWAIG` SWMLCallingSWAIG - `defaults` SWMLCallingSWAIGDefaults - `web_hook_url` string — Default URL to send status callbacks and reports to. Authentication can also be set in the url in the format of `username:password@url.` - `native_functions` SWMLCallingSWAIGNativeFunction[] — Prebuilt functions the AI agent is able to call from this list of available native functions - `includes` SWMLCallingSWAIGIncludes[] — An array of objects to include remote function signatures. This allows you to include functions that are defined in a remote location. The object fields are `url` to specify where the remote functions are defined and `functions` which is an array of the function names as strings. - `functions` string[], required — Remote functions to fetch and include in your AI application. - `url` string, required — URL to fetch remote functions and include in your AI application. Authentication can also be set in the url in the format of `username:password@url`. - `meta_data` object — User-defined metadata to pass with the remote function request. - `functions` SWMLCallingSWAIGFunction[] — An array of JSON objects to define functions that can be executed during the interaction with the AI. Default is not set. - union - SWMLCallingUserSWAIGFunction - … - SWMLCallingStartUpHookSWAIGFunction - … - SWMLCallingHangUpHookSWAIGFunction - … - SWMLCallingSummarizeConversationSWAIGFunction — An internal reserved function that generates a summary of the conversation and sends any specified properties to the configured webhook after the conversation has ended. This ensures that key parts of the conversation, as interpreted by the LLM, are reliably captured and delivered to the webhook. - … - `internal_fillers` SWMLCallingSWAIGInternalFiller - `hangup` union — Supported language codes - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `check_time` union — Supported language codes - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `wait_for_user` union — Supported language codes - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `wait_seconds` union — Supported language codes - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `adjust_response_latency` union — Supported language codes - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `next_step` union — Supported language codes - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `change_context` union — Supported language codes - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `get_visual_input` union — Supported language codes - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `get_ideal_strategy` union — Supported language codes - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `agent_id` string, uuid, required — Universal Unique Identifier. - `name` string, required — Name of the AI Agent. - ResourceResponseCallFlow - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'call_flow', required — The type of Resource - `call_flow` CallFlow, required - `id` string, uuid, required — Universal Unique Identifier. - `title` string, required — The name of the Call Flow - `flow_data` object — Call Flow Builder state, stored as an opaque JSON object. Produced and consumed by the SignalWire Call Flow Builder UI; not used by SWML execution. - `relayml` SWMLCallingSWMLObject — A SWML document for handling inbound and outbound calls. Contains a `sections` map where each section holds an array of methods that run sequentially. Execution starts at `sections.main`. See the [Calling SWML reference](/docs/swml/reference/calling) for the full list of available methods. - `version` '1.0.0' - `sections` SWMLCallingSection, required - `main` SWMLCallingSWMLMethod[], required - union - … - `document_version` integer — The current revision of the call flow. Every update must increase this number. - ResourceResponseCXMLWebhook - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'cxml_webhook', required — The type of Resource - `cxml_webhook` CXMLWebhook, required - `id` string, uuid, required — Universal Unique Identifier. - `name` string, required — Name of the CXML Webhook. - `used_for` 'calling' | 'messaging', required — Sets the handler to handle incoming `calls` or `messages`. - `primary_request_url` string, uri, required — Primary request url of the CXML Webhook. - `primary_request_method` 'GET' | 'POST', required — The method type to use for the URL - `fallback_request_url` string, uri, nullable, required — Fallback request url of the CXML Webhook. - `fallback_request_method` 'GET' | 'POST', required — The method type to use for the URL - `status_callback_url` string, uri, nullable, required — Status callback url of the CXML Webhook. - `status_callback_method` 'GET' | 'POST', required — The method type to use for the URL - ResourceResponseCXMLScript - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'cxml_script', required — The type of Resource - `cxml_script` CXMLScript, required - `id` string, uuid, required — Universal Unique Identifier. - `contents` string, required — The cXML script contents - `request_count` integer, required — The amout of times the cXML script has been requested - `last_accessed_at` string, date-time, nullable, required — The date and time when the cXML script was last accessed - `request_url` string, uri, required — The URL where the cXML script can be accessed - `script_type` 'calling' | 'messaging', required — The script type the cXML Script is used for - `display_name` string, required — Display name of the cXML Script Fabric Resource - `status_callback_url` string, uri, nullable — The url that will send status updates for the cXML Script - `status_callback_method` 'GET' | 'POST' — The method type to use for the URL - ResourceResponseCXMLApplication - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'cxml_application', required — The type of Resource - `cxml_application` CxmlApplication, required - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `friendly_name` string, required — Display name of the cXML Application - `voice_url` string, nullable, required — URL to handle incoming calls - `voice_method` 'GET' | 'POST', required — The method type to use for the URL - `voice_fallback_url` string, nullable, required — Fallback URL for voice errors - `voice_fallback_method` 'GET' | 'POST', required — The method type to use for the URL - `status_callback` string, uri, nullable, required — URL to receive status callbacks - `status_callback_method` 'GET' | 'POST', required — The method type to use for the URL - `sms_url` string, nullable, required — URL to handle incoming messages - `sms_method` 'GET' | 'POST', required — The method type to use for the URL - `sms_fallback_url` string, nullable, required — Fallback URL for SMS errors - `sms_fallback_method` 'GET' | 'POST', required — The method type to use for the URL - `sms_status_callback` string, nullable, required — URL to receive SMS status callbacks - `sms_status_callback_method` 'GET' | 'POST', required — The method type to use for the URL - ResourceResponseDialogFlowAgent - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'dialogflow_agent', required — The type of Resource - `dialogflow_agent` DialogflowAgent, required - `id` string, uuid, required — Universal Unique Identifier. - `say_enabled` boolean — Whether to enable the 'say' feature - `say` string — Default message to say - `voice` string — Voice to use for speech - `display_name` string — Display name of the Dialogflow Agent - `dialogflow_reference_id` string, uuid — Universal Unique Identifier. - `dialogflow_reference_name` string — Dialogflow reference name - ResourceResponseFSConnector - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'freeswitch_connector', required — The type of Resource - `freeswitch_connector` FreeswitchConnector, required - `id` string, uuid, required — Universal Unique Identifier. - `name` string — Name of the FreeSWITCH Connector - `caller_id` string, nullable — Caller ID for the connector - `send_as` string, nullable — Send as identifier - ResourceResponseRelayApp - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'relay_application', required — The type of Resource - `relay_application` RelayApplication, required - `id` string, uuid, required — Universal Unique Identifier. - `name` string, required — Name of the Relay Application - `topic` string, required — Topic of the Relay Application - `call_status_callback_url` string, uri, nullable, required — Call status callback URL - ResourceResponseSipEndpoint - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'sip_endpoint', required — The type of Resource - `sip_endpoint` FabricSipEndpoint, required - `id` string, uuid, required — Universal Unique Identifier. - `username` string, required — The username of the Sip Endpoint - `caller_id` string, required — The caller ID that will showup when dialing from this Sip Endpoint - `send_as` string, required — The Sip username that will show up on the calle's side. Overrides the username. - `ciphers` Ciphers[], required — Ciphers that can be enabled for calls on this Sip Endpoint. - `codecs` Codecs[], required — Codecs that can be enabled for calls on this Sip Endpoint. - `encryption` 'required' | 'optional' | 'default', required - `call_handler` 'default' | 'passthrough' | 'block-pstn' | 'resource', required - `calling_handler_resource_id` string, uuid, required — Universal Unique Identifier. - ResourceResponseSipGateway - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'sip_gateway', required — The type of Resource - `sip_gateway` SipGateway, required - `id` string, uuid, required — Universal Unique Identifier. - `uri` string, required — The URI for the SIP Gateway. - `name` string, required — Display name of the SIP Gateway. - `ciphers` Ciphers[], required — List of supported SIP ciphers. - `codecs` Codecs[], required — List of supported codecs. - `encryption` 'required' | 'optional' | 'default', required - ResourceResponseSubscriber - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'subscriber', required — The type of Resource - `subscriber` Subscriber, required - `id` string, uuid, required — Universal Unique Identifier. - `email` string, required — Email of the Subscriber. - `first_name` string, required — First name of the Subscriber. - `last_name` string, required — Last name of the Subscriber. - `display_name` string, required — Display name of the Subscriber. - `job_title` string, required — Job title of the Subscriber. - `timezone` string, required — Timezone of the Subscriber. - `country` string, required — Country of the Subscriber. - `company_name` string, required — Company name of the Subscriber. - ResourceResponseSWMLWebhook - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'swml_webhook', required — The type of Resource - `swml_webhook` SWMLWebhook, required - `id` string, uuid, required — Universal Unique Identifier. - `name` string, required — Name of the SWML Webhook. - `used_for` 'calling' | 'messaging', required — Indicates whether this SWML Webhook handles inbound calls or inbound messages. Determines the payload SignalWire POSTs to `primary_request_url`. - `primary_request_url` string, uri, required — Primary URL SignalWire fetches the SWML document from when the webhook fires. The webhook payload depends on `used_for`: for `calling`, see the [SWML inbound call webhook](/docs/apis/rest/swml-webhook/webhooks/inbound-call-webhook); for `messaging`, see the [SWML inbound message webhook](/docs/apis/rest/swml-webhook/webhooks/inbound-message-webhook). - `primary_request_method` 'GET' | 'POST', required — The method type to use for the URL - `fallback_request_url` string, uri, nullable, required — Fallback URL SignalWire fetches the SWML document from if the primary URL fails. Receives the same payload as `primary_request_url` — see the [SWML inbound call webhook](/docs/apis/rest/swml-webhook/webhooks/inbound-call-webhook) or [SWML inbound message webhook](/docs/apis/rest/swml-webhook/webhooks/inbound-message-webhook) depending on `used_for`. - `fallback_request_method` 'GET' | 'POST', required — The method type to use for the URL - `status_callback_url` string, uri, nullable, required — URL to receive message status callback events for outbound messages sent by this webhook (`reply` or `send_sms`). See the [Message status callback](/docs/apis/rest/messages/webhooks/message-status-callback) webhook for the payload your URL will receive. - `status_callback_method` 'GET' | 'POST', required — The method type to use for the URL - ResourceResponseSWMLScript - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'swml_script', required — The type of Resource - `swml_script` union, required — A SWML Script — either a [Calling Script](#schema/CallingSwmlScript) for inbound or outbound calls, or a [Messaging Script](#schema/MessagingSwmlScript) for inbound SMS or MMS messages. The `script_type` field on each script (`"calling"` or `"messaging"`) identifies which kind it is. - CallingSwmlScript — A SWML Script that handles inbound or outbound calls. The `contents` field carries a [calling SWML document](/docs/swml/reference/calling). - `id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — The displayed name of the SWML script. - `script_type` 'calling', required — Set to `calling` for SWML Scripts that handle inbound or outbound calls. - `request_url` string, uri, required — URL where this SWML Script is hosted. - `contents` SWMLCallingSWMLObject, required — A SWML document for handling inbound and outbound calls. Contains a `sections` map where each section holds an array of methods that run sequentially. Execution starts at `sections.main`. See the [Calling SWML reference](/docs/swml/reference/calling) for the full list of available methods. - `version` '1.0.0' - `sections` SWMLCallingSection, required - `main` SWMLCallingSWMLMethod[], required - … - `status_callback_url` string, uri — URL that receives status callbacks for messages sent or calls made by this script. - `status_callback_method` 'POST' — HTTP method used for status callbacks. - MessagingSwmlScript — A SWML Script that handles inbound SMS or MMS messages. The `contents` field carries a [messaging SWML document](/docs/swml/reference/messaging). - `id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — The displayed name of the SWML script. - `script_type` 'messaging', required — Set to `messaging` for SWML Scripts that handle inbound SMS or MMS messages. - `request_url` string, uri, required — URL where this SWML Script is hosted. - `contents` SWMLMessagingSWMLObject, required — A SWML document for handling inbound SMS or MMS messages. The document has a top-level `sections` map; execution starts at `sections.main`, and each section is an ordered array of methods. Additional sections can be invoked via `execute`, `transfer`, or `goto`. See the [Messaging SWML reference](/docs/swml/reference/messaging) for the full list of available methods. - `version` '1.0.0' - `sections` SWMLMessagingSection, required - `main` SWMLMessagingSWMLMethod[], required - … - ResourceResponseConferenceRoom - `id` string, uuid, required — Universal Unique Identifier. - `project_id` string, uuid, required — Universal Unique Identifier. - `display_name` string, required — Display name of the Resource - `created_at` string, date-time, required — Date and time when the resource was created. - `updated_at` string, date-time, required — Date and time when the resource was updated. - `type` 'swml_script', required — The type of Resource - `conference_room` ConferenceRoom, required - `id` string, uuid, required — Universal Unique Identifier. - `name` string, required — The name of the Conference Room - `description` string, required — The descrption of the Conference Room - `display_name` string, required — Display name of the Conference Room - `max_members` integer, required — Maximum number of members allowed in the conference room - `quality` '1080p' | '720p', required — The viudeo quality of the Conference Room. - `fps` 30 | 20, required — The frames-per-second (fps) of the participants videos in the conference. - `join_from` string, date-time, nullable, required — The time users are allowed to start joining the conference. Joining before this time will result in failure to join the conference. - `join_until` string, date-time, nullable, required — The time users are allowed to until the conference is locked. Attempting to join the conference after the set time will result in failure to join the conference. - `remove_at` string, date-time, nullable, required — The time to remove all participants from the conference. - `remove_after_seconds_elapsed` integer, nullable, required — The amount of time in seconds to remove a particpant from a conference after they join. - `layout` 'grid-responsive' | 'grid-responsive-mobile' | 'highlight-1-responsive' | '1x1' | '2x1' | '2x2' | '5up' | '3x3' | '4x4' | '5x5' | '6x6' | '8x8' | '10x10', required - `record_on_start` boolean, required — Starts recording when the conference starts. - `tone_on_entry_and_exit` boolean, required — Plays a tone when a participant joins or leaves the conference. - `room_join_video_off` boolean, required — Turns the conference video off when the participant joins the room if `true`. - `user_join_video_off` boolean, required — Turns the participants video off when the participant joins the room if `true`. - `enable_room_previews` boolean, required — Enables live video room previews for the conference. - `sync_audio_video` boolean, nullable, required — Syncs the participants audio and video. - `meta` object, required — Metadata of the conference. - `prioritize_handraise` boolean, required — Indicator if the Conference Room will prioritize showing participants utilizing the hand raised feature. ## Other responses - `401` — Access is unauthorized. - `404` — The server cannot find the requested resource. - `500` — An internal server error occurred. --- [API](https://skmtc.dev/signalwire/apis/signalwire-rest-api.md) · [All operations](https://skmtc.dev/signalwire/apis/signalwire-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signalwire/apis/signalwire-rest-api/revisions/11efd1dbc7ef?raw)