For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • BedrockAgent
      • CLI Tools
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions
      • LiveWire
      • MCP Gateway
      • PomBuilder
      • Prefabs
      • Search
      • SkillBase
      • Skills
      • SWAIGFunction
      • SWMLBuilder
      • SWMLService
      • WebService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • Chat
      • Compat
      • Datasphere
      • Fabric
        • Addresses
        • AI Agents
          • create
          • delete
          • get
          • list
          • list_addresses
          • update
        • Call Flows
        • Conference Rooms
        • cXML Applications
        • cXML Scripts
        • cXML Webhooks
        • FreeSWITCH Connectors
        • RELAY Applications
        • Resources
        • SIP Endpoints
        • SIP Gateways
        • Subscribers
        • SWML Scripts
        • SWML Webhooks
        • Tokens
      • Imported Numbers
      • Logs
      • Lookup
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSub
      • Queues
      • Recordings
      • Registry
      • RestClient
      • Short Codes
      • SignalWireRestError
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Response Example
  • Example
REST ClientFabricAI Agents

list

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

list_addresses

Next
Built with

List AI agent resources in the project.

Response

datalist of objectsRequired
An array of objects containing the list of AI Agent data.
linksobjectRequired
Object containing pagination links

Response Example

Response
1{
2 "data": [
3 {
4 "id": "a87db7ed-8ebe-42e4-829f-8ba5a4152f54",
5 "project_id": "99151cf8-9548-4860-ba70-a8de824f3312",
6 "display_name": "Booking Assistant",
7 "type": "ai_agent",
8 "created_at": "2024-05-06T12:20:00Z",
9 "updated_at": "2024-05-06T12:20:00Z",
10 "ai_agent": {
11 "prompt": {
12 "max_tokens": 256,
13 "temperature": 0.7,
14 "top_p": 0.9,
15 "confidence": 0.6,
16 "presence_penalty": 0,
17 "frequency_penalty": 0,
18 "text": "Your name is Franklin and you are taking orders for Franklin's Pizza. Begin by greeting the caller, and ask if they'd like to place an order for pickup or delivery.",
19 "contexts": {
20 "default": {
21 "steps": [
22 {}
23 ],
24 "isolated": true,
25 "enter_fillers": [
26 {}
27 ],
28 "exit_fillers": [
29 {}
30 ],
31 "pom": [
32 {}
33 ]
34 }
35 }
36 },
37 "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
38 "name": "My AI Agent",
39 "global_data": {
40 "company_name": "Acme Corp",
41 "support_hours": "9am-5pm EST"
42 },
43 "hints": [
44 "pizza",
45 "pepperoni"
46 ],
47 "languages": [
48 {
49 "name": "French",
50 "code": "fr-FR",
51 "voice": "gcloud.fr-FR-Neural2-B",
52 "model": "arcana",
53 "emotion": "auto",
54 "speed": "auto",
55 "engine": "elevenlabs",
56 "params": {
57 "stability": 1.1,
58 "similarity": 1.1
59 },
60 "fillers": [
61 "umm",
62 "let me check"
63 ]
64 }
65 ],
66 "params": {
67 "acknowledge_interruptions": true,
68 "ai_model": "gpt-4o-mini",
69 "ai_name": "assistant",
70 "ai_volume": 0,
71 "app_name": "customer-support-bot",
72 "asr_smart_format": true,
73 "attention_timeout": 30000,
74 "attention_timeout_prompt": "Ask if the user would like you to repeat yourself, or if they need more time to respond.",
75 "asr_diarize": true,
76 "asr_speaker_affinity": true,
77 "audible_debug": false,
78 "audible_latency": false,
79 "background_file": "https://cdn.signalwire.com/default-music/welcome.mp3",
80 "background_file_loops": 5,
81 "background_file_volume": -10,
82 "enable_barge": "complete,partial",
83 "enable_inner_dialog": true,
84 "enable_pause": true,
85 "enable_turn_detection": true,
86 "barge_match_string": "Cancel order",
87 "barge_min_words": 3,
88 "barge_functions": true,
89 "cache_mode": true,
90 "conscience": "Place an order",
91 "convo": [
92 {
93 "role": "user",
94 "content": "Hello, how can I assist you today?",
95 "lang": "en"
96 }
97 ],
98 "conversation_id": "Conversation ID",
99 "conversation_sliding_window": 20,
100 "debug_webhook_level": 1,
101 "debug_webhook_url": "https://example.com",
102 "debug": true,
103 "direction": "inbound",
104 "digit_terminators": "#",
105 "digit_timeout": 3000,
106 "end_of_speech_timeout": 700,
107 "enable_accounting": true,
108 "enable_thinking": true,
109 "enable_vision": true,
110 "energy_level": 52,
111 "first_word_timeout": 1000,
112 "function_wait_for_talking": true,
113 "functions_on_no_response": true,
114 "hard_stop_prompt": "Thank you for calling. The maximum call time has been reached. Goodbye!",
115 "hard_stop_time": "30m",
116 "hold_music": "https://cdn.signalwire.com/default-music/welcome.mp3",
117 "hold_on_process": true,
118 "inactivity_timeout": 600000,
119 "inner_dialog_model": "gpt-4.1-nano",
120 "inner_dialog_prompt": "Analyze the conversation and provide insights to help the agent respond better.",
121 "inner_dialog_synced": true,
122 "initial_sleep_ms": 1000,
123 "input_poll_freq": 2000,
124 "interrupt_on_noise": true,
125 "interrupt_prompt": "Inform user that you can't hear anything",
126 "languages_enabled": true,
127 "local_tz": "America/Ensenada",
128 "llm_diarize_aware": true,
129 "max_emotion": 15,
130 "max_response_tokens": 1024,
131 "openai_asr_engine": "nova-3",
132 "outbound_attention_timeout": 120000,
133 "persist_global_data": true,
134 "pom_format": "markdown",
135 "save_conversation": true,
136 "speech_event_timeout": 1400,
137 "speech_gen_quick_stops": 3,
138 "speech_timeout": 60000,
139 "speak_when_spoken_to": true,
140 "start_paused": true,
141 "static_greeting": "Hello! Welcome to our customer service. How can I help you today?",
142 "static_greeting_no_barge": true,
143 "summary_mode": "string",
144 "swaig_allow_settings": true,
145 "swaig_allow_swml": true,
146 "swaig_post_conversation": true,
147 "swaig_set_global_data": true,
148 "swaig_post_swml_vars": true,
149 "thinking_model": "gpt-4.1-mini",
150 "transparent_barge": true,
151 "transparent_barge_max_time": 3000,
152 "transfer_summary": true,
153 "turn_detection_timeout": 250,
154 "tts_number_format": "international",
155 "verbose_logs": true,
156 "video_listening_file": "https://example.com/listening.mp4",
157 "video_idle_file": "https://example.com/idle.mp4",
158 "video_talking_file": "https://example.com/talking.mp4",
159 "vision_model": "gpt-4o-mini",
160 "vad_config": "50:20",
161 "wait_for_user": true,
162 "wake_prefix": "hey",
163 "eleven_labs_stability": 0.5,
164 "eleven_labs_similarity": 0.75
165 },
166 "post_prompt": {
167 "max_tokens": 256,
168 "temperature": 0.7,
169 "top_p": 0.9,
170 "confidence": 0.6,
171 "presence_penalty": 0,
172 "frequency_penalty": 0,
173 "text": "Summarize the conversation and provide any follow-up action items."
174 },
175 "post_prompt_url": "username:password@https://example.com",
176 "pronounce": [
177 {
178 "replace": "pizza",
179 "with": "pissa",
180 "ignore_case": true
181 }
182 ],
183 "SWAIG": {
184 "defaults": {
185 "web_hook_url": "username:password@https://example.com"
186 },
187 "native_functions": [
188 "check_time"
189 ],
190 "includes": [
191 {
192 "functions": [
193 "transfer call",
194 "notify kitchen"
195 ],
196 "url": "username:password@https://example.com",
197 "meta_data": {
198 "customer_id": "cust_123",
199 "session_type": "support"
200 }
201 }
202 ],
203 "functions": [
204 {
205 "description": "Get the weather information",
206 "purpose": "Get the weather information",
207 "parameters": {
208 "type": "object",
209 "properties": {},
210 "required": [
211 "name1",
212 "name2"
213 ]
214 },
215 "fillers": {
216 "default": [
217 "one moment please",
218 "let me check"
219 ]
220 },
221 "argument": {
222 "type": "object",
223 "properties": {},
224 "required": [
225 "name1",
226 "name2"
227 ]
228 },
229 "active": true,
230 "meta_data": {
231 "api_key": "key_123",
232 "endpoint": "https://api.example.com"
233 },
234 "meta_data_token": "my-function-scope",
235 "data_map": {
236 "output": {
237 "response": "Order placed",
238 "action": [
239 {}
240 ]
241 },
242 "expressions": [
243 {
244 "string": "I want a refund",
245 "pattern": "refund|return|money back",
246 "output": {
247 "response": "Order placed",
248 "action": {}
249 }
250 }
251 ],
252 "webhooks": [
253 {
254 "expressions": [
255 {
256 "string": "I want a refund",
257 "pattern": "refund|return|money back",
258 "output": {}
259 }
260 ],
261 "error_keys": "failed",
262 "url": "https://example.com",
263 "foreach": {
264 "input_key": "success",
265 "output_key": "deliverer",
266 "max": 5,
267 "append": "title: ${this.title}, contact: ${this.phone}"
268 },
269 "headers": {
270 "Content-Type": "application/json",
271 "X-API-Key": "your-api-key"
272 },
273 "method": "POST",
274 "input_args_as_params": true,
275 "params": {
276 "account_id": "acc_123",
277 "include_details": true
278 },
279 "require_args": [
280 "order_id",
281 "customer_email"
282 ],
283 "output": {
284 "response": "Order placed",
285 "action": {}
286 }
287 }
288 ]
289 },
290 "skip_fillers": true,
291 "web_hook_url": "username:password:https://statuscallback.com",
292 "wait_file": "https://cdn.signalwire.com/default-music/welcome.mp3",
293 "wait_file_loops": 5,
294 "wait_for_fillers": true,
295 "function": "get_weather"
296 }
297 ],
298 "internal_fillers": {
299 "hangup": {
300 "default": [
301 "one moment please",
302 "let me check"
303 ]
304 },
305 "check_time": {
306 "default": [
307 "one moment please",
308 "let me check"
309 ]
310 },
311 "wait_for_user": {
312 "default": [
313 "one moment please",
314 "let me check"
315 ]
316 },
317 "wait_seconds": {
318 "default": [
319 "one moment please",
320 "let me check"
321 ]
322 },
323 "adjust_response_latency": {
324 "default": [
325 "one moment please",
326 "let me check"
327 ]
328 },
329 "next_step": {
330 "default": [
331 "one moment please",
332 "let me check"
333 ]
334 },
335 "change_context": {
336 "default": [
337 "one moment please",
338 "let me check"
339 ]
340 },
341 "get_visual_input": {
342 "default": [
343 "one moment please",
344 "let me check"
345 ]
346 },
347 "get_ideal_strategy": {
348 "default": [
349 "one moment please",
350 "let me check"
351 ]
352 }
353 }
354 }
355 }
356 }
357 ],
358 "links": {
359 "self": "https://example.signalwire.com/api/fabric/resources/ai_agents?page_number=0&page_size=50&type=ai_agent",
360 "first": "https://example.signalwire.com/api/fabric/resources/ai_agents?page_number=0&page_size=50&type=ai_agent",
361 "next": "https://example.signalwire.com/api/fabric/resources/ai_agents?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=ai_agent",
362 "prev": "https://example.signalwire.com/api/fabric/resources/ai_agents?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=ai_agent"
363 }
364}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4 project="your-project-id",
5 token="your-api-token",
6 host="your-space.signalwire.com",
7)
8
9response = client.fabric.ai_agents.list()
10for agent in response.get("data", []):
11 print(f"{agent['display_name']}: {agent['id']}")