syllable-sdk 0.1.0-alpha.59 → 0.1.0-alpha.60

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (220) hide show
  1. package/FUNCTIONS.md +11 -1
  2. package/README.md +75 -6
  3. package/docs/sdks/agents/README.md +23 -3
  4. package/docs/sdks/channels/README.md +22 -2
  5. package/docs/sdks/conversations/README.md +22 -2
  6. package/docs/sdks/custommessages/README.md +23 -3
  7. package/docs/sdks/dashboards/README.md +22 -2
  8. package/docs/sdks/datasources/README.md +23 -3
  9. package/docs/sdks/events/README.md +22 -2
  10. package/docs/sdks/languagegroups/README.md +23 -3
  11. package/docs/sdks/prompts/README.md +23 -3
  12. package/docs/sdks/services/README.md +22 -2
  13. package/docs/sdks/sessiondebug/README.md +245 -0
  14. package/docs/sdks/sessionlabels/README.md +23 -3
  15. package/docs/sdks/sessions/README.md +23 -3
  16. package/docs/sdks/syllablesdktools/README.md +22 -2
  17. package/docs/sdks/targets/README.md +45 -5
  18. package/docs/sdks/tools/README.md +23 -3
  19. package/docs/sdks/v1/README.md +22 -2
  20. package/docs/sdks/workflows/README.md +22 -2
  21. package/funcs/sessionDebugGetSessionDataBySessionId.d.ts +14 -0
  22. package/funcs/sessionDebugGetSessionDataBySessionId.d.ts.map +1 -0
  23. package/funcs/sessionDebugGetSessionDataBySessionId.js +105 -0
  24. package/funcs/sessionDebugGetSessionDataBySessionId.js.map +1 -0
  25. package/funcs/sessionDebugGetSessionDataBySid.d.ts +14 -0
  26. package/funcs/sessionDebugGetSessionDataBySid.d.ts.map +1 -0
  27. package/funcs/sessionDebugGetSessionDataBySid.js +103 -0
  28. package/funcs/sessionDebugGetSessionDataBySid.js.map +1 -0
  29. package/funcs/sessionDebugGetSessionToolCallResultById.d.ts +14 -0
  30. package/funcs/sessionDebugGetSessionToolCallResultById.d.ts.map +1 -0
  31. package/funcs/sessionDebugGetSessionToolCallResultById.js +109 -0
  32. package/funcs/sessionDebugGetSessionToolCallResultById.js.map +1 -0
  33. package/jsr.json +1 -1
  34. package/lib/config.d.ts +2 -2
  35. package/lib/config.js +2 -2
  36. package/mintlify/mint.json +2 -9
  37. package/models/components/agentresponse.d.ts +2 -1
  38. package/models/components/agentresponse.d.ts.map +1 -1
  39. package/models/components/agentresponse.js.map +1 -1
  40. package/models/components/channeltargetresponse.d.ts +2 -1
  41. package/models/components/channeltargetresponse.d.ts.map +1 -1
  42. package/models/components/channeltargetresponse.js.map +1 -1
  43. package/models/components/custommessageresponse.d.ts +2 -1
  44. package/models/components/custommessageresponse.d.ts.map +1 -1
  45. package/models/components/custommessageresponse.js.map +1 -1
  46. package/models/components/datasourcedetailresponse.d.ts +6 -1
  47. package/models/components/datasourcedetailresponse.d.ts.map +1 -1
  48. package/models/components/datasourcedetailresponse.js.map +1 -1
  49. package/models/components/datasourcemetadataresponse.d.ts +6 -1
  50. package/models/components/datasourcemetadataresponse.d.ts.map +1 -1
  51. package/models/components/datasourcemetadataresponse.js.map +1 -1
  52. package/models/components/dialogmessage.d.ts +29 -0
  53. package/models/components/dialogmessage.d.ts.map +1 -0
  54. package/models/components/dialogmessage.js +59 -0
  55. package/models/components/dialogmessage.js.map +1 -0
  56. package/models/components/dialogrole.d.ts +28 -0
  57. package/models/components/dialogrole.d.ts.map +1 -0
  58. package/models/components/dialogrole.js +51 -0
  59. package/models/components/dialogrole.js.map +1 -0
  60. package/models/components/dialogtoolcall.d.ts +56 -0
  61. package/models/components/dialogtoolcall.d.ts.map +1 -0
  62. package/models/components/dialogtoolcall.js +101 -0
  63. package/models/components/dialogtoolcall.js.map +1 -0
  64. package/models/components/index.d.ts +6 -0
  65. package/models/components/index.d.ts.map +1 -1
  66. package/models/components/index.js +6 -0
  67. package/models/components/index.js.map +1 -1
  68. package/models/components/languagegroupresponse.d.ts +7 -0
  69. package/models/components/languagegroupresponse.d.ts.map +1 -1
  70. package/models/components/languagegroupresponse.js.map +1 -1
  71. package/models/components/promptresponse.d.ts +2 -1
  72. package/models/components/promptresponse.d.ts.map +1 -1
  73. package/models/components/promptresponse.js.map +1 -1
  74. package/models/components/sessiondata.d.ts +38 -0
  75. package/models/components/sessiondata.d.ts.map +1 -0
  76. package/models/components/sessiondata.js +79 -0
  77. package/models/components/sessiondata.js.map +1 -0
  78. package/models/components/sessionmessage.d.ts +38 -0
  79. package/models/components/sessionmessage.d.ts.map +1 -0
  80. package/models/components/sessionmessage.js +77 -0
  81. package/models/components/sessionmessage.js.map +1 -0
  82. package/models/components/sessiontranscriptionresponse.d.ts +4 -1
  83. package/models/components/sessiontranscriptionresponse.d.ts.map +1 -1
  84. package/models/components/sessiontranscriptionresponse.js.map +1 -1
  85. package/models/components/testmessage.d.ts +5 -3
  86. package/models/components/testmessage.d.ts.map +1 -1
  87. package/models/components/testmessage.js +2 -2
  88. package/models/components/testmessage.js.map +1 -1
  89. package/models/components/tooldetailresponse.d.ts +1 -0
  90. package/models/components/tooldetailresponse.d.ts.map +1 -1
  91. package/models/components/tooldetailresponse.js.map +1 -1
  92. package/models/components/toolresponse.d.ts +1 -0
  93. package/models/components/toolresponse.d.ts.map +1 -1
  94. package/models/components/toolresponse.js.map +1 -1
  95. package/models/components/toolresultdata.d.ts +52 -0
  96. package/models/components/toolresultdata.d.ts.map +1 -0
  97. package/models/components/toolresultdata.js +95 -0
  98. package/models/components/toolresultdata.js.map +1 -0
  99. package/models/operations/agentlist.d.ts +27 -0
  100. package/models/operations/agentlist.d.ts.map +1 -1
  101. package/models/operations/agentlist.js.map +1 -1
  102. package/models/operations/availabletargets.d.ts +27 -0
  103. package/models/operations/availabletargets.d.ts.map +1 -1
  104. package/models/operations/availabletargets.js.map +1 -1
  105. package/models/operations/channelslist.d.ts +27 -0
  106. package/models/operations/channelslist.d.ts.map +1 -1
  107. package/models/operations/channelslist.js.map +1 -1
  108. package/models/operations/channeltargetslist.d.ts +27 -0
  109. package/models/operations/channeltargetslist.d.ts.map +1 -1
  110. package/models/operations/channeltargetslist.js.map +1 -1
  111. package/models/operations/conversationslist.d.ts +27 -0
  112. package/models/operations/conversationslist.d.ts.map +1 -1
  113. package/models/operations/conversationslist.js.map +1 -1
  114. package/models/operations/custommessageslist.d.ts +27 -0
  115. package/models/operations/custommessageslist.d.ts.map +1 -1
  116. package/models/operations/custommessageslist.js.map +1 -1
  117. package/models/operations/datasourceslist.d.ts +27 -0
  118. package/models/operations/datasourceslist.d.ts.map +1 -1
  119. package/models/operations/datasourceslist.js.map +1 -1
  120. package/models/operations/eventslist.d.ts +27 -0
  121. package/models/operations/eventslist.d.ts.map +1 -1
  122. package/models/operations/eventslist.js.map +1 -1
  123. package/models/operations/getsessiondatabysessionid.d.ts +29 -0
  124. package/models/operations/getsessiondatabysessionid.d.ts.map +1 -0
  125. package/models/operations/getsessiondatabysessionid.js +68 -0
  126. package/models/operations/getsessiondatabysessionid.js.map +1 -0
  127. package/models/operations/getsessiondatabysid.d.ts +31 -0
  128. package/models/operations/getsessiondatabysid.d.ts.map +1 -0
  129. package/models/operations/getsessiondatabysid.js +72 -0
  130. package/models/operations/getsessiondatabysid.js.map +1 -0
  131. package/models/operations/getsessiontoolcallresultbyid.d.ts +31 -0
  132. package/models/operations/getsessiontoolcallresultbyid.d.ts.map +1 -0
  133. package/models/operations/getsessiontoolcallresultbyid.js +72 -0
  134. package/models/operations/getsessiontoolcallresultbyid.js.map +1 -0
  135. package/models/operations/index.d.ts +3 -0
  136. package/models/operations/index.d.ts.map +1 -1
  137. package/models/operations/index.js +3 -0
  138. package/models/operations/index.js.map +1 -1
  139. package/models/operations/insightsworkflowlist.d.ts +27 -0
  140. package/models/operations/insightsworkflowlist.d.ts.map +1 -1
  141. package/models/operations/insightsworkflowlist.js.map +1 -1
  142. package/models/operations/insighttoollist.d.ts +27 -0
  143. package/models/operations/insighttoollist.d.ts.map +1 -1
  144. package/models/operations/insighttoollist.js.map +1 -1
  145. package/models/operations/languagegroupslist.d.ts +27 -0
  146. package/models/operations/languagegroupslist.d.ts.map +1 -1
  147. package/models/operations/languagegroupslist.js.map +1 -1
  148. package/models/operations/postlistdashboard.d.ts +27 -0
  149. package/models/operations/postlistdashboard.d.ts.map +1 -1
  150. package/models/operations/postlistdashboard.js.map +1 -1
  151. package/models/operations/promptslist.d.ts +27 -0
  152. package/models/operations/promptslist.d.ts.map +1 -1
  153. package/models/operations/promptslist.js.map +1 -1
  154. package/models/operations/servicelist.d.ts +27 -0
  155. package/models/operations/servicelist.d.ts.map +1 -1
  156. package/models/operations/servicelist.js.map +1 -1
  157. package/models/operations/sessionlabelslist.d.ts +27 -0
  158. package/models/operations/sessionlabelslist.d.ts.map +1 -1
  159. package/models/operations/sessionlabelslist.js.map +1 -1
  160. package/models/operations/sessionslist.d.ts +27 -0
  161. package/models/operations/sessionslist.d.ts.map +1 -1
  162. package/models/operations/sessionslist.js.map +1 -1
  163. package/models/operations/toollist.d.ts +27 -0
  164. package/models/operations/toollist.d.ts.map +1 -1
  165. package/models/operations/toollist.js.map +1 -1
  166. package/openapi.json +1287 -203
  167. package/package.json +1 -1
  168. package/sdk/sdk.d.ts +3 -0
  169. package/sdk/sdk.d.ts.map +1 -1
  170. package/sdk/sdk.js +4 -0
  171. package/sdk/sdk.js.map +1 -1
  172. package/sdk/sessiondebug.d.ts +18 -0
  173. package/sdk/sessiondebug.d.ts.map +1 -0
  174. package/sdk/sessiondebug.js +33 -0
  175. package/sdk/sessiondebug.js.map +1 -0
  176. package/src/funcs/sessionDebugGetSessionDataBySessionId.ts +142 -0
  177. package/src/funcs/sessionDebugGetSessionDataBySid.ts +148 -0
  178. package/src/funcs/sessionDebugGetSessionToolCallResultById.ts +148 -0
  179. package/src/lib/config.ts +2 -2
  180. package/src/models/components/agentresponse.ts +2 -1
  181. package/src/models/components/channeltargetresponse.ts +2 -1
  182. package/src/models/components/custommessageresponse.ts +2 -1
  183. package/src/models/components/datasourcedetailresponse.ts +6 -1
  184. package/src/models/components/datasourcemetadataresponse.ts +6 -1
  185. package/src/models/components/dialogmessage.ts +62 -0
  186. package/src/models/components/dialogrole.ts +31 -0
  187. package/src/models/components/dialogtoolcall.ts +139 -0
  188. package/src/models/components/index.ts +6 -0
  189. package/src/models/components/languagegroupresponse.ts +7 -0
  190. package/src/models/components/promptresponse.ts +2 -1
  191. package/src/models/components/sessiondata.ts +95 -0
  192. package/src/models/components/sessionmessage.ts +100 -0
  193. package/src/models/components/sessiontranscriptionresponse.ts +4 -1
  194. package/src/models/components/testmessage.ts +7 -5
  195. package/src/models/components/tooldetailresponse.ts +1 -0
  196. package/src/models/components/toolresponse.ts +1 -0
  197. package/src/models/components/toolresultdata.ts +123 -0
  198. package/src/models/operations/agentlist.ts +27 -0
  199. package/src/models/operations/availabletargets.ts +27 -0
  200. package/src/models/operations/channelslist.ts +27 -0
  201. package/src/models/operations/channeltargetslist.ts +27 -0
  202. package/src/models/operations/conversationslist.ts +27 -0
  203. package/src/models/operations/custommessageslist.ts +27 -0
  204. package/src/models/operations/datasourceslist.ts +27 -0
  205. package/src/models/operations/eventslist.ts +27 -0
  206. package/src/models/operations/getsessiondatabysessionid.ts +77 -0
  207. package/src/models/operations/getsessiondatabysid.ts +81 -0
  208. package/src/models/operations/getsessiontoolcallresultbyid.ts +86 -0
  209. package/src/models/operations/index.ts +3 -0
  210. package/src/models/operations/insightsworkflowlist.ts +27 -0
  211. package/src/models/operations/insighttoollist.ts +27 -0
  212. package/src/models/operations/languagegroupslist.ts +27 -0
  213. package/src/models/operations/postlistdashboard.ts +27 -0
  214. package/src/models/operations/promptslist.ts +27 -0
  215. package/src/models/operations/servicelist.ts +27 -0
  216. package/src/models/operations/sessionlabelslist.ts +27 -0
  217. package/src/models/operations/sessionslist.ts +27 -0
  218. package/src/models/operations/toollist.ts +27 -0
  219. package/src/sdk/sdk.ts +6 -0
  220. package/src/sdk/sessiondebug.ts +55 -0
package/openapi.json CHANGED
@@ -41,9 +41,14 @@
41
41
  "type": "null"
42
42
  }
43
43
  ],
44
+ "description": "The page number from which to start (0-indexed)",
45
+ "examples": [
46
+ 0
47
+ ],
44
48
  "default": 0,
45
49
  "title": "Page"
46
- }
50
+ },
51
+ "description": "The page number from which to start (0-indexed)"
47
52
  },
