Get all agents

GET

https://api.smallest.ai/atoms/v1/agent

GET

/atoms/v1/agent

1 from smallestai import SmallestAI
2 
3 client = SmallestAI(
4     token="YOUR_TOKEN_HERE",
5 )
6 
7 client.atoms.agents.get_all_agents()

1 {
2   "status": true,
3   "data": {
4     "agents": [
5       {
6         "_id": "string",
7         "name": "string",
8         "description": "string",
9         "backgroundSound": "",
10         "organization": "string",
11         "workflowId": "string",
12         "workflowType": "workflow_graph",
13         "createdBy": "string",
14         "globalKnowledgeBaseId": "string",
15         "language": {
16           "default": "en",
17           "switching": {
18             "isEnabled": true,
19             "minWordsForDetection": 1.1,
20             "strongSignalThreshold": 1.1,
21             "weakSignalThreshold": 1.1,
22             "minConsecutiveForWeakThresholdSwitch": 1.1
23           },
24           "supported": [
25             "string"
26           ]
27         },
28         "synthesizer": {
29           "voiceConfig": {
30             "model": "waves_lightning_v3_1",
31             "voiceId": "nyah",
32             "gender": "female"
33           },
34           "speed": 1.2,
35           "consistency": 0.5,
36           "similarity": 0,
37           "enhancement": 1,
38           "sampleRate": 1.1
39         },
40         "slmModel": "electron",
41         "defaultVariables": {},
42         "preCallAPI": {
43           "url": "string",
44           "method": "GET",
45           "isEnabled": false,
46           "headers": {},
47           "body": {},
48           "timeout": 5,
49           "queryParams": {},
50           "responseVariables": [
51             {
52               "variableName": "string",
53               "jsonPath": "string"
54             }
55           ]
56         },
57         "createdAt": "2024-01-15T09:30:00Z",
58         "updatedAt": "2024-01-15T09:30:00Z",
59         "avatarUrl": "string",
60         "firstMessage": "string",
61         "allowInterruptions": true,
62         "waitForUserToSpeakFirst": true,
63         "totalCalls": 1.1,
64         "transcriberType": "string",
65         "globalPrompt": "string",
66         "archived": true,
67         "archivedAt": "2024-01-15T09:30:00Z",
68         "activeVersionId": "string",
69         "versionId": "string",
70         "allowInboundCall": true,
71         "phoneNumber": [
72           "string"
73         ],
74         "visibleToEveryone": false,
75         "speechFormatting": true,
76         "muteUserUntilFirstBotResponse": false,
77         "interruptionBackoffTimer": 1.1,
78         "enableStyleGuide": true,
79         "callDispositionConfig": "",
80         "voiceMailDetectionConfig": {
81           "enabled": false,
82           "endText": "Terminating call, you can call us back anytime. Thank you for calling."
83         },
84         "smartTurnConfig": {
85           "isEnabled": true,
86           "waitTimeInSecs": 1.1
87         },
88         "voiceDetectionConfig": {
89           "confidence": 0.5,
90           "minVolume": 0.5,
91           "triggerTimeInSecs": 1.1,
92           "releaseTimeInSecs": 1.1
93         },
94         "denoisingConfig": {
95           "isEnabled": true
96         },
97         "redactionConfig": {
98           "isEnabled": true
99         },
100         "pronunciationDicts": [
101           {
102             "word": "string",
103             "pronunciation": "string"
104           }
105         ],
106         "llmIdleTimeoutConfig": {
107           "chatTimeoutTimeInSecs": 1.1,
108           "webcallTimeoutTimeInSecs": 1.1,
109           "telephonyTimeoutTimeInSecs": 1.1,
110           "maxRetries": 1.1
111         },
112         "sessionTimeoutConfig": {
113           "timeoutTimeInSecs": 1.1
114         },
115         "timezone": {
116           "label": "(GMT+0:00) UTC",
117           "offset": 0
118         },
119         "postCallAnalyticsConfig": {
120           "dispositionMetrics": [
121             {
122               "identifier": "call_resolved",
123               "dispositionMetricPrompt": "Was the customer issue resolved by the end of the call?",
124               "dispositionMetricType": "STRING",
125               "choices": [
126                 "resolved",
127                 "escalated",
128                 "callback_scheduled",
129                 "no_action"
130               ]
131             }
132           ],
133           "useInternalAnalyticsModel": true,
134           "useReasoningModel": false,
135           "successMetrics": [
136             {
137               "identifier": "string",
138               "successMetricPrompt": "string",
139               "successMetricType": "NUMERIC_SCALE"
140             }
141           ],
142           "summaryPrompt": ""
143         },
144         "widgetConfig": {
145           "position": "bottom-right",
146           "size": "full",
147           "mode": "chat",
148           "theme": "light",
149           "baseColor": "#ffffff",
150           "accentColor": "#2d9d9f",
151           "agentBubbleColor": "#f3f4f6",
152           "textOnAccentColor": "#FFFFFF",
153           "secondaryTextColor": "#6b7280",
154           "primaryTextColor": "#111827",
155           "startButtonText": "Start",
156           "endButtonText": "End",
157           "ctaName": "Talk to Atoms",
158           "widgetName": "Atoms",
159           "avatarUrl": "string",
160           "chatPlaceholder": "Type your message...",
161           "consentRequired": false,
162           "consentTitle": "Privacy Agreement",
163           "consentContent": "string",
164           "assistantId": "string",
165           "allowlist": [
166             "string"
167           ]
168         },
169         "_resolvedConfig": {
170           "prompt": "string",
171           "tools": [
172             {
173               "type": "end_call",
174               "name": "end_call",
175               "description": "End the conversation when the user is satisfied",
176               "enabled": true,
177               "transferNumber": "+1234567890",
178               "transferOption": {
179                 "type": "cold_transfer",
180                 "privateHandoffOption": {
181                   "type": "prompt",
182                   "prompt": "string"
183                 },
184                 "publicHandoffOption": {
185                   "type": "prompt",
186                   "prompt": "string"
187                 }
188               },
189               "onHoldMusic": "ringtone",
190               "transferOnlyIfHuman": true,
191               "detectionTimeout": 30,
192               "url": "https://api.example.com/orders",
193               "method": "GET",
194               "timeout": 5000,
195               "headers": {
196                 "Authorization": "Bearer TOKEN",
197                 "Content-Type": "application/json"
198               },
199               "headersArray": [
200                 {
201                   "key": "Authorization",
202                   "value": "Bearer TOKEN"
203                 }
204               ],
205               "queryParams": [
206                 {
207                   "key": "id",
208                   "value": "{{order_id}}"
209                 }
210               ],
211               "requestBody": "{\"customer_id\": \"{{customer_id}}\"}",
212               "llmParameters": [
213                 {
214                   "name": "string",
215                   "description": "string",
216                   "type": "text",
217                   "values": [
218                     "string"
219                   ],
220                   "required": false
221                 }
222               ],
223               "responseVariables": [
224                 {
225                   "variableName": "orderStatus",
226                   "jsonPath": "$.data.status"
227                 }
228               ],
229               "variablesExtractionSchema": [
230                 {
231                   "name": "customer_name",
232                   "description": "The customer's full name",
233                   "type": "text",
234                   "values": [
235                     "satisfied",
236                     "unsatisfied",
237                     "neutral"
238                   ]
239                 }
240               ],
241               "knowledgeBaseId": "60d0fe4f5311236168a109ca",
242               "fillerPhrases": [
243                 "Let me check that for you",
244                 "One moment please"
245               ]
246             }
247           ],
248           "postCallAnalyticsConfig": {
249             "dispositionMetrics": [
250               {
251                 "identifier": "call_resolved",
252                 "dispositionMetricPrompt": "Was the customer issue resolved by the end of the call?",
253                 "dispositionMetricType": "STRING",
254                 "choices": [
255                   "resolved",
256                   "escalated",
257                   "callback_scheduled",
258                   "no_action"
259                 ]
260               }
261             ],
262             "useInternalAnalyticsModel": true,
263             "useReasoningModel": false,
264             "successMetrics": [
265               {
266                 "identifier": "string",
267                 "successMetricPrompt": "string",
268                 "successMetricType": "NUMERIC_SCALE"
269               }
270             ],
271             "summaryPrompt": ""
272           },
273           "callDispositionConfig": "string",
274           "modelName": "string",
275           "transcriberType": "string",
276           "defaultLanguage": "en",
277           "supportedLanguages": [
278             "string"
279           ],
280           "languageSwitching": {},
281           "firstMessage": "string",
282           "globalPrompt": "string",
283           "preCallAPI": {},
284           "workflowGraph": {},
285           "muteUserUntilFirstBotResponse": true,
286           "allowInterruptions": true,
287           "voiceDetectionConfig": {},
288           "smartTurnConfig": {},
289           "backgroundSound": "string",
290           "denoisingConfig": {},
291           "redactionConfig": {},
292           "llmIdleTimeoutConfig": {},
293           "sessionTimeoutConfig": {}
294         },
295         "_configSource": "active",
296         "_versionedWorkflow": {
297           "prompt": "string",
298           "tools": [
299             {
300               "type": "end_call",
301               "name": "end_call",
302               "description": "End the conversation when the user is satisfied",
303               "enabled": true,
304               "transferNumber": "+1234567890",
305               "transferOption": {
306                 "type": "cold_transfer",
307                 "privateHandoffOption": {
308                   "type": "prompt",
309                   "prompt": "string"
310                 },
311                 "publicHandoffOption": {
312                   "type": "prompt",
313                   "prompt": "string"
314                 }
315               },
316               "onHoldMusic": "ringtone",
317               "transferOnlyIfHuman": true,
318               "detectionTimeout": 30,
319               "url": "https://api.example.com/orders",
320               "method": "GET",
321               "timeout": 5000,
322               "headers": {
323                 "Authorization": "Bearer TOKEN",
324                 "Content-Type": "application/json"
325               },
326               "headersArray": [
327                 {
328                   "key": "Authorization",
329                   "value": "Bearer TOKEN"
330                 }
331               ],
332               "queryParams": [
333                 {
334                   "key": "id",
335                   "value": "{{order_id}}"
336                 }
337               ],
338               "requestBody": "{\"customer_id\": \"{{customer_id}}\"}",
339               "llmParameters": [
340                 {
341                   "name": "string",
342                   "description": "string",
343                   "type": "text",
344                   "values": [
345                     "string"
346                   ],
347                   "required": false
348                 }
349               ],
350               "responseVariables": [
351                 {
352                   "variableName": "orderStatus",
353                   "jsonPath": "$.data.status"
354                 }
355               ],
356               "variablesExtractionSchema": [
357                 {
358                   "name": "customer_name",
359                   "description": "The customer's full name",
360                   "type": "text",
361                   "values": [
362                     "satisfied",
363                     "unsatisfied",
364                     "neutral"
365                   ]
366                 }
367               ],
368               "knowledgeBaseId": "60d0fe4f5311236168a109ca",
369               "fillerPhrases": [
370                 "Let me check that for you",
371                 "One moment please"
372               ]
373             }
374           ],
375           "workflowGraph": {}
376         }
377       }
378     ],
379     "total": 1.1
380   }
381 }

Agents are the main entities in the system. Agents are used to create conversations. You can create workflow for an agent and configure it for different use cases. You can also create custom workflows for an agent. This API will give you the list of agents created by organization you are a part of.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Query parameters

pageintegerOptionalDefaults to 1

offsetintegerOptionalDefaults to 10

searchstringOptional

typeenumOptional

Filter agents by workflow type

Allowed values:

sortFieldenumOptionalDefaults to createdAt

Field to sort results by

Allowed values:

sortOrderenumOptionalDefaults to desc

Sort direction

Allowed values:

archivedbooleanOptionalDefaults to false

When true, returns only archived agents. Omit or set to false to return active agents.

Response

Successful response

statusboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error