List AI Agents

GET /resources/ai_agents

A list of AI Agents

Request

Responses

The request has succeeded.

application/json

Schema
Example (from schema)

Schema

data

object[]

required

Array [

agent_id uuidrequired

Universal Unique Identifier.

name stringrequired

Name of the AI Agent.

Example: My AI Agent

prompt

object

text stringrequired

The instructions to send to the agent.

Example: Prompt text

temperature number

Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random.

Possible values: <= 1.5

top_p number

Randomness setting. Alternative to temperature. Float value between 0.0 and 1.0. Closer to 0 will make the output less random.

Possible values: <= 1

confidence number

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.

Possible values: <= 1

presence_penalty number

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.

Possible values: >= -2 and <= 2

frequency_penalty number

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.

Possible values: >= -2 and <= 2

contexts

object

An object that defines the context steps for the AI. The context steps are used to define the flow of the conversation. Every context object requires a default key, which is the default context to use at the beginning of the conversation. Additionally, more context steps can be defined as any other key in the object.

default

object

required

The default context to use at the beginning of the conversation. Additional context steps can be defined as any other key in the object.

steps

object[]

required

An array of objects that define the steps in the context. These steps are used to define the flow of the conversation.

Array [

anyOf

ContextStepsEnd object
ContextStepsValidSteps object

name stringrequired

The name of the step. The name must be unique within the context. The name is used for referencing the step in the context.

Example: Take Pizza order

text stringrequired

The prompt or instructions given to the AI at this step.

Example: Your name is Franklin and you are taking orders for Franklin's Pizza.

step_criteria string

The conditions that must be met for the conversation to proceed to the next step. If a condition is not met, the conversation will not proceed to the next step. It's highly recommended you create a custom criteria for the step to get the intended behavior.

Example: Customer wants to order Pizza

functions string[]

An array of SWAIG.functions that can be executed from this step.

Example: ["Take Order","Confirm Order","Confirm Address"]

valid_contexts string[]

An array of valid contexts that the conversation can transition to from this step.

Example: ["Place Order","Confirm Order"]

skip_user_turn boolean

A boolean value that, when true, will skip the user's turn to respond in the conversation and proceed to the next step.

end boolean

A boolean value that, when true, will end the contexts conversation and transition to a normal interaction.

name stringrequired

The name of the step. The name must be unique within the context. The name is used for referencing the step in the context.

Example: Take Pizza order

text stringrequired

The prompt or instructions given to the AI at this step.

Example: Your name is Franklin and you are taking orders for Franklin's Pizza.

step_criteria string

Example: Customer wants to order Pizza

functions string[]

An array of SWAIG.functions that can be executed from this step.

Example: ["Take Order","Confirm Order","Confirm Address"]

valid_contexts string[]

An array of valid contexts that the conversation can transition to from this step.

Example: ["Place Order","Confirm Order"]

skip_user_turn boolean

A boolean value that, when true, will skip the user's turn to respond in the conversation and proceed to the next step.

valid_steps string[]

An array of valid steps that the conversation can proceed to from this step. If the array is empty, or the valid_steps key is not present, the conversation will proceed to the next step in the context.

Example: ["get order","confirm order"]

]

property name*

ContextSteps object

steps

object[]

required

An array of objects that define the steps in the context. These steps are used to define the flow of the conversation.

Array [

anyOf

ContextStepsEnd object
ContextStepsValidSteps object

name stringrequired

The name of the step. The name must be unique within the context. The name is used for referencing the step in the context.

Example: Take Pizza order

text stringrequired

The prompt or instructions given to the AI at this step.

Example: Your name is Franklin and you are taking orders for Franklin's Pizza.

step_criteria string

Example: Customer wants to order Pizza

functions string[]

An array of SWAIG.functions that can be executed from this step.

Example: ["Take Order","Confirm Order","Confirm Address"]

valid_contexts string[]

An array of valid contexts that the conversation can transition to from this step.

Example: ["Place Order","Confirm Order"]

skip_user_turn boolean

A boolean value that, when true, will skip the user's turn to respond in the conversation and proceed to the next step.

end boolean

A boolean value that, when true, will end the contexts conversation and transition to a normal interaction.

name stringrequired

The name of the step. The name must be unique within the context. The name is used for referencing the step in the context.

Example: Take Pizza order

text stringrequired

The prompt or instructions given to the AI at this step.

Example: Your name is Franklin and you are taking orders for Franklin's Pizza.

step_criteria string

Example: Customer wants to order Pizza

functions string[]

An array of SWAIG.functions that can be executed from this step.

Example: ["Take Order","Confirm Order","Confirm Address"]

valid_contexts string[]

An array of valid contexts that the conversation can transition to from this step.

Example: ["Place Order","Confirm Order"]

skip_user_turn boolean

A boolean value that, when true, will skip the user's turn to respond in the conversation and proceed to the next step.

valid_steps string[]

Example: ["get order","confirm order"]

]

post_prompt

object

text stringrequired

The instructions to send to the agent.

Example: Prompt text

temperature number

Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random.

Possible values: <= 1.5

top_p number

Randomness setting. Alternative to temperature. Float value between 0.0 and 1.0. Closer to 0 will make the output less random.

Possible values: <= 1

confidence number

Possible values: <= 1

presence_penalty number

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.

Possible values: >= -2 and <= 2

frequency_penalty number

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.

Possible values: >= -2 and <= 2

params

object

acknowledge_interruptions boolean

Instructs the agent to acknowledge crosstalk and confirm user input when the user speaks over the agent.

ai_volume integer

Adjust the volume of the AI. Allowed values from -50 - 50.

Possible values: >= -50 and <= 50

attention_timeout

object

Possible values: >= 10000 and <= 600000

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.

anyOf

MOD1
MOD2

integer

number

Possible values: [0]

attention_timeout_prompt string

A custom prompt that is fed into the AI when the attention_timeout is reached.

Example: Ask if the user can listen to you or they need more time to respond

background_file uri

URL of audio file to play in the background while AI plays in foreground.

Example: https://audiourl.com

background_file_loops integernullable

Maximum number of times to loop playing the background file. undefined means loop indefinitely.

Example: 5

background_file_volume integer

Defines background_file volume within a range of -50 to 50.

Possible values: >= -50 and <= 50

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.

Example: Cancel order

barge_min_words integer

Defines the number of words that must be input before triggering barge behavior, in a range of 1-99.

Possible values: >= 1 and <= 99

conscience string

Sets the prompt which binds the agent to its purpose.

Example: Place an order

conversation_id string

Used by check_for_input and save_conversation to identify an individual conversation.

Example: Converation ID

debug_webhook_level integer

Enables debugging to the set URL. Allowed values from 0 - 1.

Possible values: <= 1

debug_webhook_url uri

Each interaction between the AI and end user is posted in real time to the established URL.

Example: https://example.com

direction Direction enum (string)[]

Forces the direction of the call to the assistant. Valid values are inbound and outbound.

Possible values: [inbound, outbound]

digit_termiantors string

DTMF digit, as a string, to signal the end of input (ex: '#')

Example: #

digit_timeout integer

Time, in ms, at the end of digit input to detect end of input. Allowed values from 250 - 10,000.

Possible values: >= 250 and <= 10000

end_of_speech_timeout integer

Amount of silence, in ms, at the end of an utterance to detect end of speech. Allowed values from 250 - 10,000.

Possible values: >= 250 and <= 10000

eleven_labs_stability number

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.

eleven_labs_similarity number

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.

energy_level number

Amount of energy necessary for bot to hear you (in dB). Allowed values from 0.0 - 100.0.

Possible values: <= 100

hold_music uri

A URL for the hold music to play, accepting WAV, mp3, and FreeSWITCH tone_stream.

Example: https://holdmusic.com

hold_on_process boolean

Enables hold music during SWAIG processing.

inactivity_timeout integer

Amount of time, in ms, to wait before exiting the app due to inactivity. Allowed values from 10,000 - 3,600,000.

Possible values: >= 10000 and <= 3600000

input_poll_freq string

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.

interrupt_on_noise boolean

When enabled, barges agent upon any sound interruption longer than 1 second.

interrupt_prompt string

Provide a prompt for the agent to handle crosstalk.

Example: Inform user that you can't hear anything

languages_enabled boolean

Allows multilingualism when true.

local_tz string

The local timezone setting for the AI. Value should use IANA TZ ID

Example: America/Ensenada

outbound_attention_timeout integer

Sets a time duration for the outbound call recipient to respond to the AI agent before timeout, in a range from 10000 to 600000.

Possible values: >= 10000 and <= 600000

save_conversation boolean

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.

swaig_allow_settings boolean

Allows tweaking any of the indicated settings, such as barge_match_string, using the returned SWML from the SWAIG function.

swaig_allow_swml boolean

Allows your SWAIG to return SWML to be executed.

swaig_post_conversation boolean

Post entire conversation to any SWAIG call.

transfer_summary boolean

Pass a summary of a conversation from one AI agent to another. For example, transfer a call summary between support agents in two departments.

verbose_logs boolean

Enable verbose logging.

wait_for_user boolean

When false, AI agent will initialize dialogue after call is setup. When true, agent will wait for the user to speak first.

pronounce

object[]

An array of JSON objects to clarify the AI's pronunciation of words or expressions.

Array [

replace stringrequired

The expression to replace.

Example: pizza

with stringrequired

The phonetic spelling of the expression.

Example: pissa

ignore_case boolean

Whether the pronunciation replacement should ignore case.

]

hints string[]

An array of hints (as strings) to provide context to the dialogue.

Example: ["One Hint","Two Hint"]

languages object[]

An array of JSON objects defining supported languages in the conversation.

SWAIG

object[]

An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue.

Array [

defaults

object

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.

Example: username:password@https://example.com

native_functions native_functions (string)[]

Prebuilt functions the AI agent is able to call from this list of available native functions

Possible values: [check_time, wait_seconds]

includes

object[]

An array of objects to include remote function signatures. 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.

Array [

functions string[]required

Remote functions to fetch and include in your AI application.

Example: ["transfer call","notify kitchen"]

url stringrequired

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.

Example: username:password@https://example.com

meta_data

object

property name* any

]

functions

object[]

An array of JSON objects to define functions that can be executed during the interaction with the AI. Default is not set. The fields of this object are the six following.

Array [

function stringrequired

A unique name for the function. For example, 'get_weather'.

Example: get_weather

description stringrequired

A description of the context and purpose of the function, to explain to the agent when to use it.

Example: Get the weather information

parameters

object

type stringrequired

The type of argument the AI is passing to the function. Possible values are 'string' and 'object'.

Possible values: [object]

properties

object

required

An object containing the property definitions that are passed to the function.

A property definition is a valid JSON schema type with dynamic property names, where:

Keys: User-defined strings, that set the property names.
Values: A valid property type, which can be one of the following: string, integer, number, boolean, array, object, or null.

property name*

Function Parameters Type Union

oneOf

Base interface for all property types

description string

A description of the property.

Example: Property description

nullable boolean

Whether the property can be null.

type stringrequired

The type of parameter(s) the AI is passing to the function.

Possible values: [string]

enum string[]

An array of strings that are the possible values

Example: ["value1","value2","value3"]

default string

The default string value

Example: default value

pattern string

Regular expression pattern

Example: ^[a-zA-Z0-9_.-]*$

format StringFormat (string)

String format (email, date-time, etc.)

Possible values: [date_time, time, date, duration, email, hostname, ipv4, ipv6, uri, uuid]

Base interface for all property types

description string

A description of the property.

Example: Property description

nullable boolean

Whether the property can be null.

type stringrequired

The type of parameter(s) the AI is passing to the function.

Possible values: [integer]

enum integer[]

An array of integers that are the possible values

Example: [1,2,3]

default integer

The default integer value

Example: 5

Base interface for all property types

description string

A description of the property.

Example: Property description

nullable boolean

Whether the property can be null.

type stringrequired

The type of parameter(s) the AI is passing to the function.

Possible values: [number]

enum

object[]

An array of integers that are the possible values

Array [

anyOf

MOD1
MOD2

integer

]

default

object

The default integer value

anyOf

MOD1
MOD2

integer

Base interface for all property types

description string

A description of the property.

Example: Property description

nullable boolean

Whether the property can be null.

type stringrequired

The type of parameter(s) the AI is passing to the function.

Possible values: [boolean]

default boolean

The default boolean value

Base interface for all property types

description string

A description of the property.

Example: Property description

nullable boolean

Whether the property can be null.

type stringrequired

The type of parameter(s) the AI is passing to the function.

Possible values: [array]

default array

The default array value

items required

Schema for array items

Base interface for all property types

description string

A description of the property.

Example: Property description

nullable boolean

Whether the property can be null.

type stringrequired

The type of parameter(s) the AI is passing to the function.

Possible values: [object]

default object

The default object value

properties object

Nested properties

required string[]

Required property names

Example: ["name1","name2"]

type stringrequired

The type of parameter(s) the AI is passing to the function.

Possible values: [null]

description stringrequired

A description of the property.

Example: Property Description

required string[]

An array of required property names from the properties object.

Example: ["name1","name2"]

active boolean

Whether the function is active. Default is true.

meta_data

object

A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script or from the SWML set_meta_data action. This data can be referenced locally to the function. All contained information can be accessed and expanded within the prompt - for example, by using a template string. Default is not set.

property name* any

meta_data_token string

Scoping token for meta_data. If not supplied, metadata will be scoped to function's web_hook_url. Default is set by SignalWire.

data_map

object

oneOf

Output object
Expression object
Webhook object

output

object

required

An object that defines the response or action to be taken when the webhook is successfully triggered.

response stringrequired

A static response text or message returned to the AI agents context.

Example: Order placed

action

object[]

A list of actions to be performed upon matching.

Array [

anyOf

context_switch

object

required

A JSON object containing the context to switch to. Default is not set.

system_prompt stringrequired

The instructions to send to the agent. Default is not set.

consolidate boolean

Whether to consolidate the context. Default is false.

user_prompt string

A string serving as simulated user input for the AI Agent. During a context_switch in the AI's prompt, the user_prompt offers the AI pre-established context or guidance. Default is not set

playback_bg

object

required

A JSON object containing the audio file to play.

file urirequired

URL or filepath of the audio file to play.

Example: http://audiofile.com

wait boolean

Whether to wait for the audio file to finish playing before continuing. Default is false.

say say (string)required

A message to be spoken by the AI agent.

Example: Welcome to Franklin's Pizza.

set_global_data objectrequired

A JSON object containing any global data, as a key-value map. This action sets the data in the global_meta_data to be globally referenced.

Example: {"small_size":"8 Inch","large_size":"12 Inch","closed":"Monday"}

set_meta_data objectrequired

A JSON object containing any metadata, as a key-value map. This action sets the data in the meta_data to be referenced locally in the function.

Example: {"extra_cheese":"Can't do","extra_large_pizza":"Only on Friday"}

toggle_functions

object[]

required

Whether to toggle the functions on or off.

Array [

active booleanrequired

Whether to activate or deactivate the functions. Default is true

function

object

required

The function names to toggle.

anyOf

MOD1
MOD2

string

]

unset_global_data

object

required

The key of the global data to unset from the global_meta_data. You can also reset the global_meta_data by passing in a new object.

anyOf

MOD1
MOD2

string

unset_meta_data

object

required

The key of the local data to unset from the meta_data. You can also reset the meta_data by passing in a new object.

anyOf

MOD1
MOD2

string

user_input user_input (string)required

Used to inject text into the users queue as if they input the data themselves.

Example: I want a tasty Pizza.

]

expressions

object[]

required

An array of objects that define patterns and corresponding actions.

Array [

string stringrequired

The actual input or value from the user or system.

Example: I want a refund

pattern stringrequired

A regular expression pattern to validate or match the string.

output

object

required

An object that defines the response or action to be taken when the webhook is successfully triggered.

response stringrequired

A static response text or message returned to the AI agents context.

Example: Order placed

action

object[]

A list of actions to be performed upon matching.

Array [

anyOf

context_switch

object

required

A JSON object containing the context to switch to. Default is not set.

system_prompt stringrequired

The instructions to send to the agent. Default is not set.

consolidate boolean

Whether to consolidate the context. Default is false.

user_prompt string

A string serving as simulated user input for the AI Agent. During a context_switch in the AI's prompt, the user_prompt offers the AI pre-established context or guidance. Default is not set

playback_bg

object

required

A JSON object containing the audio file to play.

file urirequired

URL or filepath of the audio file to play.

Example: http://audiofile.com

wait boolean

Whether to wait for the audio file to finish playing before continuing. Default is false.

say say (string)required

A message to be spoken by the AI agent.

Example: Welcome to Franklin's Pizza.

set_global_data objectrequired

A JSON object containing any global data, as a key-value map. This action sets the data in the global_meta_data to be globally referenced.

Example: {"small_size":"8 Inch","large_size":"12 Inch","closed":"Monday"}

set_meta_data objectrequired

A JSON object containing any metadata, as a key-value map. This action sets the data in the meta_data to be referenced locally in the function.

Example: {"extra_cheese":"Can't do","extra_large_pizza":"Only on Friday"}

toggle_functions

object[]

required

Whether to toggle the functions on or off.

Array [

active booleanrequired

Whether to activate or deactivate the functions. Default is true

function

object

required

The function names to toggle.

anyOf

MOD1
MOD2

string

]

unset_global_data

object

required

The key of the global data to unset from the global_meta_data. You can also reset the global_meta_data by passing in a new object.

anyOf

MOD1
MOD2

string

unset_meta_data

object

required

The key of the local data to unset from the meta_data. You can also reset the meta_data by passing in a new object.

anyOf

MOD1
MOD2

string

user_input user_input (string)required

Used to inject text into the users queue as if they input the data themselves.

Example: I want a tasty Pizza.

]

webhooks

object[]

required

An array of objects that define external API calls.

Array [

expressions

object[]

A list of expressions to be evaluated upon matching.

Array [

expressions

object[]

required

An array of objects that define patterns and corresponding actions.

Array [

string stringrequired

The actual input or value from the user or system.

Example: I want a refund

pattern stringrequired

A regular expression pattern to validate or match the string.

output

object

required

An object that defines the response or action to be taken when the webhook is successfully triggered.

response stringrequired

A static response text or message returned to the AI agents context.

Example: Order placed

action

object[]

A list of actions to be performed upon matching.

Array [

anyOf

context_switch

object

required

A JSON object containing the context to switch to. Default is not set.

system_prompt stringrequired

The instructions to send to the agent. Default is not set.

consolidate boolean

Whether to consolidate the context. Default is false.

user_prompt string

A string serving as simulated user input for the AI Agent. During a context_switch in the AI's prompt, the user_prompt offers the AI pre-established context or guidance. Default is not set

playback_bg

object

required

A JSON object containing the audio file to play.

file urirequired

URL or filepath of the audio file to play.

Example: http://audiofile.com

wait boolean

Whether to wait for the audio file to finish playing before continuing. Default is false.

say say (string)required

A message to be spoken by the AI agent.

Example: Welcome to Franklin's Pizza.

set_global_data objectrequired

A JSON object containing any global data, as a key-value map. This action sets the data in the global_meta_data to be globally referenced.

Example: {"small_size":"8 Inch","large_size":"12 Inch","closed":"Monday"}

set_meta_data objectrequired

A JSON object containing any metadata, as a key-value map. This action sets the data in the meta_data to be referenced locally in the function.

Example: {"extra_cheese":"Can't do","extra_large_pizza":"Only on Friday"}

toggle_functions

object[]

required

Whether to toggle the functions on or off.

Array [

active booleanrequired

Whether to activate or deactivate the functions. Default is true

function

object

required

The function names to toggle.

anyOf

MOD1
MOD2

string

]

unset_global_data

object

required

The key of the global data to unset from the global_meta_data. You can also reset the global_meta_data by passing in a new object.

anyOf

MOD1
MOD2

string

unset_meta_data

object

required

The key of the local data to unset from the meta_data. You can also reset the meta_data by passing in a new object.

anyOf

MOD1
MOD2

string

user_input user_input (string)required

Used to inject text into the users queue as if they input the data themselves.

Example: I want a tasty Pizza.

]

error_keys

object

A string or array of strings that represent the keys to be used for error handling. This will match the key(s) in the response from the API call.

anyOf

MOD1
MOD2

string

url stringrequired

The endpoint for the external service or API.

Example: https://example.com

foreach

object

Iterates over an array of objects and processes a output based on each element in the array. Works similarly to JavaScript's forEach method.

input_key stringrequired

The key to be used to access the current element in the array.

Example: success

output_key stringrequired

The key that can be referenced in the output of the foreach iteration. The values that are stored from append will be stored in this key.

Example: deliverer

max integer

The max amount of elements that are iterated over in the array. This will start at the beginning of the array.

Example: 5

append stringrequired

The values to append to the output_key. Properties from the object can be referenced and added to the output_key by using the following syntax: ${this.property_name}. The this keyword is used to reference the current object in the array.

headers object

Any necessary headers for the API call.

method string

The HTTP method (GET, POST, etc.) for the API call.

Possible values: [GET, POST, PUT, DELETE]

input_args_as_params boolean

A boolean to determine if the input arguments should be passed as parameters.

params object

An object of any necessary parameters for the API call. The key is the parameter name and the value is the parameter value.

require_args

object

A string or array of strings that represent the arguments that are required to make the webhook request.

anyOf

MOD1
MOD2

string

output

object

required

An object that defines the response or action to be taken when the webhook is successfully triggered.

response stringrequired

A static response text or message returned to the AI agents context.

Example: Order placed

action

object[]

A list of actions to be performed upon matching.

Array [

anyOf

context_switch

object

required

A JSON object containing the context to switch to. Default is not set.

system_prompt stringrequired

The instructions to send to the agent. Default is not set.

consolidate boolean

Whether to consolidate the context. Default is false.

user_prompt string

A string serving as simulated user input for the AI Agent. During a context_switch in the AI's prompt, the user_prompt offers the AI pre-established context or guidance. Default is not set

playback_bg

object

required

A JSON object containing the audio file to play.

file urirequired

URL or filepath of the audio file to play.

Example: http://audiofile.com

wait boolean

Whether to wait for the audio file to finish playing before continuing. Default is false.

say say (string)required

A message to be spoken by the AI agent.

Example: Welcome to Franklin's Pizza.

set_global_data objectrequired

A JSON object containing any global data, as a key-value map. This action sets the data in the global_meta_data to be globally referenced.

Example: {"small_size":"8 Inch","large_size":"12 Inch","closed":"Monday"}

set_meta_data objectrequired

A JSON object containing any metadata, as a key-value map. This action sets the data in the meta_data to be referenced locally in the function.

Example: {"extra_cheese":"Can't do","extra_large_pizza":"Only on Friday"}

toggle_functions

object[]

required

Whether to toggle the functions on or off.

Array [

active booleanrequired

Whether to activate or deactivate the functions. Default is true

function

object

required

The function names to toggle.

anyOf

MOD1
MOD2

string

]

unset_global_data

object

required

The key of the global data to unset from the global_meta_data. You can also reset the global_meta_data by passing in a new object.

anyOf

MOD1
MOD2

string

unset_meta_data

object

required

The key of the local data to unset from the meta_data. You can also reset the meta_data by passing in a new object.

anyOf

MOD1
MOD2

string

user_input user_input (string)required

Used to inject text into the users queue as if they input the data themselves.

Example: I want a tasty Pizza.

]

web_hook_url string

Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of username:password@url.

Example: username:password:https://music.com

wait_file uri

A file to play while the function is running. wait_file_loops can specify the amount of times that files should continously play. Default is not set.

Example: https://music.com

wait_file_loops

object

The number of times to loop playing the file. Default is not set.

anyOf

MOD1
MOD2

integer

]

links

object

required

self urirequired

Link of the current page

Example: https://{space_name}.signalwire.com/api/fabric/resources/ai_agents?page_number=0&page_size=50

first urirequired

Link to the first page

Example: https://{space_name}.signalwire.com/api/fabric/resources/ai_agents?page_number=0&page_size=50

next urirequired

Link to the next page

Example:

https://{space_name}.signalwire.com/api/fabric/resources/ai_agents?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca

{
  "data": [
    {
      "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "My AI Agent",
      "prompt": {
        "text": "Prompt text",
        "temperature": 0,
        "top_p": 0,
        "confidence": 0,
        "presence_penalty": 0,
        "frequency_penalty": 0,
        "contexts": {
          "default": {
            "steps": [
              {
                "name": "Take Pizza order",
                "text": "Your name is Franklin and you are taking orders for Franklin's Pizza.",
                "step_criteria": "Customer wants to order Pizza",
                "functions": [
                  "Take Order",
                  "Confirm Order",
                  "Confirm Address"
                ],
                "valid_contexts": [
                  "Place Order",
                  "Confirm Order"
                ],
                "skip_user_turn": true,
                "end": true
              },
              {
                "name": "Take Pizza order",
                "text": "Your name is Franklin and you are taking orders for Franklin's Pizza.",
                "step_criteria": "Customer wants to order Pizza",
                "functions": [
                  "Take Order",
                  "Confirm Order",
                  "Confirm Address"
                ],
                "valid_contexts": [
                  "Place Order",
                  "Confirm Order"
                ],
                "skip_user_turn": true,
                "valid_steps": [
                  "get order",
                  "confirm order"
                ]
              }
            ]
          }
        }
      },
      "post_prompt": {
        "text": "Prompt text",
        "temperature": 0,
        "top_p": 0,
        "confidence": 0,
        "presence_penalty": 0,
        "frequency_penalty": 0
      },
      "params": {
        "acknowledge_interruptions": true,
        "ai_volume": 0,
        "attention_timeout": 0,
        "attention_timeout_prompt": "Ask if the user can listen to you or they need more time to respond",
        "background_file": "https://audiourl.com",
        "background_file_loops": 5,
        "background_file_volume": 0,
        "barge_match_string": "Cancel order",
        "barge_min_words": 0,
        "conscience": "Place an order",
        "conversation_id": "Converation ID",
        "debug_webhook_level": 0,
        "debug_webhook_url": "https://example.com",
        "direction": [
          "inbound"
        ],
        "digit_termiantors": "#",
        "digit_timeout": 0,
        "end_of_speech_timeout": 0,
        "eleven_labs_stability": 0,
        "eleven_labs_similarity": 0,
        "energy_level": 0,
        "hold_music": "https://holdmusic.com",
        "hold_on_process": true,
        "inactivity_timeout": 0,
        "input_poll_freq": "string",
        "interrupt_on_noise": true,
        "interrupt_prompt": "Inform user that you can't hear anything",
        "languages_enabled": true,
        "local_tz": "America/Ensenada",
        "outbound_attention_timeout": 0,
        "save_conversation": true,
        "swaig_allow_settings": true,
        "swaig_allow_swml": true,
        "swaig_post_conversation": true,
        "transfer_summary": true,
        "verbose_logs": true,
        "wait_for_user": true
      },
      "pronounce": [
        {
          "replace": "pizza",
          "with": "pissa",
          "ignore_case": true
        }
      ],
      "hints": [
        "One Hint",
        "Two Hint"
      ],
      "languages": [
        {
          "name": "French",
          "code": "fr-FR",
          "voice": "fr-FR-Neural2-B",
          "function_fillers": [
            "great",
            "ok"
          ],
          "speech_fillers": [
            "umm",
            "hmm"
          ]
        }
      ],
      "SWAIG": [
        {
          "defaults": {
            "web_hook_url": "username:password@https://example.com"
          },
          "native_functions": [
            "check_time"
          ],
          "includes": [
            {
              "functions": [
                "transfer call",
                "notify kitchen"
              ],
              "url": "username:password@https://example.com",
              "meta_data": {}
            }
          ],
          "functions": [
            {
              "function": "get_weather",
              "description": "Get the weather information",
              "parameters": {
                "type": "object",
                "properties": {},
                "required": [
                  "name1",
                  "name2"
                ]
              },
              "active": true,
              "meta_data": {},
              "meta_data_token": "string",
              "data_map": {
                "output": {
                  "response": "Order placed",
                  "action": [
                    {
                      "context_switch": {
                        "system_prompt": "string",
                        "consolidate": true,
                        "user_prompt": "string"
                      }
                    },
                    {
                      "playback_bg": {
                        "file": "http://audiofile.com",
                        "wait": true
                      }
                    },
                    {
                      "say": "Welcome to Franklin's Pizza."
                    },
                    {
                      "set_global_data": {
                        "small_size": "8 Inch",
                        "large_size": "12 Inch",
                        "closed": "Monday"
                      }
                    },
                    {
                      "set_meta_data": {
                        "extra_cheese": "Can't do",
                        "extra_large_pizza": "Only on Friday"
                      }
                    },
                    {
                      "stop": true
                    },
                    {
                      "stop_playback_bg": true
                    },
                    {
                      "toggle_functions": [
                        {
                          "active": true,
                          "function": "string"
                        }
                      ]
                    },
                    {
                      "unset_global_data": "string"
                    },
                    {
                      "unset_meta_data": "string"
                    },
                    {
                      "user_input": "I want a tasty Pizza."
                    }
                  ]
                }
              },
              "web_hook_url": "username:password:https://music.com",
              "wait_file": "https://music.com",
              "wait_file_loops": 0
            }
          ]
        }
      ]
    }
  ],
  "links": {
    "self": "https://{space_name}.signalwire.com/api/fabric/resources/ai_agents?page_number=0&page_size=50",
    "first": "https://{space_name}.signalwire.com/api/fabric/resources/ai_agents?page_number=0&page_size=50",
    "next": "https://{space_name}.signalwire.com/api/fabric/resources/ai_agents?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
  }
}

Access is unauthorized.

application/json

Schema

Schema

string

Possible values: [Unauthorized]

The server cannot find the requested resource.

application/json

Schema

Schema

string

Possible values: [Not Found]

List AI Agents

/resources/ai_agents

Request​

Responses​

Request

Responses