48
53
  {
49
54
  "name": "limit",
@@ -52,9 +57,14 @@
52
57
  "schema": {
53
58
  "type": "integer",
54
59
  "minimum": 0,
60
+ "description": "The maximum number of items to return",
61
+ "examples": [
62
+ 25
63
+ ],
55
64
  "default": 25,
56
65
  "title": "Limit"
57
- }
66
+ },
67
+ "description": "The maximum number of items to return"
58
68
  },
59
69
  {
60
70
  "name": "search_fields",
@@ -65,9 +75,14 @@
65
75
  "items": {
66
76
  "$ref": "#/components/schemas/AgentProperties"
67
77
  },
78
+ "description": "String names of fields to search. Correspond by index to search field values",
79
+ "examples": [
80
+ "name"
81
+ ],
68
82
  "default": [],
69
83
  "title": "Search Fields"
70
- }
84
+ },
85
+ "description": "String names of fields to search. Correspond by index to search field values"
71
86
  },
72
87
  {
73
88
  "name": "search_field_values",
@@ -78,9 +93,14 @@
78
93
  "items": {
79
94
  "type": "string"
80
95
  },
96
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
97
+ "examples": [
98
+ "Some Object Name"
99
+ ],
81
100
  "default": [],
82
101
  "title": "Search Field Values"
83
- }
102
+ },
103
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
84
104
  },
85
105
  {
86
106
  "name": "order_by",
@@ -95,8 +115,13 @@
95
115
  "type": "null"
96
116
  }
97
117
  ],
118
+ "description": "The field whose value should be used to order the results",
119
+ "examples": [
120
+ "name"
121
+ ],
98
122
  "title": "Order By"
99
- }
123
+ },
124
+ "description": "The field whose value should be used to order the results"
100
125
  },
101
126
  {
102
127
  "name": "order_by_direction",
@@ -111,8 +136,10 @@
111
136
  "type": "null"
112
137
  }
113
138
  ],
139
+ "description": "The direction in which to order the results",
114
140
  "title": "Order By Direction"
115
- }
141
+ },
142
+ "description": "The direction in which to order the results"
116
143
  },
117
144
  {
118
145
  "name": "fields",
@@ -130,9 +157,11 @@
130
157
  "type": "null"
131
158
  }
132
159
  ],
160
+ "description": "The fields to include in the response",
133
161
  "default": [],
134
162
  "title": "Fields"
135
- }
163
+ },
164
+ "description": "The fields to include in the response"
136
165
  },
137
166
  {
138
167
  "name": "start_datetime",
@@ -147,8 +176,13 @@
147
176
  "type": "null"
148
177
  }
149
178
  ],
179
+ "description": "The start datetime for filtering results",
180
+ "examples": [
181
+ "2023-01-01T00:00:00Z"
182
+ ],
150
183
  "title": "Start Datetime"
151
- }
184
+ },
185
+ "description": "The start datetime for filtering results"
152
186
  },
153
187
  {
154
188
  "name": "end_datetime",
@@ -163,8 +197,13 @@
163
197
  "type": "null"
164
198
  }
165
199
  ],
200
+ "description": "The end datetime for filtering results",
201
+ "examples": [
202
+ "2024-01-01T00:00:00Z"
203
+ ],
166
204
  "title": "End Datetime"
167
- }
205
+ },
206
+ "description": "The end datetime for filtering results"
168
207
  }
169
208
  ],
170
209
  "responses": {
@@ -469,9 +508,14 @@
469
508
  "type": "null"
470
509
  }
471
510
  ],
511
+ "description": "The page number from which to start (0-indexed)",
512
+ "examples": [
513
+ 0
514
+ ],
472
515
  "default": 0,
473
516
  "title": "Page"
474
- }
517
+ },
518
+ "description": "The page number from which to start (0-indexed)"
475
519
  },
476
520
  {
477
521
  "name": "limit",
@@ -480,9 +524,14 @@
480
524
  "schema": {
481
525
  "type": "integer",
482
526
  "minimum": 0,
527
+ "description": "The maximum number of items to return",
528
+ "examples": [
529
+ 25
530
+ ],
483
531
  "default": 25,
484
532
  "title": "Limit"
485
- }
533
+ },
534
+ "description": "The maximum number of items to return"
486
535
  },
487
536
  {
488
537
  "name": "search_fields",
@@ -493,9 +542,14 @@
493
542
  "items": {
494
543
  "$ref": "#/components/schemas/ChannelProperties"
495
544
  },
545
+ "description": "String names of fields to search. Correspond by index to search field values",
546
+ "examples": [
547
+ "name"
548
+ ],
496
549
  "default": [],
497
550
  "title": "Search Fields"
498
- }
551
+ },
552
+ "description": "String names of fields to search. Correspond by index to search field values"
499
553
  },
500
554
  {
501
555
  "name": "search_field_values",
@@ -506,9 +560,14 @@
506
560
  "items": {
507
561
  "type": "string"
508
562
  },
563
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
564
+ "examples": [
565
+ "Some Object Name"
566
+ ],
509
567
  "default": [],
510
568
  "title": "Search Field Values"
511
- }
569
+ },
570
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
512
571
  },
513
572
  {
514
573
  "name": "order_by",
@@ -523,8 +582,13 @@
523
582
  "type": "null"
524
583
  }
525
584
  ],
585
+ "description": "The field whose value should be used to order the results",
586
+ "examples": [
587
+ "name"
588
+ ],
526
589
  "title": "Order By"
527
- }
590
+ },
591
+ "description": "The field whose value should be used to order the results"
528
592
  },
529
593
  {
530
594
  "name": "order_by_direction",
@@ -539,8 +603,10 @@
539
603
  "type": "null"
540
604
  }
541
605
  ],
606
+ "description": "The direction in which to order the results",
542
607
  "title": "Order By Direction"
543
- }
608
+ },
609
+ "description": "The direction in which to order the results"
544
610
  },
545
611
  {
546
612
  "name": "fields",
@@ -558,9 +624,11 @@
558
624
  "type": "null"
559
625
  }
560
626
  ],
627
+ "description": "The fields to include in the response",
561
628
  "default": [],
562
629
  "title": "Fields"
563
- }
630
+ },
631
+ "description": "The fields to include in the response"
564
632
  },
565
633
  {
566
634
  "name": "start_datetime",
@@ -575,8 +643,13 @@
575
643
  "type": "null"
576
644
  }
577
645
  ],
646
+ "description": "The start datetime for filtering results",
647
+ "examples": [
648
+ "2023-01-01T00:00:00Z"
649
+ ],
578
650
  "title": "Start Datetime"
579
- }
651
+ },
652
+ "description": "The start datetime for filtering results"
580
653
  },
581
654
  {
582
655
  "name": "end_datetime",
@@ -591,8 +664,13 @@
591
664
  "type": "null"
592
665
  }
593
666
  ],
667
+ "description": "The end datetime for filtering results",
668
+ "examples": [
669
+ "2024-01-01T00:00:00Z"
670
+ ],
594
671
  "title": "End Datetime"
595
- }
672
+ },
673
+ "description": "The end datetime for filtering results"
596
674
  }
597
675
  ],
598
676
  "responses": {
@@ -695,9 +773,14 @@
695
773
  "type": "null"
696
774
  }
697
775
  ],
776
+ "description": "The page number from which to start (0-indexed)",
777
+ "examples": [
778
+ 0
779
+ ],
698
780
  "default": 0,
699
781
  "title": "Page"
700
- }
782
+ },
783
+ "description": "The page number from which to start (0-indexed)"
701
784
  },
702
785
  {
703
786
  "name": "limit",
@@ -706,9 +789,14 @@
706
789
  "schema": {
707
790
  "type": "integer",
708
791
  "minimum": 0,
792
+ "description": "The maximum number of items to return",
793
+ "examples": [
794
+ 25
795
+ ],
709
796
  "default": 25,
710
797
  "title": "Limit"
711
- }
798
+ },
799
+ "description": "The maximum number of items to return"
712
800
  },
713
801
  {
714
802
  "name": "search_fields",
@@ -719,9 +807,14 @@
719
807
  "items": {
720
808
  "$ref": "#/components/schemas/ConversationProperties"
721
809
  },
810
+ "description": "String names of fields to search. Correspond by index to search field values",
811
+ "examples": [
812
+ "name"
813
+ ],
722
814
  "default": [],
723
815
  "title": "Search Fields"
724
- }
816
+ },
817
+ "description": "String names of fields to search. Correspond by index to search field values"
725
818
  },
726
819
  {
727
820
  "name": "search_field_values",
@@ -732,9 +825,14 @@
732
825
  "items": {
733
826
  "type": "string"
734
827
  },
828
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
829
+ "examples": [
830
+ "Some Object Name"
831
+ ],
735
832
  "default": [],
736
833
  "title": "Search Field Values"
737
- }
834
+ },
835
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
738
836
  },
739
837
  {
740
838
  "name": "order_by",
@@ -749,8 +847,13 @@
749
847
  "type": "null"
750
848
  }
751
849
  ],
850
+ "description": "The field whose value should be used to order the results",
851
+ "examples": [
852
+ "name"
853
+ ],
752
854
  "title": "Order By"
753
- }
855
+ },
856
+ "description": "The field whose value should be used to order the results"
754
857
  },
755
858
  {
756
859
  "name": "order_by_direction",
@@ -765,8 +868,10 @@
765
868
  "type": "null"
766
869
  }
767
870
  ],
871
+ "description": "The direction in which to order the results",
768
872
  "title": "Order By Direction"
769
- }
873
+ },
874
+ "description": "The direction in which to order the results"
770
875
  },
771
876
  {
772
877
  "name": "fields",
@@ -784,9 +889,11 @@
784
889
  "type": "null"
785
890
  }
786
891
  ],
892
+ "description": "The fields to include in the response",
787
893
  "default": [],
788
894
  "title": "Fields"
789
- }
895
+ },
896
+ "description": "The fields to include in the response"
790
897
  },
791
898
  {
792
899
  "name": "start_datetime",
@@ -801,8 +908,13 @@
801
908
  "type": "null"
802
909
  }
803
910
  ],
911
+ "description": "The start datetime for filtering results",
912
+ "examples": [
913
+ "2023-01-01T00:00:00Z"
914
+ ],
804
915
  "title": "Start Datetime"
805
- }
916
+ },
917
+ "description": "The start datetime for filtering results"
806
918
  },
807
919
  {
808
920
  "name": "end_datetime",
@@ -817,8 +929,13 @@
817
929
  "type": "null"
818
930
  }
819
931
  ],
932
+ "description": "The end datetime for filtering results",
933
+ "examples": [
934
+ "2024-01-01T00:00:00Z"
935
+ ],
820
936
  "title": "End Datetime"
821
- }
937
+ },
938
+ "description": "The end datetime for filtering results"
822
939
  }
823
940
  ],
824
941
  "responses": {
@@ -874,9 +991,14 @@
874
991
  "type": "null"
875
992
  }
876
993
  ],
994
+ "description": "The page number from which to start (0-indexed)",
995
+ "examples": [
996
+ 0
997
+ ],
877
998
  "default": 0,
878
999
  "title": "Page"
879
- }
1000
+ },
1001
+ "description": "The page number from which to start (0-indexed)"
880
1002
  },
881
1003
  {
882
1004
  "name": "limit",
@@ -885,9 +1007,14 @@
885
1007
  "schema": {
886
1008
  "type": "integer",
887
1009
  "minimum": 0,
1010
+ "description": "The maximum number of items to return",
1011
+ "examples": [
1012
+ 25
1013
+ ],
888
1014
  "default": 25,
889
1015
  "title": "Limit"
890
- }
1016
+ },
1017
+ "description": "The maximum number of items to return"
891
1018
  },
892
1019
  {
893
1020
  "name": "search_fields",
@@ -898,9 +1025,14 @@
898
1025
  "items": {
899
1026
  "$ref": "#/components/schemas/DataSourceProperties"
900
1027
  },
1028
+ "description": "String names of fields to search. Correspond by index to search field values",
1029
+ "examples": [
1030
+ "name"
1031
+ ],
901
1032
  "default": [],
902
1033
  "title": "Search Fields"
903
- }
1034
+ },
1035
+ "description": "String names of fields to search. Correspond by index to search field values"
904
1036
  },
905
1037
  {
906
1038
  "name": "search_field_values",
@@ -911,9 +1043,14 @@
911
1043
  "items": {
912
1044
  "type": "string"
913
1045
  },
1046
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
1047
+ "examples": [
1048
+ "Some Object Name"
1049
+ ],
914
1050
  "default": [],
915
1051
  "title": "Search Field Values"
916
- }
1052
+ },
1053
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
917
1054
  },
918
1055
  {
919
1056
  "name": "order_by",
@@ -928,8 +1065,13 @@
928
1065
  "type": "null"
929
1066
  }
930
1067
  ],
1068
+ "description": "The field whose value should be used to order the results",
1069
+ "examples": [
1070
+ "name"
1071
+ ],
931
1072
  "title": "Order By"
932
- }
1073
+ },
1074
+ "description": "The field whose value should be used to order the results"
933
1075
  },
934
1076
  {
935
1077
  "name": "order_by_direction",
@@ -944,8 +1086,10 @@
944
1086
  "type": "null"
945
1087
  }
946
1088
  ],
1089
+ "description": "The direction in which to order the results",
947
1090
  "title": "Order By Direction"
948
- }
1091
+ },
1092
+ "description": "The direction in which to order the results"
949
1093
  },
950
1094
  {
951
1095
  "name": "fields",
@@ -963,9 +1107,11 @@
963
1107
  "type": "null"
964
1108
  }
965
1109
  ],
1110
+ "description": "The fields to include in the response",
966
1111
  "default": [],
967
1112
  "title": "Fields"
968
- }
1113
+ },
1114
+ "description": "The fields to include in the response"
969
1115
  },
970
1116
  {
971
1117
  "name": "start_datetime",
@@ -980,8 +1126,13 @@
980
1126
  "type": "null"
981
1127
  }
982
1128
  ],
1129
+ "description": "The start datetime for filtering results",
1130
+ "examples": [
1131
+ "2023-01-01T00:00:00Z"
1132
+ ],
983
1133
  "title": "Start Datetime"
984
- }
1134
+ },
1135
+ "description": "The start datetime for filtering results"
985
1136
  },
986
1137
  {
987
1138
  "name": "end_datetime",
@@ -996,8 +1147,13 @@
996
1147
  "type": "null"
997
1148
  }
998
1149
  ],
1150
+ "description": "The end datetime for filtering results",
1151
+ "examples": [
1152
+ "2024-01-01T00:00:00Z"
1153
+ ],
999
1154
  "title": "End Datetime"
1000
- }
1155
+ },
1156
+ "description": "The end datetime for filtering results"
1001
1157
  }
1002
1158
  ],
1003
1159
  "responses": {
@@ -1247,9 +1403,14 @@
1247
1403
  "type": "null"
1248
1404
  }
1249
1405
  ],
1406
+ "description": "The page number from which to start (0-indexed)",
1407
+ "examples": [
1408
+ 0
1409
+ ],
1250
1410
  "default": 0,
1251
1411
  "title": "Page"
1252
- }
1412
+ },
1413
+ "description": "The page number from which to start (0-indexed)"
1253
1414
  },
1254
1415
  {
1255
1416
  "name": "limit",
@@ -1258,9 +1419,14 @@
1258
1419
  "schema": {
1259
1420
  "type": "integer",
1260
1421
  "minimum": 0,
1422
+ "description": "The maximum number of items to return",
1423
+ "examples": [
1424
+ 25
1425
+ ],
1261
1426
  "default": 25,
1262
1427
  "title": "Limit"
1263
- }
1428
+ },
1429
+ "description": "The maximum number of items to return"
1264
1430
  },
1265
1431
  {
1266
1432
  "name": "search_fields",
@@ -1271,9 +1437,14 @@
1271
1437
  "items": {
1272
1438
  "$ref": "#/components/schemas/EventProperties"
1273
1439
  },
1440
+ "description": "String names of fields to search. Correspond by index to search field values",
1441
+ "examples": [
1442
+ "name"
1443
+ ],
1274
1444
  "default": [],
1275
1445
  "title": "Search Fields"
1276
- }
1446
+ },
1447
+ "description": "String names of fields to search. Correspond by index to search field values"
1277
1448
  },
1278
1449
  {
1279
1450
  "name": "search_field_values",
@@ -1284,9 +1455,14 @@
1284
1455
  "items": {
1285
1456
  "type": "string"
1286
1457
  },
1458
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
1459
+ "examples": [
1460
+ "Some Object Name"
1461
+ ],
1287
1462
  "default": [],
1288
1463
  "title": "Search Field Values"
1289
- }
1464
+ },
1465
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
1290
1466
  },
1291
1467
  {
1292
1468
  "name": "order_by",
@@ -1301,8 +1477,13 @@
1301
1477
  "type": "null"
1302
1478
  }
1303
1479
  ],
1480
+ "description": "The field whose value should be used to order the results",
1481
+ "examples": [
1482
+ "name"
1483
+ ],
1304
1484
  "title": "Order By"
1305
- }
1485
+ },
1486
+ "description": "The field whose value should be used to order the results"
1306
1487
  },
1307
1488
  {
1308
1489
  "name": "order_by_direction",
@@ -1317,8 +1498,10 @@
1317
1498
  "type": "null"
1318
1499
  }
1319
1500
  ],
1501
+ "description": "The direction in which to order the results",
1320
1502
  "title": "Order By Direction"
1321
- }
1503
+ },
1504
+ "description": "The direction in which to order the results"
1322
1505
  },
1323
1506
  {
1324
1507
  "name": "fields",
@@ -1336,9 +1519,11 @@
1336
1519
  "type": "null"
1337
1520
  }
1338
1521
  ],
1522
+ "description": "The fields to include in the response",
1339
1523
  "default": [],
1340
1524
  "title": "Fields"
1341
- }
1525
+ },
1526
+ "description": "The fields to include in the response"
1342
1527
  },
1343
1528
  {
1344
1529
  "name": "start_datetime",
@@ -1353,8 +1538,13 @@
1353
1538
  "type": "null"
1354
1539
  }
1355
1540
  ],
1541
+ "description": "The start datetime for filtering results",
1542
+ "examples": [
1543
+ "2023-01-01T00:00:00Z"
1544
+ ],
1356
1545
  "title": "Start Datetime"
1357
- }
1546
+ },
1547
+ "description": "The start datetime for filtering results"
1358
1548
  },
1359
1549
  {
1360
1550
  "name": "end_datetime",
@@ -1369,8 +1559,13 @@
1369
1559
  "type": "null"
1370
1560
  }
1371
1561
  ],
1562
+ "description": "The end datetime for filtering results",
1563
+ "examples": [
1564
+ "2024-01-01T00:00:00Z"
1565
+ ],
1372
1566
  "title": "End Datetime"
1373
- }
1567
+ },
1568
+ "description": "The end datetime for filtering results"
1374
1569
  }
1375
1570
  ],
1376
1571
  "responses": {
@@ -1426,9 +1621,14 @@
1426
1621
  "type": "null"
1427
1622
  }
1428
1623
  ],
1624
+ "description": "The page number from which to start (0-indexed)",
1625
+ "examples": [
1626
+ 0
1627
+ ],
1429
1628
  "default": 0,
1430
1629
  "title": "Page"
1431
- }
1630
+ },
1631
+ "description": "The page number from which to start (0-indexed)"
1432
1632
  },
1433
1633
  {
1434
1634
  "name": "limit",
@@ -1437,9 +1637,14 @@
1437
1637
  "schema": {
1438
1638
  "type": "integer",
1439
1639
  "minimum": 0,
1640
+ "description": "The maximum number of items to return",
1641
+ "examples": [
1642
+ 25
1643
+ ],
1440
1644
  "default": 25,
1441
1645
  "title": "Limit"
1442
- }
1646
+ },
1647
+ "description": "The maximum number of items to return"
1443
1648
  },
1444
1649
  {
1445
1650
  "name": "search_fields",
@@ -1450,9 +1655,14 @@
1450
1655
  "items": {
1451
1656
  "$ref": "#/components/schemas/InsightWorkflowProperties"
1452
1657
  },
1658
+ "description": "String names of fields to search. Correspond by index to search field values",
1659
+ "examples": [
1660
+ "name"
1661
+ ],
1453
1662
  "default": [],
1454
1663
  "title": "Search Fields"
1455
- }
1664
+ },
1665
+ "description": "String names of fields to search. Correspond by index to search field values"
1456
1666
  },
1457
1667
  {
1458
1668
  "name": "search_field_values",
@@ -1463,9 +1673,14 @@
1463
1673
  "items": {
1464
1674
  "type": "string"
1465
1675
  },
1676
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
1677
+ "examples": [
1678
+ "Some Object Name"
1679
+ ],
1466
1680
  "default": [],
1467
1681
  "title": "Search Field Values"
1468
- }
1682
+ },
1683
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
1469
1684
  },
1470
1685
  {
1471
1686
  "name": "order_by",
@@ -1480,8 +1695,13 @@
1480
1695
  "type": "null"
1481
1696
  }
1482
1697
  ],
1698
+ "description": "The field whose value should be used to order the results",
1699
+ "examples": [
1700
+ "name"
1701
+ ],
1483
1702
  "title": "Order By"
1484
- }
1703
+ },
1704
+ "description": "The field whose value should be used to order the results"
1485
1705
  },
1486
1706
  {
1487
1707
  "name": "order_by_direction",
@@ -1496,8 +1716,10 @@
1496
1716
  "type": "null"
1497
1717
  }
1498
1718
  ],
1719
+ "description": "The direction in which to order the results",
1499
1720
  "title": "Order By Direction"
1500
- }
1721
+ },
1722
+ "description": "The direction in which to order the results"
1501
1723
  },
1502
1724
  {
1503
1725
  "name": "fields",
@@ -1515,9 +1737,11 @@
1515
1737
  "type": "null"
1516
1738
  }
1517
1739
  ],
1740
+ "description": "The fields to include in the response",
1518
1741
  "default": [],
1519
1742
  "title": "Fields"
1520
- }
1743
+ },
1744
+ "description": "The fields to include in the response"
1521
1745
  },
1522
1746
  {
1523
1747
  "name": "start_datetime",
@@ -1532,8 +1756,13 @@
1532
1756
  "type": "null"
1533
1757
  }
1534
1758
  ],
1759
+ "description": "The start datetime for filtering results",
1760
+ "examples": [
1761
+ "2023-01-01T00:00:00Z"
1762
+ ],
1535
1763
  "title": "Start Datetime"
1536
- }
1764
+ },
1765
+ "description": "The start datetime for filtering results"
1537
1766
  },
1538
1767
  {
1539
1768
  "name": "end_datetime",
@@ -1548,8 +1777,13 @@
1548
1777
  "type": "null"
1549
1778
  }
1550
1779
  ],
1780
+ "description": "The end datetime for filtering results",
1781
+ "examples": [
1782
+ "2024-01-01T00:00:00Z"
1783
+ ],
1551
1784
  "title": "End Datetime"
1552
- }
1785
+ },
1786
+ "description": "The end datetime for filtering results"
1553
1787
  }
1554
1788
  ],
1555
1789
  "responses": {
@@ -1823,9 +2057,14 @@
1823
2057
  "type": "null"
1824
2058
  }
1825
2059
  ],
2060
+ "description": "The page number from which to start (0-indexed)",
2061
+ "examples": [
2062
+ 0
2063
+ ],
1826
2064
  "default": 0,
1827
2065
  "title": "Page"
1828
- }
2066
+ },
2067
+ "description": "The page number from which to start (0-indexed)"
1829
2068
  },
1830
2069
  {
1831
2070
  "name": "limit",
@@ -1834,9 +2073,14 @@
1834
2073
  "schema": {
1835
2074
  "type": "integer",
1836
2075
  "minimum": 0,
2076
+ "description": "The maximum number of items to return",
2077
+ "examples": [
2078
+ 25
2079
+ ],
1837
2080
  "default": 25,
1838
2081
  "title": "Limit"
1839
- }
2082
+ },
2083
+ "description": "The maximum number of items to return"
1840
2084
  },
1841
2085
  {
1842
2086
  "name": "search_fields",
@@ -1847,9 +2091,14 @@
1847
2091
  "items": {
1848
2092
  "$ref": "#/components/schemas/InsightToolProperties"
1849
2093
  },
2094
+ "description": "String names of fields to search. Correspond by index to search field values",
2095
+ "examples": [
2096
+ "name"
2097
+ ],
1850
2098
  "default": [],
1851
2099
  "title": "Search Fields"
1852
- }
2100
+ },
2101
+ "description": "String names of fields to search. Correspond by index to search field values"
1853
2102
  },
1854
2103
  {
1855
2104
  "name": "search_field_values",
@@ -1860,9 +2109,14 @@
1860
2109
  "items": {
1861
2110
  "type": "string"
1862
2111
  },
2112
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
2113
+ "examples": [
2114
+ "Some Object Name"
2115
+ ],
1863
2116
  "default": [],
1864
2117
  "title": "Search Field Values"
1865
- }
2118
+ },
2119
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
1866
2120
  },
1867
2121
  {
1868
2122
  "name": "order_by",
@@ -1877,8 +2131,13 @@
1877
2131
  "type": "null"
1878
2132
  }
1879
2133
  ],
2134
+ "description": "The field whose value should be used to order the results",
2135
+ "examples": [
2136
+ "name"
2137
+ ],
1880
2138
  "title": "Order By"
1881
- }
2139
+ },
2140
+ "description": "The field whose value should be used to order the results"
1882
2141
  },
1883
2142
  {
1884
2143
  "name": "order_by_direction",
@@ -1893,8 +2152,10 @@
1893
2152
  "type": "null"
1894
2153
  }
1895
2154
  ],
2155
+ "description": "The direction in which to order the results",
1896
2156
  "title": "Order By Direction"
1897
- }
2157
+ },
2158
+ "description": "The direction in which to order the results"
1898
2159
  },
1899
2160
  {
1900
2161
  "name": "fields",
@@ -1912,9 +2173,11 @@
1912
2173
  "type": "null"
1913
2174
  }
1914
2175
  ],
2176
+ "description": "The fields to include in the response",
1915
2177
  "default": [],
1916
2178
  "title": "Fields"
1917
- }
2179
+ },
2180
+ "description": "The fields to include in the response"
1918
2181
  },
1919
2182
  {
1920
2183
  "name": "start_datetime",
@@ -1929,8 +2192,13 @@
1929
2192
  "type": "null"
1930
2193
  }
1931
2194
  ],
2195
+ "description": "The start datetime for filtering results",
2196
+ "examples": [
2197
+ "2023-01-01T00:00:00Z"
2198
+ ],
1932
2199
  "title": "Start Datetime"
1933
- }
2200
+ },
2201
+ "description": "The start datetime for filtering results"
1934
2202
  },
1935
2203
  {
1936
2204
  "name": "end_datetime",
@@ -1945,8 +2213,13 @@
1945
2213
  "type": "null"
1946
2214
  }
1947
2215
  ],
2216
+ "description": "The end datetime for filtering results",
2217
+ "examples": [
2218
+ "2024-01-01T00:00:00Z"
2219
+ ],
1948
2220
  "title": "End Datetime"
1949
- }
2221
+ },
2222
+ "description": "The end datetime for filtering results"
1950
2223
  }
1951
2224
  ],
1952
2225
  "responses": {
@@ -2198,9 +2471,14 @@
2198
2471
  "type": "null"
2199
2472
  }
2200
2473
  ],
2474
+ "description": "The page number from which to start (0-indexed)",
2475
+ "examples": [
2476
+ 0
2477
+ ],
2201
2478
  "default": 0,
2202
2479
  "title": "Page"
2203
- }
2480
+ },
2481
+ "description": "The page number from which to start (0-indexed)"
2204
2482
  },
2205
2483
  {
2206
2484
  "name": "limit",
@@ -2209,9 +2487,14 @@
2209
2487
  "schema": {
2210
2488
  "type": "integer",
2211
2489
  "minimum": 0,
2490
+ "description": "The maximum number of items to return",
2491
+ "examples": [
2492
+ 25
2493
+ ],
2212
2494
  "default": 25,
2213
2495
  "title": "Limit"
2214
- }
2496
+ },
2497
+ "description": "The maximum number of items to return"
2215
2498
  },
2216
2499
  {
2217
2500
  "name": "search_fields",
@@ -2222,9 +2505,14 @@
2222
2505
  "items": {
2223
2506
  "$ref": "#/components/schemas/CustomMessageProperties"
2224
2507
  },
2508
+ "description": "String names of fields to search. Correspond by index to search field values",
2509
+ "examples": [
2510
+ "name"
2511
+ ],
2225
2512
  "default": [],
2226
2513
  "title": "Search Fields"
2227
- }
2514
+ },
2515
+ "description": "String names of fields to search. Correspond by index to search field values"
2228
2516
  },
2229
2517
  {
2230
2518
  "name": "search_field_values",
@@ -2235,9 +2523,14 @@
2235
2523
  "items": {
2236
2524
  "type": "string"
2237
2525
  },
2526
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
2527
+ "examples": [
2528
+ "Some Object Name"
2529
+ ],
2238
2530
  "default": [],
2239
2531
  "title": "Search Field Values"
2240
- }
2532
+ },
2533
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
2241
2534
  },
2242
2535
  {
2243
2536
  "name": "order_by",
@@ -2252,8 +2545,13 @@
2252
2545
  "type": "null"
2253
2546
  }
2254
2547
  ],
2548
+ "description": "The field whose value should be used to order the results",
2549
+ "examples": [
2550
+ "name"
2551
+ ],
2255
2552
  "title": "Order By"
2256
- }
2553
+ },
2554
+ "description": "The field whose value should be used to order the results"
2257
2555
  },
2258
2556
  {
2259
2557
  "name": "order_by_direction",
@@ -2268,8 +2566,10 @@
2268
2566
  "type": "null"
2269
2567
  }
2270
2568
  ],
2569
+ "description": "The direction in which to order the results",
2271
2570
  "title": "Order By Direction"
2272
- }
2571
+ },
2572
+ "description": "The direction in which to order the results"
2273
2573
  },
2274
2574
  {
2275
2575
  "name": "fields",
@@ -2287,9 +2587,11 @@
2287
2587
  "type": "null"
2288
2588
  }
2289
2589
  ],
2590
+ "description": "The fields to include in the response",
2290
2591
  "default": [],
2291
2592
  "title": "Fields"
2292
- }
2593
+ },
2594
+ "description": "The fields to include in the response"
2293
2595
  },
2294
2596
  {
2295
2597
  "name": "start_datetime",
@@ -2304,8 +2606,13 @@
2304
2606
  "type": "null"
2305
2607
  }
2306
2608
  ],
2609
+ "description": "The start datetime for filtering results",
2610
+ "examples": [
2611
+ "2023-01-01T00:00:00Z"
2612
+ ],
2307
2613
  "title": "Start Datetime"
2308
- }
2614
+ },
2615
+ "description": "The start datetime for filtering results"
2309
2616
  },
2310
2617
  {
2311
2618
  "name": "end_datetime",
@@ -2320,8 +2627,13 @@
2320
2627
  "type": "null"
2321
2628
  }
2322
2629
  ],
2630
+ "description": "The end datetime for filtering results",
2631
+ "examples": [
2632
+ "2024-01-01T00:00:00Z"
2633
+ ],
2323
2634
  "title": "End Datetime"
2324
- }
2635
+ },
2636
+ "description": "The end datetime for filtering results"
2325
2637
  }
2326
2638
  ],
2327
2639
  "responses": {
@@ -2572,9 +2884,14 @@
2572
2884
  "type": "null"
2573
2885
  }
2574
2886
  ],
2887
+ "description": "The page number from which to start (0-indexed)",
2888
+ "examples": [
2889
+ 0
2890
+ ],
2575
2891
  "default": 0,
2576
2892
  "title": "Page"
2577
- }
2893
+ },
2894
+ "description": "The page number from which to start (0-indexed)"
2578
2895
  },
2579
2896
  {
2580
2897
  "name": "limit",
@@ -2583,9 +2900,14 @@
2583
2900
  "schema": {
2584
2901
  "type": "integer",
2585
2902
  "minimum": 0,
2903
+ "description": "The maximum number of items to return",
2904
+ "examples": [
2905
+ 25
2906
+ ],
2586
2907
  "default": 25,
2587
2908
  "title": "Limit"
2588
- }
2909
+ },
2910
+ "description": "The maximum number of items to return"
2589
2911
  },
2590
2912
  {
2591
2913
  "name": "search_fields",
@@ -2596,9 +2918,14 @@
2596
2918
  "items": {
2597
2919
  "$ref": "#/components/schemas/PromptProperties"
2598
2920
  },
2921
+ "description": "String names of fields to search. Correspond by index to search field values",
2922
+ "examples": [
2923
+ "name"
2924
+ ],
2599
2925
  "default": [],
2600
2926
  "title": "Search Fields"
2601
- }
2927
+ },
2928
+ "description": "String names of fields to search. Correspond by index to search field values"
2602
2929
  },
2603
2930
  {
2604
2931
  "name": "search_field_values",
@@ -2609,9 +2936,14 @@
2609
2936
  "items": {
2610
2937
  "type": "string"
2611
2938
  },
2939
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
2940
+ "examples": [
2941
+ "Some Object Name"
2942
+ ],
2612
2943
  "default": [],
2613
2944
  "title": "Search Field Values"
2614
- }
2945
+ },
2946
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
2615
2947
  },
2616
2948
  {
2617
2949
  "name": "order_by",
@@ -2626,8 +2958,13 @@
2626
2958
  "type": "null"
2627
2959
  }
2628
2960
  ],
2961
+ "description": "The field whose value should be used to order the results",
2962
+ "examples": [
2963
+ "name"
2964
+ ],
2629
2965
  "title": "Order By"
2630
- }
2966
+ },
2967
+ "description": "The field whose value should be used to order the results"
2631
2968
  },
2632
2969
  {
2633
2970
  "name": "order_by_direction",
@@ -2642,8 +2979,10 @@
2642
2979
  "type": "null"
2643
2980
  }
2644
2981
  ],
2982
+ "description": "The direction in which to order the results",
2645
2983
  "title": "Order By Direction"
2646
- }
2984
+ },
2985
+ "description": "The direction in which to order the results"
2647
2986
  },
2648
2987
  {
2649
2988
  "name": "fields",
@@ -2661,9 +3000,11 @@
2661
3000
  "type": "null"
2662
3001
  }
2663
3002
  ],
3003
+ "description": "The fields to include in the response",
2664
3004
  "default": [],
2665
3005
  "title": "Fields"
2666
- }
3006
+ },
3007
+ "description": "The fields to include in the response"
2667
3008
  },
2668
3009
  {
2669
3010
  "name": "start_datetime",
@@ -2678,8 +3019,13 @@
2678
3019
  "type": "null"
2679
3020
  }
2680
3021
  ],
3022
+ "description": "The start datetime for filtering results",
3023
+ "examples": [
3024
+ "2023-01-01T00:00:00Z"
3025
+ ],
2681
3026
  "title": "Start Datetime"
2682
- }
3027
+ },
3028
+ "description": "The start datetime for filtering results"
2683
3029
  },
2684
3030
  {
2685
3031
  "name": "end_datetime",
@@ -2694,8 +3040,13 @@
2694
3040
  "type": "null"
2695
3041
  }
2696
3042
  ],
3043
+ "description": "The end datetime for filtering results",
3044
+ "examples": [
3045
+ "2024-01-01T00:00:00Z"
3046
+ ],
2697
3047
  "title": "End Datetime"
2698
- }
3048
+ },
3049
+ "description": "The end datetime for filtering results"
2699
3050
  }
2700
3051
  ],
2701
3052
  "responses": {
@@ -2999,9 +3350,14 @@
2999
3350
  "type": "null"
3000
3351
  }
3001
3352
  ],
3353
+ "description": "The page number from which to start (0-indexed)",
3354
+ "examples": [
3355
+ 0
3356
+ ],
3002
3357
  "default": 0,
3003
3358
  "title": "Page"
3004
- }
3359
+ },
3360
+ "description": "The page number from which to start (0-indexed)"
3005
3361
  },
3006
3362
  {
3007
3363
  "name": "limit",
@@ -3010,9 +3366,14 @@
3010
3366
  "schema": {
3011
3367
  "type": "integer",
3012
3368
  "minimum": 0,
3369
+ "description": "The maximum number of items to return",
3370
+ "examples": [
3371
+ 25
3372
+ ],
3013
3373
  "default": 25,
3014
3374
  "title": "Limit"
3015
- }
3375
+ },
3376
+ "description": "The maximum number of items to return"
3016
3377
  },
3017
3378
  {
3018
3379
  "name": "search_fields",
@@ -3023,9 +3384,14 @@
3023
3384
  "items": {
3024
3385
  "$ref": "#/components/schemas/ServiceProperties"
3025
3386
  },
3387
+ "description": "String names of fields to search. Correspond by index to search field values",
3388
+ "examples": [
3389
+ "name"
3390
+ ],
3026
3391
  "default": [],
3027
3392
  "title": "Search Fields"
3028
- }
3393
+ },
3394
+ "description": "String names of fields to search. Correspond by index to search field values"
3029
3395
  },
3030
3396
  {
3031
3397
  "name": "search_field_values",
@@ -3036,9 +3402,14 @@
3036
3402
  "items": {
3037
3403
  "type": "string"
3038
3404
  },
3405
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
3406
+ "examples": [
3407
+ "Some Object Name"
3408
+ ],
3039
3409
  "default": [],
3040
3410
  "title": "Search Field Values"
3041
- }
3411
+ },
3412
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
3042
3413
  },
3043
3414
  {
3044
3415
  "name": "order_by",
@@ -3053,8 +3424,13 @@
3053
3424
  "type": "null"
3054
3425
  }
3055
3426
  ],
3427
+ "description": "The field whose value should be used to order the results",
3428
+ "examples": [
3429
+ "name"
3430
+ ],
3056
3431
  "title": "Order By"
3057
- }
3432
+ },
3433
+ "description": "The field whose value should be used to order the results"
3058
3434
  },
3059
3435
  {
3060
3436
  "name": "order_by_direction",
@@ -3069,8 +3445,10 @@
3069
3445
  "type": "null"
3070
3446
  }
3071
3447
  ],
3448
+ "description": "The direction in which to order the results",
3072
3449
  "title": "Order By Direction"
3073
- }
3450
+ },
3451
+ "description": "The direction in which to order the results"
3074
3452
  },
3075
3453
  {
3076
3454
  "name": "fields",
@@ -3088,9 +3466,11 @@
3088
3466
  "type": "null"
3089
3467
  }
3090
3468
  ],
3469
+ "description": "The fields to include in the response",
3091
3470
  "default": [],
3092
3471
  "title": "Fields"
3093
- }
3472
+ },
3473
+ "description": "The fields to include in the response"
3094
3474
  },
3095
3475
  {
3096
3476
  "name": "start_datetime",
@@ -3105,8 +3485,13 @@
3105
3485
  "type": "null"
3106
3486
  }
3107
3487
  ],
3488
+ "description": "The start datetime for filtering results",
3489
+ "examples": [
3490
+ "2023-01-01T00:00:00Z"
3491
+ ],
3108
3492
  "title": "Start Datetime"
3109
- }
3493
+ },
3494
+ "description": "The start datetime for filtering results"
3110
3495
  },
3111
3496
  {
3112
3497
  "name": "end_datetime",
@@ -3121,8 +3506,13 @@
3121
3506
  "type": "null"
3122
3507
  }
3123
3508
  ],
3509
+ "description": "The end datetime for filtering results",
3510
+ "examples": [
3511
+ "2024-01-01T00:00:00Z"
3512
+ ],
3124
3513
  "title": "End Datetime"
3125
- }
3514
+ },
3515
+ "description": "The end datetime for filtering results"
3126
3516
  }
3127
3517
  ],
3128
3518
  "responses": {
@@ -3466,9 +3856,14 @@
3466
3856
  "type": "null"
3467
3857
  }
3468
3858
  ],
3859
+ "description": "The page number from which to start (0-indexed)",
3860
+ "examples": [
3861
+ 0
3862
+ ],
3469
3863
  "default": 0,
3470
3864
  "title": "Page"
3471
- }
3865
+ },
3866
+ "description": "The page number from which to start (0-indexed)"
3472
3867
  },
3473
3868
  {
3474
3869
  "name": "limit",
@@ -3477,9 +3872,14 @@
3477
3872
  "schema": {
3478
3873
  "type": "integer",
3479
3874
  "minimum": 0,
3875
+ "description": "The maximum number of items to return",
3876
+ "examples": [
3877
+ 25
3878
+ ],
3480
3879
  "default": 25,
3481
3880
  "title": "Limit"
3482
- }
3881
+ },
3882
+ "description": "The maximum number of items to return"
3483
3883
  },
3484
3884
  {
3485
3885
  "name": "search_fields",
@@ -3490,9 +3890,14 @@
3490
3890
  "items": {
3491
3891
  "$ref": "#/components/schemas/SessionLabelProperties"
3492
3892
  },
3893
+ "description": "String names of fields to search. Correspond by index to search field values",
3894
+ "examples": [
3895
+ "name"
3896
+ ],
3493
3897
  "default": [],
3494
3898
  "title": "Search Fields"
3495
- }
3899
+ },
3900
+ "description": "String names of fields to search. Correspond by index to search field values"
3496
3901
  },
3497
3902
  {
3498
3903
  "name": "search_field_values",
@@ -3503,9 +3908,14 @@
3503
3908
  "items": {
3504
3909
  "type": "string"
3505
3910
  },
3911
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
3912
+ "examples": [
3913
+ "Some Object Name"
3914
+ ],
3506
3915
  "default": [],
3507
3916
  "title": "Search Field Values"
3508
- }
3917
+ },
3918
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
3509
3919
  },
3510
3920
  {
3511
3921
  "name": "order_by",
@@ -3520,8 +3930,13 @@
3520
3930
  "type": "null"
3521
3931
  }
3522
3932
  ],
3933
+ "description": "The field whose value should be used to order the results",
3934
+ "examples": [
3935
+ "name"
3936
+ ],
3523
3937
  "title": "Order By"
3524
- }
3938
+ },
3939
+ "description": "The field whose value should be used to order the results"
3525
3940
  },
3526
3941
  {
3527
3942
  "name": "order_by_direction",
@@ -3536,8 +3951,10 @@
3536
3951
  "type": "null"
3537
3952
  }
3538
3953
  ],
3954
+ "description": "The direction in which to order the results",
3539
3955
  "title": "Order By Direction"
3540
- }
3956
+ },
3957
+ "description": "The direction in which to order the results"
3541
3958
  },
3542
3959
  {
3543
3960
  "name": "fields",
@@ -3555,9 +3972,11 @@
3555
3972
  "type": "null"
3556
3973
  }
3557
3974
  ],
3975
+ "description": "The fields to include in the response",
3558
3976
  "default": [],
3559
3977
  "title": "Fields"
3560
- }
3978
+ },
3979
+ "description": "The fields to include in the response"
3561
3980
  },
3562
3981
  {
3563
3982
  "name": "start_datetime",
@@ -3572,8 +3991,13 @@
3572
3991
  "type": "null"
3573
3992
  }
3574
3993
  ],
3994
+ "description": "The start datetime for filtering results",
3995
+ "examples": [
3996
+ "2023-01-01T00:00:00Z"
3997
+ ],
3575
3998
  "title": "Start Datetime"
3576
- }
3999
+ },
4000
+ "description": "The start datetime for filtering results"
3577
4001
  },
3578
4002
  {
3579
4003
  "name": "end_datetime",
@@ -3588,8 +4012,13 @@
3588
4012
  "type": "null"
3589
4013
  }
3590
4014
  ],
4015
+ "description": "The end datetime for filtering results",
4016
+ "examples": [
4017
+ "2024-01-01T00:00:00Z"
4018
+ ],
3591
4019
  "title": "End Datetime"
3592
- }
4020
+ },
4021
+ "description": "The end datetime for filtering results"
3593
4022
  }
3594
4023
  ],
3595
4024
  "responses": {
@@ -3644,9 +4073,14 @@
3644
4073
  "type": "null"
3645
4074
  }
3646
4075
  ],
4076
+ "description": "The page number from which to start (0-indexed)",
4077
+ "examples": [
4078
+ 0
4079
+ ],
3647
4080
  "default": 0,
3648
4081
  "title": "Page"
3649
- }
4082
+ },
4083
+ "description": "The page number from which to start (0-indexed)"
3650
4084
  },
3651
4085
  {
3652
4086
  "name": "limit",
@@ -3655,9 +4089,14 @@
3655
4089
  "schema": {
3656
4090
  "type": "integer",
3657
4091
  "minimum": 0,
4092
+ "description": "The maximum number of items to return",
4093
+ "examples": [
4094
+ 25
4095
+ ],
3658
4096
  "default": 25,
3659
4097
  "title": "Limit"
3660
- }
4098
+ },
4099
+ "description": "The maximum number of items to return"
3661
4100
  },
3662
4101
  {
3663
4102
  "name": "search_fields",
@@ -3668,9 +4107,14 @@
3668
4107
  "items": {
3669
4108
  "$ref": "#/components/schemas/SessionProperties"
3670
4109
  },
4110
+ "description": "String names of fields to search. Correspond by index to search field values",
4111
+ "examples": [
4112
+ "name"
4113
+ ],
3671
4114
  "default": [],
3672
4115
  "title": "Search Fields"
3673
- }
4116
+ },
4117
+ "description": "String names of fields to search. Correspond by index to search field values"
3674
4118
  },
3675
4119
  {
3676
4120
  "name": "search_field_values",
@@ -3681,9 +4125,14 @@
3681
4125
  "items": {
3682
4126
  "type": "string"
3683
4127
  },
4128
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
4129
+ "examples": [
4130
+ "Some Object Name"
4131
+ ],
3684
4132
  "default": [],
3685
4133
  "title": "Search Field Values"
3686
- }
4134
+ },
4135
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
3687
4136
  },
3688
4137
  {
3689
4138
  "name": "order_by",
@@ -3698,8 +4147,13 @@
3698
4147
  "type": "null"
3699
4148
  }
3700
4149
  ],
4150
+ "description": "The field whose value should be used to order the results",
4151
+ "examples": [
4152
+ "name"
4153
+ ],
3701
4154
  "title": "Order By"
3702
- }
4155
+ },
4156
+ "description": "The field whose value should be used to order the results"
3703
4157
  },
3704
4158
  {
3705
4159
  "name": "order_by_direction",
@@ -3714,8 +4168,10 @@
3714
4168
  "type": "null"
3715
4169
  }
3716
4170
  ],
4171
+ "description": "The direction in which to order the results",
3717
4172
  "title": "Order By Direction"
3718
- }
4173
+ },
4174
+ "description": "The direction in which to order the results"
3719
4175
  },
3720
4176
  {
3721
4177
  "name": "fields",
@@ -3733,9 +4189,11 @@
3733
4189
  "type": "null"
3734
4190
  }
3735
4191
  ],
4192
+ "description": "The fields to include in the response",
3736
4193
  "default": [],
3737
4194
  "title": "Fields"
3738
- }
4195
+ },
4196
+ "description": "The fields to include in the response"
3739
4197
  },
3740
4198
  {
3741
4199
  "name": "start_datetime",
@@ -3750,8 +4208,13 @@
3750
4208
  "type": "null"
3751
4209
  }
3752
4210
  ],
4211
+ "description": "The start datetime for filtering results",
4212
+ "examples": [
4213
+ "2023-01-01T00:00:00Z"
4214
+ ],
3753
4215
  "title": "Start Datetime"
3754
- }
4216
+ },
4217
+ "description": "The start datetime for filtering results"
3755
4218
  },
3756
4219
  {
3757
4220
  "name": "end_datetime",
@@ -3766,8 +4229,13 @@
3766
4229
  "type": "null"
3767
4230
  }
3768
4231
  ],
4232
+ "description": "The end datetime for filtering results",
4233
+ "examples": [
4234
+ "2024-01-01T00:00:00Z"
4235
+ ],
3769
4236
  "title": "End Datetime"
3770
- }
4237
+ },
4238
+ "description": "The end datetime for filtering results"
3771
4239
  }
3772
4240
  ],
3773
4241
  "responses": {
@@ -4083,6 +4551,168 @@
4083
4551
  }
4084
4552
  }
4085
4553
  },
4554
+ "/api/v1/session_debug/sid/{channel_manager_service}/{channel_manager_sid}": {
4555
+ "get": {
4556
+ "tags": [
4557
+ "session.debug",
4558
+ "V1"
4559
+ ],
4560
+ "summary": "Get Session Data By Sid",
4561
+ "operationId": "get_session_data_by_sid",
4562
+ "security": [
4563
+ {
4564
+ "APIKeyHeader": []
4565
+ }
4566
+ ],
4567
+ "parameters": [
4568
+ {
4569
+ "name": "channel_manager_service",
4570
+ "in": "path",
4571
+ "required": true,
4572
+ "schema": {
4573
+ "type": "string",
4574
+ "title": "Channel Manager Service"
4575
+ }
4576
+ },
4577
+ {
4578
+ "name": "channel_manager_sid",
4579
+ "in": "path",
4580
+ "required": true,
4581
+ "schema": {
4582
+ "type": "string",
4583
+ "title": "Channel Manager Sid"
4584
+ }
4585
+ }
4586
+ ],
4587
+ "responses": {
4588
+ "200": {
4589
+ "description": "Successful Response",
4590
+ "content": {
4591
+ "application/json": {
4592
+ "schema": {
4593
+ "$ref": "#/components/schemas/SessionData"
4594
+ }
4595
+ }
4596
+ }
4597
+ },
4598
+ "422": {
4599
+ "description": "Validation Error",
4600
+ "content": {
4601
+ "application/json": {
4602
+ "schema": {
4603
+ "$ref": "#/components/schemas/HTTPValidationError"
4604
+ }
4605
+ }
4606
+ }
4607
+ }
4608
+ }
4609
+ }
4610
+ },
4611
+ "/api/v1/session_debug/session_id/{session_id}": {
4612
+ "get": {
4613
+ "tags": [
4614
+ "session.debug",
4615
+ "V1"
4616
+ ],
4617
+ "summary": "Get Session Data By Session Id",
4618
+ "operationId": "get_session_data_by_session_id",
4619
+ "security": [
4620
+ {
4621
+ "APIKeyHeader": []
4622
+ }
4623
+ ],
4624
+ "parameters": [
4625
+ {
4626
+ "name": "session_id",
4627
+ "in": "path",
4628
+ "required": true,
4629
+ "schema": {
4630
+ "type": "integer",
4631
+ "title": "Session Id"
4632
+ }
4633
+ }
4634
+ ],
4635
+ "responses": {
4636
+ "200": {
4637
+ "description": "Successful Response",
4638
+ "content": {
4639
+ "application/json": {
4640
+ "schema": {
4641
+ "$ref": "#/components/schemas/SessionData"
4642
+ }
4643
+ }
4644
+ }
4645
+ },
4646
+ "422": {
4647
+ "description": "Validation Error",
4648
+ "content": {
4649
+ "application/json": {
4650
+ "schema": {
4651
+ "$ref": "#/components/schemas/HTTPValidationError"
4652
+ }
4653
+ }
4654
+ }
4655
+ }
4656
+ }
4657
+ }
4658
+ },
4659
+ "/api/v1/session_debug/tool_result/{session_id}/{tool_call_id}": {
4660
+ "get": {
4661
+ "tags": [
4662
+ "session.debug",
4663
+ "V1"
4664
+ ],
4665
+ "summary": "Get Session Tool Call Result By Id",
4666
+ "operationId": "get_session_tool_call_result_by_id",
4667
+ "security": [
4668
+ {
4669
+ "APIKeyHeader": []
4670
+ }
4671
+ ],
4672
+ "parameters": [
4673
+ {
4674
+ "name": "session_id",
4675
+ "in": "path",
4676
+ "required": true,
4677
+ "schema": {
4678
+ "type": "integer",
4679
+ "title": "Session Id"
4680
+ }
4681
+ },
4682
+ {
4683
+ "name": "tool_call_id",
4684
+ "in": "path",
4685
+ "required": true,
4686
+ "schema": {
4687
+ "type": "string",
4688
+ "title": "Tool Call Id"
4689
+ }
4690
+ }
4691
+ ],
4692
+ "responses": {
4693
+ "200": {
4694
+ "description": "Successful Response",
4695
+ "content": {
4696
+ "application/json": {
4697
+ "schema": {
4698
+ "$ref": "#/components/schemas/ToolResultData"
4699
+ }
4700
+ }
4701
+ }
4702
+ },
4703
+ "422": {
4704
+ "description": "Validation Error",
4705
+ "content": {
4706
+ "application/json": {
4707
+ "schema": {
4708
+ "$ref": "#/components/schemas/HTTPValidationError"
4709
+ }
4710
+ }
4711
+ }
4712
+ }
4713
+ }
4714
+ }
4715
+ },
4086
4716
  "/api/v1/tools/": {
4087
4717
  "get": {
4088
4718
  "tags": [
@@ -4112,9 +4742,14 @@
4112
4742
  "type": "null"
4113
4743
  }
4114
4744
  ],
4745
+ "description": "The page number from which to start (0-indexed)",
4746
+ "examples": [
4747
+ 0
4748
+ ],
4115
4749
  "default": 0,
4116
4750
  "title": "Page"
4117
- }
4751
+ },
4752
+ "description": "The page number from which to start (0-indexed)"
4118
4753
  },
4119
4754
  {
4120
4755
  "name": "limit",
@@ -4123,9 +4758,14 @@
4123
4758
  "schema": {
4124
4759
  "type": "integer",
4125
4760
  "minimum": 0,
4761
+ "description": "The maximum number of items to return",
4762
+ "examples": [
4763
+ 25
4764
+ ],
4126
4765
  "default": 25,
4127
4766
  "title": "Limit"
4128
- }
4767
+ },
4768
+ "description": "The maximum number of items to return"
4129
4769
  },
4130
4770
  {
4131
4771
  "name": "search_fields",
@@ -4136,9 +4776,14 @@
4136
4776
  "items": {
4137
4777
  "$ref": "#/components/schemas/ToolProperties"
4138
4778
  },
4779
+ "description": "String names of fields to search. Correspond by index to search field values",
4780
+ "examples": [
4781
+ "name"
4782
+ ],
4139
4783
  "default": [],
4140
4784
  "title": "Search Fields"
4141
- }
4785
+ },
4786
+ "description": "String names of fields to search. Correspond by index to search field values"
4142
4787
  },
4143
4788
  {
4144
4789
  "name": "search_field_values",
@@ -4149,9 +4794,14 @@
4149
4794
  "items": {
4150
4795
  "type": "string"
4151
4796
  },
4797
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
4798
+ "examples": [
4799
+ "Some Object Name"
4800
+ ],
4152
4801
  "default": [],
4153
4802
  "title": "Search Field Values"
4154
- }
4803
+ },
4804
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
4155
4805
  },
4156
4806
  {
4157
4807
  "name": "order_by",
@@ -4166,8 +4816,13 @@
4166
4816
  "type": "null"
4167
4817
  }
4168
4818
  ],
4819
+ "description": "The field whose value should be used to order the results",
4820
+ "examples": [
4821
+ "name"
4822
+ ],
4169
4823
  "title": "Order By"
4170
- }
4824
+ },
4825
+ "description": "The field whose value should be used to order the results"
4171
4826
  },
4172
4827
  {
4173
4828
  "name": "order_by_direction",
@@ -4182,8 +4837,10 @@
4182
4837
  "type": "null"
4183
4838
  }
4184
4839
  ],
4840
+ "description": "The direction in which to order the results",
4185
4841
  "title": "Order By Direction"
4186
- }
4842
+ },
4843
+ "description": "The direction in which to order the results"
4187
4844
  },
4188
4845
  {
4189
4846
  "name": "fields",
@@ -4201,9 +4858,11 @@
4201
4858
  "type": "null"
4202
4859
  }
4203
4860
  ],
4861
+ "description": "The fields to include in the response",
4204
4862
  "default": [],
4205
4863
  "title": "Fields"
4206
- }
4864
+ },
4865
+ "description": "The fields to include in the response"
4207
4866
  },
4208
4867
  {
4209
4868
  "name": "start_datetime",
@@ -4218,8 +4877,13 @@
4218
4877
  "type": "null"
4219
4878
  }
4220
4879
  ],
4880
+ "description": "The start datetime for filtering results",
4881
+ "examples": [
4882
+ "2023-01-01T00:00:00Z"
4883
+ ],
4221
4884
  "title": "Start Datetime"
4222
- }
4885
+ },
4886
+ "description": "The start datetime for filtering results"
4223
4887
  },
4224
4888
  {
4225
4889
  "name": "end_datetime",
@@ -4234,8 +4898,13 @@
4234
4898
  "type": "null"
4235
4899
  }
4236
4900
  ],
4901
+ "description": "The end datetime for filtering results",
4902
+ "examples": [
4903
+ "2024-01-01T00:00:00Z"
4904
+ ],
4237
4905
  "title": "End Datetime"
4238
- }
4906
+ },
4907
+ "description": "The end datetime for filtering results"
4239
4908
  }
4240
4909
  ],
4241
4910
  "responses": {
@@ -4488,9 +5157,14 @@
4488
5157
  "type": "null"
4489
5158
  }
4490
5159
  ],
5160
+ "description": "The page number from which to start (0-indexed)",
5161
+ "examples": [
5162
+ 0
5163
+ ],
4491
5164
  "default": 0,
4492
5165
  "title": "Page"
4493
- }
5166
+ },
5167
+ "description": "The page number from which to start (0-indexed)"
4494
5168
  },
4495
5169
  {
4496
5170
  "name": "limit",
@@ -4499,9 +5173,14 @@
4499
5173
  "schema": {
4500
5174
  "type": "integer",
4501
5175
  "minimum": 0,
5176
+ "description": "The maximum number of items to return",
5177
+ "examples": [
5178
+ 25
5179
+ ],
4502
5180
  "default": 25,
4503
5181
  "title": "Limit"
4504
- }
5182
+ },
5183
+ "description": "The maximum number of items to return"
4505
5184
  },
4506
5185
  {
4507
5186
  "name": "search_fields",
@@ -4512,9 +5191,14 @@
4512
5191
  "items": {
4513
5192
  "$ref": "#/components/schemas/AvailableTargetProperties"
4514
5193
  },
5194
+ "description": "String names of fields to search. Correspond by index to search field values",
5195
+ "examples": [
5196
+ "name"
5197
+ ],
4515
5198
  "default": [],
4516
5199
  "title": "Search Fields"
4517
- }
5200
+ },
5201
+ "description": "String names of fields to search. Correspond by index to search field values"
4518
5202
  },
4519
5203
  {
4520
5204
  "name": "search_field_values",
@@ -4525,9 +5209,14 @@
4525
5209
  "items": {
4526
5210
  "type": "string"
4527
5211
  },
5212
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
5213
+ "examples": [
5214
+ "Some Object Name"
5215
+ ],
4528
5216
  "default": [],
4529
5217
  "title": "Search Field Values"
4530
- }
5218
+ },
5219
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
4531
5220
  },
4532
5221
  {
4533
5222
  "name": "order_by",
@@ -4542,8 +5231,13 @@
4542
5231
  "type": "null"
4543
5232
  }
4544
5233
  ],
5234
+ "description": "The field whose value should be used to order the results",
5235
+ "examples": [
5236
+ "name"
5237
+ ],
4545
5238
  "title": "Order By"
4546
- }
5239
+ },
5240
+ "description": "The field whose value should be used to order the results"
4547
5241
  },
4548
5242
  {
4549
5243
  "name": "order_by_direction",
@@ -4558,8 +5252,10 @@
4558
5252
  "type": "null"
4559
5253
  }
4560
5254
  ],
5255
+ "description": "The direction in which to order the results",
4561
5256
  "title": "Order By Direction"
4562
- }
5257
+ },
5258
+ "description": "The direction in which to order the results"
4563
5259
  },
4564
5260
  {
4565
5261
  "name": "fields",
@@ -4577,9 +5273,11 @@
4577
5273
  "type": "null"
4578
5274
  }
4579
5275
  ],
5276
+ "description": "The fields to include in the response",
4580
5277
  "default": [],
4581
5278
  "title": "Fields"
4582
- }
5279
+ },
5280
+ "description": "The fields to include in the response"
4583
5281
  },
4584
5282
  {
4585
5283
  "name": "start_datetime",
@@ -4594,8 +5292,13 @@
4594
5292
  "type": "null"
4595
5293
  }
4596
5294
  ],
5295
+ "description": "The start datetime for filtering results",
5296
+ "examples": [
5297
+ "2023-01-01T00:00:00Z"
5298
+ ],
4597
5299
  "title": "Start Datetime"
4598
- }
5300
+ },
5301
+ "description": "The start datetime for filtering results"
4599
5302
  },
4600
5303
  {
4601
5304
  "name": "end_datetime",
@@ -4610,8 +5313,13 @@
4610
5313
  "type": "null"
4611
5314
  }
4612
5315
  ],
5316
+ "description": "The end datetime for filtering results",
5317
+ "examples": [
5318
+ "2024-01-01T00:00:00Z"
5319
+ ],
4613
5320
  "title": "End Datetime"
4614
- }
5321
+ },
5322
+ "description": "The end datetime for filtering results"
4615
5323
  }
4616
5324
  ],
4617
5325
  "responses": {
@@ -4668,9 +5376,14 @@
4668
5376
  "type": "null"
4669
5377
  }
4670
5378
  ],
5379
+ "description": "The page number from which to start (0-indexed)",
5380
+ "examples": [
5381
+ 0
5382
+ ],
4671
5383
  "default": 0,
4672
5384
  "title": "Page"
4673
- }
5385
+ },
5386
+ "description": "The page number from which to start (0-indexed)"
4674
5387
  },
4675
5388
  {
4676
5389
  "name": "limit",
@@ -4679,9 +5392,14 @@
4679
5392
  "schema": {
4680
5393
  "type": "integer",
4681
5394
  "minimum": 0,
5395
+ "description": "The maximum number of items to return",
5396
+ "examples": [
5397
+ 25
5398
+ ],
4682
5399
  "default": 25,
4683
5400
  "title": "Limit"
4684
- }
5401
+ },
5402
+ "description": "The maximum number of items to return"
4685
5403
  },
4686
5404
  {
4687
5405
  "name": "search_fields",
@@ -4692,9 +5410,14 @@
4692
5410
  "items": {
4693
5411
  "$ref": "#/components/schemas/ChannelTargetProperties"
4694
5412
  },
5413
+ "description": "String names of fields to search. Correspond by index to search field values",
5414
+ "examples": [
5415
+ "name"
5416
+ ],
4695
5417
  "default": [],
4696
5418
  "title": "Search Fields"
4697
- }
5419
+ },
5420
+ "description": "String names of fields to search. Correspond by index to search field values"
4698
5421
  },
4699
5422
  {
4700
5423
  "name": "search_field_values",
@@ -4705,9 +5428,14 @@
4705
5428
  "items": {
4706
5429
  "type": "string"
4707
5430
  },
5431
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
5432
+ "examples": [
5433
+ "Some Object Name"
5434
+ ],
4708
5435
  "default": [],
4709
5436
  "title": "Search Field Values"
4710
- }
5437
+ },
5438
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
4711
5439
  },
4712
5440
  {
4713
5441
  "name": "order_by",
@@ -4722,8 +5450,13 @@
4722
5450
  "type": "null"
4723
5451
  }
4724
5452
  ],
5453
+ "description": "The field whose value should be used to order the results",
5454
+ "examples": [
5455
+ "name"
5456
+ ],
4725
5457
  "title": "Order By"
4726
- }
5458
+ },
5459
+ "description": "The field whose value should be used to order the results"
4727
5460
  },
4728
5461
  {
4729
5462
  "name": "order_by_direction",
@@ -4738,8 +5471,10 @@
4738
5471
  "type": "null"
4739
5472
  }
4740
5473
  ],
5474
+ "description": "The direction in which to order the results",
4741
5475
  "title": "Order By Direction"
4742
- }
5476
+ },
5477
+ "description": "The direction in which to order the results"
4743
5478
  },
4744
5479
  {
4745
5480
  "name": "fields",
@@ -4757,9 +5492,11 @@
4757
5492
  "type": "null"
4758
5493
  }
4759
5494
  ],
5495
+ "description": "The fields to include in the response",
4760
5496
  "default": [],
4761
5497
  "title": "Fields"
4762
- }
5498
+ },
5499
+ "description": "The fields to include in the response"
4763
5500
  },
4764
5501
  {
4765
5502
  "name": "start_datetime",
@@ -4774,8 +5511,13 @@
4774
5511
  "type": "null"
4775
5512
  }
4776
5513
  ],
5514
+ "description": "The start datetime for filtering results",
5515
+ "examples": [
5516
+ "2023-01-01T00:00:00Z"
5517
+ ],
4777
5518
  "title": "Start Datetime"
4778
- }
5519
+ },
5520
+ "description": "The start datetime for filtering results"
4779
5521
  },
4780
5522
  {
4781
5523
  "name": "end_datetime",
@@ -4790,8 +5532,13 @@
4790
5532
  "type": "null"
4791
5533
  }
4792
5534
  ],
5535
+ "description": "The end datetime for filtering results",
5536
+ "examples": [
5537
+ "2024-01-01T00:00:00Z"
5538
+ ],
4793
5539
  "title": "End Datetime"
4794
- }
5540
+ },
5541
+ "description": "The end datetime for filtering results"
4795
5542
  }
4796
5543
  ],
4797
5544
  "responses": {
@@ -5088,9 +5835,14 @@
5088
5835
  "type": "null"
5089
5836
  }
5090
5837
  ],
5838
+ "description": "The page number from which to start (0-indexed)",
5839
+ "examples": [
5840
+ 0
5841
+ ],
5091
5842
  "default": 0,
5092
5843
  "title": "Page"
5093
- }
5844
+ },
5845
+ "description": "The page number from which to start (0-indexed)"
5094
5846
  },
5095
5847
  {
5096
5848
  "name": "limit",
@@ -5099,9 +5851,14 @@
5099
5851
  "schema": {
5100
5852
  "type": "integer",
5101
5853
  "minimum": 0,
5854
+ "description": "The maximum number of items to return",
5855
+ "examples": [
5856
+ 25
5857
+ ],
5102
5858
  "default": 25,
5103
5859
  "title": "Limit"
5104
- }
5860
+ },
5861
+ "description": "The maximum number of items to return"
5105
5862
  },
5106
5863
  {
5107
5864
  "name": "search_fields",
@@ -5112,9 +5869,14 @@
5112
5869
  "items": {
5113
5870
  "$ref": "#/components/schemas/DirectoryMemberProperties"
5114
5871
  },
5872
+ "description": "String names of fields to search. Correspond by index to search field values",
5873
+ "examples": [
5874
+ "name"
5875
+ ],
5115
5876
  "default": [],
5116
5877
  "title": "Search Fields"
5117
- }
5878
+ },
5879
+ "description": "String names of fields to search. Correspond by index to search field values"
5118
5880
  },
5119
5881
  {
5120
5882
  "name": "search_field_values",
@@ -5125,9 +5887,14 @@
5125
5887
  "items": {
5126
5888
  "type": "string"
5127
5889
  },
5890
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
5891
+ "examples": [
5892
+ "Some Object Name"
5893
+ ],
5128
5894
  "default": [],
5129
5895
  "title": "Search Field Values"
5130
- }
5896
+ },
5897
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
5131
5898
  },
5132
5899
  {
5133
5900
  "name": "order_by",
@@ -5142,8 +5909,13 @@
5142
5909
  "type": "null"
5143
5910
  }
5144
5911
  ],
5912
+ "description": "The field whose value should be used to order the results",
5913
+ "examples": [
5914
+ "name"
5915
+ ],
5145
5916
  "title": "Order By"
5146
- }
5917
+ },
5918
+ "description": "The field whose value should be used to order the results"
5147
5919
  },
5148
5920
  {
5149
5921
  "name": "order_by_direction",
@@ -5158,8 +5930,10 @@
5158
5930
  "type": "null"
5159
5931
  }
5160
5932
  ],
5933
+ "description": "The direction in which to order the results",
5161
5934
  "title": "Order By Direction"
5162
- }
5935
+ },
5936
+ "description": "The direction in which to order the results"
5163
5937
  },
5164
5938
  {
5165
5939
  "name": "fields",
@@ -5177,9 +5951,11 @@
5177
5951
  "type": "null"
5178
5952
  }
5179
5953
  ],
5954
+ "description": "The fields to include in the response",
5180
5955
  "default": [],
5181
5956
  "title": "Fields"
5182
- }
5957
+ },
5958
+ "description": "The fields to include in the response"
5183
5959
  },
5184
5960
  {
5185
5961
  "name": "start_datetime",
@@ -5194,8 +5970,13 @@
5194
5970
  "type": "null"
5195
5971
  }
5196
5972
  ],
5973
+ "description": "The start datetime for filtering results",
5974
+ "examples": [
5975
+ "2023-01-01T00:00:00Z"
5976
+ ],
5197
5977
  "title": "Start Datetime"
5198
- }
5978
+ },
5979
+ "description": "The start datetime for filtering results"
5199
5980
  },
5200
5981
  {
5201
5982
  "name": "end_datetime",
@@ -5210,8 +5991,13 @@
5210
5991
  "type": "null"
5211
5992
  }
5212
5993
  ],
5994
+ "description": "The end datetime for filtering results",
5995
+ "examples": [
5996
+ "2024-01-01T00:00:00Z"
5997
+ ],
5213
5998
  "title": "End Datetime"
5214
- }
5999
+ },
6000
+ "description": "The end datetime for filtering results"
5215
6001
  }
5216
6002
  ],
5217
6003
  "responses": {
@@ -5579,9 +6365,14 @@
5579
6365
  "type": "null"
5580
6366
  }
5581
6367
  ],
6368
+ "description": "The page number from which to start (0-indexed)",
6369
+ "examples": [
6370
+ 0
6371
+ ],
5582
6372
  "default": 0,
5583
6373
  "title": "Page"
5584
- }
6374
+ },
6375
+ "description": "The page number from which to start (0-indexed)"
5585
6376
  },
5586
6377
  {
5587
6378
  "name": "limit",
@@ -5590,9 +6381,14 @@
5590
6381
  "schema": {
5591
6382
  "type": "integer",
5592
6383
  "minimum": 0,
6384
+ "description": "The maximum number of items to return",
6385
+ "examples": [
6386
+ 25
6387
+ ],
5593
6388
  "default": 25,
5594
6389
  "title": "Limit"
5595
- }
6390
+ },
6391
+ "description": "The maximum number of items to return"
5596
6392
  },
5597
6393
  {
5598
6394
  "name": "search_fields",
@@ -5603,9 +6399,14 @@
5603
6399
  "items": {
5604
6400
  "$ref": "#/components/schemas/DashboardProperties"
5605
6401
  },
6402
+ "description": "String names of fields to search. Correspond by index to search field values",
6403
+ "examples": [
6404
+ "name"
6405
+ ],
5606
6406
  "default": [],
5607
6407
  "title": "Search Fields"
5608
- }
6408
+ },
6409
+ "description": "String names of fields to search. Correspond by index to search field values"
5609
6410
  },
5610
6411
  {
5611
6412
  "name": "search_field_values",
@@ -5616,9 +6417,14 @@
5616
6417
  "items": {
5617
6418
  "type": "string"
5618
6419
  },
6420
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
6421
+ "examples": [
6422
+ "Some Object Name"
6423
+ ],
5619
6424
  "default": [],
5620
6425
  "title": "Search Field Values"
5621
- }
6426
+ },
6427
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
5622
6428
  },
5623
6429
  {
5624
6430
  "name": "order_by",
@@ -5633,8 +6439,13 @@
5633
6439
  "type": "null"
5634
6440
  }
5635
6441
  ],
6442
+ "description": "The field whose value should be used to order the results",
6443
+ "examples": [
6444
+ "name"
6445
+ ],
5636
6446
  "title": "Order By"
5637
- }
6447
+ },
6448
+ "description": "The field whose value should be used to order the results"
5638
6449
  },
5639
6450
  {
5640
6451
  "name": "order_by_direction",
@@ -5649,8 +6460,10 @@
5649
6460
  "type": "null"
5650
6461
  }
5651
6462
  ],
6463
+ "description": "The direction in which to order the results",
5652
6464
  "title": "Order By Direction"
5653
- }
6465
+ },
6466
+ "description": "The direction in which to order the results"
5654
6467
  },
5655
6468
  {
5656
6469
  "name": "fields",
@@ -5668,9 +6481,11 @@
5668
6481
  "type": "null"
5669
6482
  }
5670
6483
  ],
6484
+ "description": "The fields to include in the response",
5671
6485
  "default": [],
5672
6486
  "title": "Fields"
5673
- }
6487
+ },
6488
+ "description": "The fields to include in the response"
5674
6489
  },
5675
6490
  {
5676
6491
  "name": "start_datetime",
@@ -5685,8 +6500,13 @@
5685
6500
  "type": "null"
5686
6501
  }
5687
6502
  ],
6503
+ "description": "The start datetime for filtering results",
6504
+ "examples": [
6505
+ "2023-01-01T00:00:00Z"
6506
+ ],
5688
6507
  "title": "Start Datetime"
5689
- }
6508
+ },
6509
+ "description": "The start datetime for filtering results"
5690
6510
  },
5691
6511
  {
5692
6512
  "name": "end_datetime",
@@ -5701,8 +6521,13 @@
5701
6521
  "type": "null"
5702
6522
  }
5703
6523
  ],
6524
+ "description": "The end datetime for filtering results",
6525
+ "examples": [
6526
+ "2024-01-01T00:00:00Z"
6527
+ ],
5704
6528
  "title": "End Datetime"
5705
- }
6529
+ },
6530
+ "description": "The end datetime for filtering results"
5706
6531
  }
5707
6532
  ],
5708
6533
  "responses": {
@@ -5922,9 +6747,14 @@
5922
6747
  "type": "null"
5923
6748
  }
5924
6749
  ],
6750
+ "description": "The page number from which to start (0-indexed)",
6751
+ "examples": [
6752
+ 0
6753
+ ],
5925
6754
  "default": 0,
5926
6755
  "title": "Page"
5927
- }
6756
+ },
6757
+ "description": "The page number from which to start (0-indexed)"
5928
6758
  },
5929
6759
  {
5930
6760
  "name": "limit",
@@ -5933,9 +6763,14 @@
5933
6763
  "schema": {
5934
6764
  "type": "integer",
5935
6765
  "minimum": 0,
6766
+ "description": "The maximum number of items to return",
6767
+ "examples": [
6768
+ 25
6769
+ ],
5936
6770
  "default": 25,
5937
6771
  "title": "Limit"
5938
- }
6772
+ },
6773
+ "description": "The maximum number of items to return"
5939
6774
  },
5940
6775
  {
5941
6776
  "name": "search_fields",
@@ -5946,9 +6781,14 @@
5946
6781
  "items": {
5947
6782
  "$ref": "#/components/schemas/BatchProperties"
5948
6783
  },
6784
+ "description": "String names of fields to search. Correspond by index to search field values",
6785
+ "examples": [
6786
+ "name"
6787
+ ],
5949
6788
  "default": [],
5950
6789
  "title": "Search Fields"
5951
- }
6790
+ },
6791
+ "description": "String names of fields to search. Correspond by index to search field values"
5952
6792
  },
5953
6793
  {
5954
6794
  "name": "search_field_values",
@@ -5959,9 +6799,14 @@
5959
6799
  "items": {
5960
6800
  "type": "string"
5961
6801
  },
6802
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
6803
+ "examples": [
6804
+ "Some Object Name"
6805
+ ],
5962
6806
  "default": [],
5963
6807
  "title": "Search Field Values"
5964
- }
6808
+ },
6809
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
5965
6810
  },
5966
6811
  {
5967
6812
  "name": "order_by",
@@ -5976,8 +6821,13 @@
5976
6821
  "type": "null"
5977
6822
  }
5978
6823
  ],
6824
+ "description": "The field whose value should be used to order the results",
6825
+ "examples": [
6826
+ "name"
6827
+ ],
5979
6828
  "title": "Order By"
5980
- }
6829
+ },
6830
+ "description": "The field whose value should be used to order the results"
5981
6831
  },
5982
6832
  {
5983
6833
  "name": "order_by_direction",
@@ -5992,8 +6842,10 @@
5992
6842
  "type": "null"
5993
6843
  }
5994
6844
  ],
6845
+ "description": "The direction in which to order the results",
5995
6846
  "title": "Order By Direction"
5996
- }
6847
+ },
6848
+ "description": "The direction in which to order the results"
5997
6849
  },
5998
6850
  {
5999
6851
  "name": "fields",
@@ -6011,9 +6863,11 @@
6011
6863
  "type": "null"
6012
6864
  }
6013
6865
  ],
6866
+ "description": "The fields to include in the response",
6014
6867
  "default": [],
6015
6868
  "title": "Fields"
6016
- }
6869
+ },
6870
+ "description": "The fields to include in the response"
6017
6871
  },
6018
6872
  {
6019
6873
  "name": "start_datetime",
@@ -6028,8 +6882,13 @@
6028
6882
  "type": "null"
6029
6883
  }
6030
6884
  ],
6885
+ "description": "The start datetime for filtering results",
6886
+ "examples": [
6887
+ "2023-01-01T00:00:00Z"
6888
+ ],
6031
6889
  "title": "Start Datetime"
6032
- }
6890
+ },
6891
+ "description": "The start datetime for filtering results"
6033
6892
  },
6034
6893
  {
6035
6894
  "name": "end_datetime",
@@ -6044,8 +6903,13 @@
6044
6903
  "type": "null"
6045
6904
  }
6046
6905
  ],
6906
+ "description": "The end datetime for filtering results",
6907
+ "examples": [
6908
+ "2024-01-01T00:00:00Z"
6909
+ ],
6047
6910
  "title": "End Datetime"
6048
- }
6911
+ },
6912
+ "description": "The end datetime for filtering results"
6049
6913
  }
6050
6914
  ],
6051
6915
  "responses": {
@@ -6491,9 +7355,14 @@
6491
7355
  "type": "null"
6492
7356
  }
6493
7357
  ],
7358
+ "description": "The page number from which to start (0-indexed)",
7359
+ "examples": [
7360
+ 0
7361
+ ],
6494
7362
  "default": 0,
6495
7363
  "title": "Page"
6496
- }
7364
+ },
7365
+ "description": "The page number from which to start (0-indexed)"
6497
7366
  },
6498
7367
  {
6499
7368
  "name": "limit",
@@ -6502,9 +7371,14 @@
6502
7371
  "schema": {
6503
7372
  "type": "integer",
6504
7373
  "minimum": 0,
7374
+ "description": "The maximum number of items to return",
7375
+ "examples": [
7376
+ 25
7377
+ ],
6505
7378
  "default": 25,
6506
7379
  "title": "Limit"
6507
- }
7380
+ },
7381
+ "description": "The maximum number of items to return"
6508
7382
  },
6509
7383
  {
6510
7384
  "name": "search_fields",
@@ -6515,9 +7389,14 @@
6515
7389
  "items": {
6516
7390
  "$ref": "#/components/schemas/CampaignProperties"
6517
7391
  },
7392
+ "description": "String names of fields to search. Correspond by index to search field values",
7393
+ "examples": [
7394
+ "name"
7395
+ ],
6518
7396
  "default": [],
6519
7397
  "title": "Search Fields"
6520
- }
7398
+ },
7399
+ "description": "String names of fields to search. Correspond by index to search field values"
6521
7400
  },
6522
7401
  {
6523
7402
  "name": "search_field_values",
@@ -6528,9 +7407,14 @@
6528
7407
  "items": {
6529
7408
  "type": "string"
6530
7409
  },
7410
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
7411
+ "examples": [
7412
+ "Some Object Name"
7413
+ ],
6531
7414
  "default": [],
6532
7415
  "title": "Search Field Values"
6533
- }
7416
+ },
7417
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
6534
7418
  },
6535
7419
  {
6536
7420
  "name": "order_by",
@@ -6545,8 +7429,13 @@
6545
7429
  "type": "null"
6546
7430
  }
6547
7431
  ],
7432
+ "description": "The field whose value should be used to order the results",
7433
+ "examples": [
7434
+ "name"
7435
+ ],
6548
7436
  "title": "Order By"
6549
- }
7437
+ },
7438
+ "description": "The field whose value should be used to order the results"
6550
7439
  },
6551
7440
  {
6552
7441
  "name": "order_by_direction",
@@ -6561,8 +7450,10 @@
6561
7450
  "type": "null"
6562
7451
  }
6563
7452
  ],
7453
+ "description": "The direction in which to order the results",
6564
7454
  "title": "Order By Direction"
6565
- }
7455
+ },
7456
+ "description": "The direction in which to order the results"
6566
7457
  },
6567
7458
  {
6568
7459
  "name": "fields",
@@ -6580,9 +7471,11 @@
6580
7471
  "type": "null"
6581
7472
  }
6582
7473
  ],
7474
+ "description": "The fields to include in the response",
6583
7475
  "default": [],
6584
7476
  "title": "Fields"
6585
- }
7477
+ },
7478
+ "description": "The fields to include in the response"
6586
7479
  },
6587
7480
  {
6588
7481
  "name": "start_datetime",
@@ -6597,8 +7490,13 @@
6597
7490
  "type": "null"
6598
7491
  }
6599
7492
  ],
7493
+ "description": "The start datetime for filtering results",
7494
+ "examples": [
7495
+ "2023-01-01T00:00:00Z"
7496
+ ],
6600
7497
  "title": "Start Datetime"
6601
- }
7498
+ },
7499
+ "description": "The start datetime for filtering results"
6602
7500
  },
6603
7501
  {
6604
7502
  "name": "end_datetime",
@@ -6613,8 +7511,13 @@
6613
7511
  "type": "null"
6614
7512
  }
6615
7513
  ],
7514
+ "description": "The end datetime for filtering results",
7515
+ "examples": [
7516
+ "2024-01-01T00:00:00Z"
7517
+ ],
6616
7518
  "title": "End Datetime"
6617
- }
7519
+ },
7520
+ "description": "The end datetime for filtering results"
6618
7521
  }
6619
7522
  ],
6620
7523
  "responses": {
@@ -6842,9 +7745,14 @@
6842
7745
  "type": "null"
6843
7746
  }
6844
7747
  ],
7748
+ "description": "The page number from which to start (0-indexed)",
7749
+ "examples": [
7750
+ 0
7751
+ ],
6845
7752
  "default": 0,
6846
7753
  "title": "Page"
6847
- }
7754
+ },
7755
+ "description": "The page number from which to start (0-indexed)"
6848
7756
  },
6849
7757
  {
6850
7758
  "name": "limit",
@@ -6853,9 +7761,14 @@
6853
7761
  "schema": {
6854
7762
  "type": "integer",
6855
7763
  "minimum": 0,
7764
+ "description": "The maximum number of items to return",
7765
+ "examples": [
7766
+ 25
7767
+ ],
6856
7768
  "default": 25,
6857
7769
  "title": "Limit"
6858
- }
7770
+ },
7771
+ "description": "The maximum number of items to return"
6859
7772
  },
6860
7773
  {
6861
7774
  "name": "search_fields",
@@ -6866,9 +7779,14 @@
6866
7779
  "items": {
6867
7780
  "$ref": "#/components/schemas/LanguageGroupProperties"
6868
7781
  },
7782
+ "description": "String names of fields to search. Correspond by index to search field values",
7783
+ "examples": [
7784
+ "name"
7785
+ ],
6869
7786
  "default": [],
6870
7787
  "title": "Search Fields"
6871
- }
7788
+ },
7789
+ "description": "String names of fields to search. Correspond by index to search field values"
6872
7790
  },
6873
7791
  {
6874
7792
  "name": "search_field_values",
@@ -6879,9 +7797,14 @@
6879
7797
  "items": {
6880
7798
  "type": "string"
6881
7799
  },
7800
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
7801
+ "examples": [
7802
+ "Some Object Name"
7803
+ ],
6882
7804
  "default": [],
6883
7805
  "title": "Search Field Values"
6884
- }
7806
+ },
7807
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
6885
7808
  },
6886
7809
  {
6887
7810
  "name": "order_by",
@@ -6896,8 +7819,13 @@
6896
7819
  "type": "null"
6897
7820
  }
6898
7821
  ],
7822
+ "description": "The field whose value should be used to order the results",
7823
+ "examples": [
7824
+ "name"
7825
+ ],
6899
7826
  "title": "Order By"
6900
- }
7827
+ },
7828
+ "description": "The field whose value should be used to order the results"
6901
7829
  },
6902
7830
  {
6903
7831
  "name": "order_by_direction",
@@ -6912,8 +7840,10 @@
6912
7840
  "type": "null"
6913
7841
  }
6914
7842
  ],
7843
+ "description": "The direction in which to order the results",
6915
7844
  "title": "Order By Direction"
6916
- }
7845
+ },
7846
+ "description": "The direction in which to order the results"
6917
7847
  },
6918
7848
  {
6919
7849
  "name": "fields",
@@ -6931,9 +7861,11 @@
6931
7861
  "type": "null"
6932
7862
  }
6933
7863
  ],
7864
+ "description": "The fields to include in the response",
6934
7865
  "default": [],
6935
7866
  "title": "Fields"
6936
- }
7867
+ },
7868
+ "description": "The fields to include in the response"
6937
7869
  },
6938
7870
  {
6939
7871
  "name": "start_datetime",
@@ -6948,8 +7880,13 @@
6948
7880
  "type": "null"
6949
7881
  }
6950
7882
  ],
7883
+ "description": "The start datetime for filtering results",
7884
+ "examples": [
7885
+ "2023-01-01T00:00:00Z"
7886
+ ],
6951
7887
  "title": "Start Datetime"
6952
- }
7888
+ },
7889
+ "description": "The start datetime for filtering results"
6953
7890
  },
6954
7891
  {
6955
7892
  "name": "end_datetime",
@@ -6964,8 +7901,13 @@
6964
7901
  "type": "null"
6965
7902
  }
6966
7903
  ],
7904
+ "description": "The end datetime for filtering results",
7905
+ "examples": [
7906
+ "2024-01-01T00:00:00Z"
7907
+ ],
6967
7908
  "title": "End Datetime"
6968
- }
7909
+ },
7910
+ "description": "The end datetime for filtering results"
6969
7911
  }
6970
7912
  ],
6971
7913
  "responses": {
@@ -7673,7 +8615,7 @@
7673
8615
  "last_updated_by"
7674
8616
  ],
7675
8617
  "title": "AgentResponse",
7676
- "description": "When a user interacts with the Syllable system, they do so by communicating with an agent.\nAn agent is linked to a prompt, a custom message, and one or more channel targets to define its\nbehavior and capabilities."
8618
+ "description": "When a user interacts with the Syllable system, they do so by communicating with an agent.\nAn agent is linked to a prompt, a custom message, and one or more channel targets to define its\nbehavior and capabilities. For more information, see\n[Console docs](https://docs.syllable.ai/workspaces/Agents)."
7677
8619
  },
7678
8620
  "AgentSttProvider": {
7679
8621
  "type": "string",
@@ -8436,7 +9378,7 @@
8436
9378
  "last_updated_by"
8437
9379
  ],
8438
9380
  "title": "ChannelTargetResponse",
8439
- "description": "A channel target links a channel to an agent, allowing users to communicate with the agent\nthrough that channel."
9381
+ "description": "A channel target links a channel to an agent, allowing users to communicate with the agent\nthrough that channel. For more information, see\n[Console docs](https://docs.syllable.ai/Resources/Channels)."
8440
9382
  },
8441
9383
  "ChannelTargetUpdateRequest": {
8442
9384
  "properties": {
@@ -9120,7 +10062,7 @@
9120
10062
  "last_updated_by"
9121
10063
  ],
9122
10064
  "title": "CustomMessageResponse",
9123
- "description": "A custom message is a pre-configured message delivered by an agent as a greeting at the\nbeginning of a conversation. Multiple agents can use the same custom mesasage. A custom message\nhas one or more rules defined, which allow for different messages to be dynamically selected and\ndelivered at runtime based on the current time and either date or day of the week."
10065
+ "description": "A custom message is a pre-configured message delivered by an agent as a greeting at the\nbeginning of a conversation. Multiple agents can use the same custom mesasage. A custom message\nhas one or more rules defined, which allow for different messages to be dynamically selected and\ndelivered at runtime based on the current time and either date or day of the week. For more \ninformation, see [Console docs](https://docs.syllable.ai/Resources/Messages)."
9124
10066
  },
9125
10067
  "CustomMessageRule": {
9126
10068
  "properties": {
@@ -9601,7 +10543,7 @@
9601
10543
  "text"
9602
10544
  ],
9603
10545
  "title": "DataSourceDetailResponse",
9604
- "description": "Metadata about a data source, along with the text."
10546
+ "description": "Metadata about a data source, along with the text. A data source is a blob of text that \ncan be made available to an agent's general info tools to provide more context to the agent when\ngenerating its responses. For more information, see\n[Console docs](https://docs.syllable.ai/Resources/DataSources)."
9605
10547
  },
9606
10548
  "DataSourceMetadataResponse": {
9607
10549
  "properties": {
@@ -9719,7 +10661,7 @@
9719
10661
  "last_updated_by"
9720
10662
  ],
9721
10663
  "title": "DataSourceMetadataResponse",
9722
- "description": "Metadata about a data source, not including the text."
10664
+ "description": "Metadata about a data source, not including the text. A data source is a blob of text that \ncan be made available to an agent's general info tools to provide more context to the agent when\ngenerating its responses. For more information, see\n[Console docs](https://docs.syllable.ai/Resources/DataSources)."
9723
10665
  },
9724
10666
  "DataSourceProperties": {
9725
10667
  "type": "string",
@@ -9847,6 +10789,56 @@
9847
10789
  ],
9848
10790
  "title": "DayOfWeek"
9849
10791
  },
10792
+ "DialogMessage": {
10793
+ "properties": {
10794
+ "text": {
10795
+ "type": "string",
10796
+ "title": "Text"
10797
+ }
10798
+ },
10799
+ "type": "object",
10800
+ "required": [
10801
+ "text"
10802
+ ],
10803
+ "title": "DialogMessage"
10804
+ },
10805
+ "DialogRole": {
10806
+ "type": "string",
10807
+ "enum": [
10808
+ "agent",
10809
+ "user"
10810
+ ],
10811
+ "title": "DialogRole"
10812
+ },
10813
+ "DialogToolCall": {
10814
+ "properties": {
10815
+ "toll_call_id": {
10816
+ "type": "string",
10817
+ "title": "Toll Call Id"
10818
+ },
10819
+ "tool_name": {
10820
+ "type": "string",
10821
+ "title": "Tool Name"
10822
+ },
10823
+ "tool_arguments": {
10824
+ "type": "object",
10825
+ "title": "Tool Arguments"
10826
+ },
10827
+ "timestamp": {
10828
+ "type": "string",
10829
+ "format": "date-time",
10830
+ "title": "Timestamp"
10831
+ }
10832
+ },
10833
+ "type": "object",
10834
+ "required": [
10835
+ "toll_call_id",
10836
+ "tool_name",
10837
+ "tool_arguments",
10838
+ "timestamp"
10839
+ ],
10840
+ "title": "DialogToolCall"
10841
+ },
9850
10842
  "DirectoryExtension": {
9851
10843
  "properties": {
9852
10844
  "name": {
@@ -10754,7 +11746,8 @@
10754
11746
  "updated_at",
10755
11747
  "last_updated_by"
10756
11748
  ],
10757
- "title": "LanguageGroupResponse"
11749
+ "title": "LanguageGroupResponse",
11750
+ "description": "A language group is a collection of language, voice, and DTMF configuration that can be \nlinked to an agent to define the languages and voices it supports. For more information, see \n[Console docs](https://docs.syllable.ai/Resources/LanguageGroups)."
10758
11751
  },
10759
11752
  "LanguageGroupUpdateRequest": {
10760
11753
  "properties": {
@@ -12219,7 +13212,7 @@
12219
13212
  "last_updated"
12220
13213
  ],
12221
13214
  "title": "PromptResponse",
12222
- "description": "A prompt defines the behavior of an agent by delivering instructions to the LLM about how the\nagent should behave. A prompt can be linked to one or more agents. A prompt can also be linked to\ntools to allow an agent using it to use those tools."
13215
+ "description": "A prompt defines the behavior of an agent by delivering instructions to the LLM about how the\nagent should behave. A prompt can be linked to one or more agents. A prompt can also be linked to\ntools to allow an agent using it to use those tools. For more information, see\n[Console docs](https://docs.syllable.ai/Resources/Prompts)."
12223
13216
  },
12224
13217
  "PromptUpdateRequest": {
12225
13218
  "properties": {
@@ -12754,6 +13747,42 @@
12754
13747
  "title": "SessionAction",
12755
13748
  "description": "Information about a given tool invocation as part of a session."
12756
13749
  },
13750
+ "SessionData": {
13751
+ "properties": {
13752
+ "session_id": {
13753
+ "type": "integer",
13754
+ "title": "Session Id"
13755
+ },
13756
+ "source": {
13757
+ "type": "string",
13758
+ "title": "Source"
13759
+ },
13760
+ "target": {
13761
+ "type": "string",
13762
+ "title": "Target"
13763
+ },
13764
+ "is_test": {
13765
+ "type": "boolean",
13766
+ "title": "Is Test"
13767
+ },
13768
+ "messages": {
13769
+ "items": {
13770
+ "$ref": "#/components/schemas/SessionMessage"
13771
+ },
13772
+ "type": "array",
13773
+ "title": "Messages"
13774
+ }
13775
+ },
13776
+ "type": "object",
13777
+ "required": [
13778
+ "session_id",
13779
+ "source",
13780
+ "target",
13781
+ "is_test",
13782
+ "messages"
13783
+ ],
13784
+ "title": "SessionData"
13785
+ },
12757
13786
  "SessionLabel": {
12758
13787
  "properties": {
12759
13788
  "session_id": {
@@ -12936,6 +13965,36 @@
12936
13965
  ],
12937
13966
  "title": "SessionLabelProperties"
12938
13967
  },
13968
+ "SessionMessage": {
13969
+ "properties": {
13970
+ "role": {
13971
+ "$ref": "#/components/schemas/DialogRole"
13972
+ },
13973
+ "dialog": {
13974
+ "$ref": "#/components/schemas/DialogMessage"
13975
+ },
13976
+ "tool_calls": {
13977
+ "items": {
13978
+ "$ref": "#/components/schemas/DialogToolCall"
13979
+ },
13980
+ "type": "array",
13981
+ "title": "Tool Calls"
13982
+ },
13983
+ "timestamp": {
13984
+ "type": "string",
13985
+ "format": "date-time",
13986
+ "title": "Timestamp"
13987
+ }
13988
+ },
13989
+ "type": "object",
13990
+ "required": [
13991
+ "role",
13992
+ "dialog",
13993
+ "tool_calls",
13994
+ "timestamp"
13995
+ ],
13996
+ "title": "SessionMessage"
13997
+ },
12939
13998
  "SessionProperties": {
12940
13999
  "type": "string",
12941
14000
  "enum": [
@@ -13115,7 +14174,7 @@
13115
14174
  "actions"
13116
14175
  ],
13117
14176
  "title": "SessionTranscriptionResponse",
13118
- "description": "Text transcript of a given session."
14177
+ "description": "Text transcript of a given session. For more information, see\n[Console docs](https://docs.syllable.ai/workspaces/Sessions)."
13119
14178
  },
13120
14179
  "StaticToolParameter": {
13121
14180
  "properties": {
@@ -13222,9 +14281,17 @@
13222
14281
  "description": "ID of the agent with which the chat is taking place"
13223
14282
  },
13224
14283
  "org_name": {
13225
- "type": "string",
14284
+ "anyOf": [
14285
+ {
14286
+ "type": "string"
14287
+ },
14288
+ {
14289
+ "type": "null"
14290
+ }
14291
+ ],
13226
14292
  "title": "Org Name",
13227
- "description": "Name of the organization associated with the agent"
14293
+ "description": "Unused: Name of the organization associated with the agent",
14294
+ "deprecated": true
13228
14295
  },
13229
14296
  "override_timestamp": {
13230
14297
  "anyOf": [
@@ -13250,8 +14317,7 @@
13250
14317
  "service_name",
13251
14318
  "source",
13252
14319
  "test_id",
13253
- "agent_id",
13254
- "org_name"
14320
+ "agent_id"
13255
14321
  ],
13256
14322
  "title": "TestMessage",
13257
14323
  "description": "Message sent in a test chat with an agent."
@@ -13553,7 +14619,7 @@
13553
14619
  "fields"
13554
14620
  ],
13555
14621
  "title": "ToolDetailResponse",
13556
- "description": "A tool is a function that an agent can call to perform actions like accessing databases,\nmaking API calls, or processing data. For an agent to have access to a tool, the prompt\nassociated with that agent should be linked to the tool and include instructions to use it."
14622
+ "description": "A tool is a function that an agent can call to perform actions like accessing databases,\nmaking API calls, or processing data. For an agent to have access to a tool, the prompt\nassociated with that agent should be linked to the tool and include instructions to use it.\nFor more information, see [Console docs](https://docs.syllable.ai/Resources/Tools)."
13557
14623
  },
13558
14624
  "ToolFunction": {
13559
14625
  "properties": {
@@ -13876,7 +14942,25 @@
13876
14942
  "last_updated_by"
13877
14943
  ],
13878
14944
  "title": "ToolResponse",
13879
- "description": "A tool is a function that an agent can call to perform actions like accessing databases,\nmaking API calls, or processing data. For an agent to have access to a tool, the prompt\nassociated with that agent should be linked to the tool and include instructions to use it."
14945
+ "description": "A tool is a function that an agent can call to perform actions like accessing databases,\nmaking API calls, or processing data. For an agent to have access to a tool, the prompt\nassociated with that agent should be linked to the tool and include instructions to use it.\nFor more information, see [Console docs](https://docs.syllable.ai/Resources/Tools)."
14946
+ },
14947
+ "ToolResultData": {
14948
+ "properties": {
14949
+ "tool_name": {
14950
+ "type": "string",
14951
+ "title": "Tool Name"
14952
+ },
14953
+ "tool_result": {
14954
+ "type": "object",
14955
+ "title": "Tool Result"
14956
+ }
14957
+ },
14958
+ "type": "object",
14959
+ "required": [
14960
+ "tool_name",
14961
+ "tool_result"
14962
+ ],
14963
+ "title": "ToolResultData"
13880
14964
  },
13881
14965
  "ToolUpdateRequest": {
13882
14966
  "properties": {
@@ -13979,7 +15063,7 @@
13979
15063
  "tags": [
13980
15064
  {
13981
15065
  "name": "agents",
13982
- "description": "Operations related to agent configuration. When a user interacts with the Syllable system, they do so by communicating with an agent. An agent is linked to a prompt, a custom message, and one or more channel targets to define its behavior and capabilities."
15066
+ "description": "Operations related to agent configuration. When a user interacts with the Syllable system, they do so by communicating with an agent. An agent is linked to a prompt, a custom message, and one or more channel targets to define its behavior and capabilities. For more information, see [Console docs](https://docs.syllable.ai/workspaces/Agents)."
13983
15067
  },
13984
15068
  {
13985
15069
  "name": "agents.test",
@@ -13991,7 +15075,7 @@
13991
15075
  },
13992
15076
  {
13993
15077
  "name": "channels.targets",
13994
- "description": "Operations related to channel target configuration. A channel target links a channel to an agent, allowing users to communicate with the agent through that channel."
15078
+ "description": "Operations related to channel target configuration. A channel target links a channel to an agent, allowing users to communicate with the agent through that channel. For more information, see [Console docs](https://docs.syllable.ai/Resources/Channels)."
13995
15079
  },
13996
15080
  {
13997
15081
  "name": "conversations",
@@ -13999,7 +15083,7 @@
13999
15083
  },
14000
15084
  {
14001
15085
  "name": "custom_messages",
14002
- "description": "Operations related to custom message configuration. A custom message is a pre-configured message delivered by an agent as a greeting at the beginning of a conversation. Multiple agents can use the same custom mesasage. A custom message has one or more rules defined, which allow for different messages to be dynamically selected and delivered at runtime based on the current time and either date or day of the week."
15086
+ "description": "Operations related to custom message configuration. A custom message is a pre-configured message delivered by an agent as a greeting at the beginning of a conversation. Multiple agents can use the same custom mesasage. A custom message has one or more rules defined, which allow for different messages to be dynamically selected and delivered at runtime based on the current time and either date or day of the week. For more information, see [Console docs](https://docs.syllable.ai/Resources/Messages)."
14003
15087
  },
14004
15088
  {
14005
15089
  "name": "dashboards",
@@ -14007,7 +15091,7 @@
14007
15091
  },
14008
15092
  {
14009
15093
  "name": "data_sources",
14010
- "description": "Operations related to data sources. A data source is a blob of text that can be made available to an agent's general info tools to provide more context to the agent when generating its responses."
15094
+ "description": "Operations related to data sources. A data source is a blob of text that can be made available to an agent's general info tools to provide more context to the agent when generating its responses. For more information, see [Console docs](https://docs.syllable.ai/Resources/DataSources)."
14011
15095
  },
14012
15096
  {
14013
15097
  "name": "directory",
@@ -14027,7 +15111,7 @@
14027
15111
  },
14028
15112
  {
14029
15113
  "name": "language_groups",
14030
- "description": "Operations related to language groups. A language group is a collection of language, voice, and DTMF configuration that can be linked to an agent to define the languages and voices it supports."
15114
+ "description": "Operations related to language groups. A language group is a collection of language, voice, and DTMF configuration that can be linked to an agent to define the languages and voices it supports. For more information, see [Console docs](https://docs.syllable.ai/Resources/LanguageGroups)."
14031
15115
  },
14032
15116
  {
14033
15117
  "name": "outbound.campaigns",
@@ -14039,7 +15123,7 @@
14039
15123
  },
14040
15124
  {
14041
15125
  "name": "prompts",
14042
- "description": "Operations related to prompts. A prompt defines the behavior of an agent by delivering instructions to the LLM about how the agent should behave. A prompt can be linked to one or more agents. A prompt can also be linked to tools to allow an agent using the prompt to use them."
15126
+ "description": "Operations related to prompts. A prompt defines the behavior of an agent by delivering instructions to the LLM about how the agent should behave. A prompt can be linked to one or more agents. A prompt can also be linked to tools to allow an agent using the prompt to use them. For more information, see [Console docs](https://docs.syllable.ai/Resources/Prompts)."
14043
15127
  },
14044
15128
  {
14045
15129
  "name": "services",
@@ -14047,15 +15131,15 @@
14047
15131
  },
14048
15132
  {
14049
15133
  "name": "sessions",
14050
- "description": "Operations related to sessions. A session is a building block of a conversation."
15134
+ "description": "Operations related to sessions. A session is a building block of a conversation. For more information, see [Console docs](https://docs.syllable.ai/workspaces/Sessions)."
14051
15135
  },
14052
15136
  {
14053
15137
  "name": "session_labels",
14054
- "description": "Operations related to labeling sessions with evaluations of quality and descriptions of issues the user encountered or other details."
15138
+ "description": "Operations related to labeling sessions with evaluations of quality and descriptions of issues the user encountered or other details. For more information, see [Console docs](https://docs.syllable.ai/workspaces/Sessions)."
14055
15139
  },
14056
15140
  {
14057
15141
  "name": "tools",
14058
- "description": "Operations related to tool configuration. A tool is a function that an agent can call to perform actions like accessing databases, making API calls, or processing data. For an agent to have access to a tool, the prompt associated with that agent should be linked to the tool and include instructions to use it."
15142
+ "description": "Operations related to tool configuration. A tool is a function that an agent can call to perform actions like accessing databases, making API calls, or processing data. For an agent to have access to a tool, the prompt associated with that agent should be linked to the tool and include instructions to use it. For more information, see [Console docs](https://docs.syllable.ai/Resources/Tools)."
14059
15143
  }
14060
15144
  ],
14061
15145
  "x-speakeasy-name-override": [