syllable-sdk 0.1.0-alpha.29 → 0.1.0-alpha.30

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 (687) hide show
  1. package/.devcontainer/devcontainer.json +45 -0
  2. package/README.md +1 -55
  3. package/api-reference/openapi.json +4398 -0
  4. package/docs/openapi.json +1 -0
  5. package/docs/sdks/agents/README.md +39 -15
  6. package/docs/sdks/channels/README.md +4 -1
  7. package/docs/sdks/conversations/README.md +1 -1
  8. package/docs/sdks/custommessages/README.md +4 -1
  9. package/docs/sdks/dashboards/README.md +1 -1
  10. package/docs/sdks/events/README.md +1 -1
  11. package/docs/sdks/prompts/README.md +10 -7
  12. package/docs/sdks/services/README.md +1 -1
  13. package/docs/sdks/sessionlabels/README.md +6 -4
  14. package/docs/sdks/sessions/README.md +1 -1
  15. package/docs/sdks/targets/README.md +18 -15
  16. package/docs/sdks/test/README.md +1 -1
  17. package/docs/sdks/tools/README.md +9 -6
  18. package/docs/sdks/transcript/README.md +0 -2
  19. package/funcs/agentsAgentGetAvailableVoices.d.ts.map +1 -1
  20. package/funcs/agentsAgentGetAvailableVoices.js +4 -3
  21. package/funcs/agentsAgentGetAvailableVoices.js.map +1 -1
  22. package/funcs/agentsCreate.d.ts +1 -1
  23. package/funcs/agentsCreate.d.ts.map +1 -1
  24. package/funcs/agentsCreate.js +4 -3
  25. package/funcs/agentsCreate.js.map +1 -1
  26. package/funcs/agentsDelete.d.ts.map +1 -1
  27. package/funcs/agentsDelete.js +4 -3
  28. package/funcs/agentsDelete.js.map +1 -1
  29. package/funcs/agentsGetById.d.ts.map +1 -1
  30. package/funcs/agentsGetById.js +4 -3
  31. package/funcs/agentsGetById.js.map +1 -1
  32. package/funcs/agentsList.d.ts.map +1 -1
  33. package/funcs/agentsList.js +4 -3
  34. package/funcs/agentsList.js.map +1 -1
  35. package/funcs/agentsTestSendTestMessage.d.ts.map +1 -1
  36. package/funcs/agentsTestSendTestMessage.js +4 -3
  37. package/funcs/agentsTestSendTestMessage.js.map +1 -1
  38. package/funcs/agentsUpdate.d.ts +1 -1
  39. package/funcs/agentsUpdate.d.ts.map +1 -1
  40. package/funcs/agentsUpdate.js +4 -3
  41. package/funcs/agentsUpdate.js.map +1 -1
  42. package/funcs/channelsDelete.d.ts.map +1 -1
  43. package/funcs/channelsDelete.js +4 -3
  44. package/funcs/channelsDelete.js.map +1 -1
  45. package/funcs/channelsList.d.ts.map +1 -1
  46. package/funcs/channelsList.js +4 -3
  47. package/funcs/channelsList.js.map +1 -1
  48. package/funcs/channelsTargetsAvailableTargets.d.ts.map +1 -1
  49. package/funcs/channelsTargetsAvailableTargets.js +4 -3
  50. package/funcs/channelsTargetsAvailableTargets.js.map +1 -1
  51. package/funcs/channelsTargetsCreate.d.ts +1 -1
  52. package/funcs/channelsTargetsCreate.d.ts.map +1 -1
  53. package/funcs/channelsTargetsCreate.js +4 -3
  54. package/funcs/channelsTargetsCreate.js.map +1 -1
  55. package/funcs/channelsTargetsGetById.d.ts +1 -1
  56. package/funcs/channelsTargetsGetById.d.ts.map +1 -1
  57. package/funcs/channelsTargetsGetById.js +4 -3
  58. package/funcs/channelsTargetsGetById.js.map +1 -1
  59. package/funcs/channelsTargetsList.d.ts +1 -1
  60. package/funcs/channelsTargetsList.d.ts.map +1 -1
  61. package/funcs/channelsTargetsList.js +4 -3
  62. package/funcs/channelsTargetsList.js.map +1 -1
  63. package/funcs/channelsTargetsUpdate.d.ts +1 -1
  64. package/funcs/channelsTargetsUpdate.d.ts.map +1 -1
  65. package/funcs/channelsTargetsUpdate.js +4 -3
  66. package/funcs/channelsTargetsUpdate.js.map +1 -1
  67. package/funcs/conversationsList.d.ts.map +1 -1
  68. package/funcs/conversationsList.js +4 -3
  69. package/funcs/conversationsList.js.map +1 -1
  70. package/funcs/customMessagesCreate.d.ts.map +1 -1
  71. package/funcs/customMessagesCreate.js +4 -3
  72. package/funcs/customMessagesCreate.js.map +1 -1
  73. package/funcs/customMessagesDelete.d.ts.map +1 -1
  74. package/funcs/customMessagesDelete.js +4 -3
  75. package/funcs/customMessagesDelete.js.map +1 -1
  76. package/funcs/customMessagesGetById.d.ts.map +1 -1
  77. package/funcs/customMessagesGetById.js +4 -3
  78. package/funcs/customMessagesGetById.js.map +1 -1
  79. package/funcs/customMessagesList.d.ts.map +1 -1
  80. package/funcs/customMessagesList.js +4 -3
  81. package/funcs/customMessagesList.js.map +1 -1
  82. package/funcs/customMessagesUpdate.d.ts.map +1 -1
  83. package/funcs/customMessagesUpdate.js +4 -3
  84. package/funcs/customMessagesUpdate.js.map +1 -1
  85. package/funcs/dashboardsPostSessionEventsDashboard.d.ts.map +1 -1
  86. package/funcs/dashboardsPostSessionEventsDashboard.js +4 -3
  87. package/funcs/dashboardsPostSessionEventsDashboard.js.map +1 -1
  88. package/funcs/dashboardsPostSessionSummaryDashboard.d.ts.map +1 -1
  89. package/funcs/dashboardsPostSessionSummaryDashboard.js +4 -3
  90. package/funcs/dashboardsPostSessionSummaryDashboard.js.map +1 -1
  91. package/funcs/dashboardsPostSessionTransfersDashboard.d.ts.map +1 -1
  92. package/funcs/dashboardsPostSessionTransfersDashboard.js +4 -3
  93. package/funcs/dashboardsPostSessionTransfersDashboard.js.map +1 -1
  94. package/funcs/dashboardsPostSessionsDashboard.d.ts.map +1 -1
  95. package/funcs/dashboardsPostSessionsDashboard.js +4 -3
  96. package/funcs/dashboardsPostSessionsDashboard.js.map +1 -1
  97. package/funcs/eventsList.d.ts.map +1 -1
  98. package/funcs/eventsList.js +4 -3
  99. package/funcs/eventsList.js.map +1 -1
  100. package/funcs/promptsCreate.d.ts +1 -1
  101. package/funcs/promptsCreate.d.ts.map +1 -1
  102. package/funcs/promptsCreate.js +5 -4
  103. package/funcs/promptsCreate.js.map +1 -1
  104. package/funcs/promptsDelete.d.ts.map +1 -1
  105. package/funcs/promptsDelete.js +4 -3
  106. package/funcs/promptsDelete.js.map +1 -1
  107. package/funcs/promptsGetById.d.ts +1 -1
  108. package/funcs/promptsGetById.d.ts.map +1 -1
  109. package/funcs/promptsGetById.js +4 -3
  110. package/funcs/promptsGetById.js.map +1 -1
  111. package/funcs/promptsList.d.ts +1 -1
  112. package/funcs/promptsList.d.ts.map +1 -1
  113. package/funcs/promptsList.js +4 -3
  114. package/funcs/promptsList.js.map +1 -1
  115. package/funcs/promptsPromptsHistory.d.ts.map +1 -1
  116. package/funcs/promptsPromptsHistory.js +4 -3
  117. package/funcs/promptsPromptsHistory.js.map +1 -1
  118. package/funcs/promptsUpdate.d.ts +1 -1
  119. package/funcs/promptsUpdate.d.ts.map +1 -1
  120. package/funcs/promptsUpdate.js +5 -4
  121. package/funcs/promptsUpdate.js.map +1 -1
  122. package/funcs/servicesCreate.d.ts.map +1 -1
  123. package/funcs/servicesCreate.js +4 -3
  124. package/funcs/servicesCreate.js.map +1 -1
  125. package/funcs/servicesList.d.ts.map +1 -1
  126. package/funcs/servicesList.js +4 -3
  127. package/funcs/servicesList.js.map +1 -1
  128. package/funcs/servicesUpdate.d.ts.map +1 -1
  129. package/funcs/servicesUpdate.js +4 -3
  130. package/funcs/servicesUpdate.js.map +1 -1
  131. package/funcs/sessionLabelsCreate.d.ts.map +1 -1
  132. package/funcs/sessionLabelsCreate.js +4 -3
  133. package/funcs/sessionLabelsCreate.js.map +1 -1
  134. package/funcs/sessionLabelsGetById.d.ts.map +1 -1
  135. package/funcs/sessionLabelsGetById.js +4 -3
  136. package/funcs/sessionLabelsGetById.js.map +1 -1
  137. package/funcs/sessionLabelsList.d.ts.map +1 -1
  138. package/funcs/sessionLabelsList.js +4 -3
  139. package/funcs/sessionLabelsList.js.map +1 -1
  140. package/funcs/sessionsGenerateSessionRecordingUrls.d.ts.map +1 -1
  141. package/funcs/sessionsGenerateSessionRecordingUrls.js +4 -3
  142. package/funcs/sessionsGenerateSessionRecordingUrls.js.map +1 -1
  143. package/funcs/sessionsGetById.d.ts.map +1 -1
  144. package/funcs/sessionsGetById.js +4 -3
  145. package/funcs/sessionsGetById.js.map +1 -1
  146. package/funcs/sessionsList.d.ts.map +1 -1
  147. package/funcs/sessionsList.js +4 -3
  148. package/funcs/sessionsList.js.map +1 -1
  149. package/funcs/sessionsSessionRecordingStream.d.ts.map +1 -1
  150. package/funcs/sessionsSessionRecordingStream.js +4 -3
  151. package/funcs/sessionsSessionRecordingStream.js.map +1 -1
  152. package/funcs/sessionsTranscriptGetById.d.ts.map +1 -1
  153. package/funcs/sessionsTranscriptGetById.js +4 -3
  154. package/funcs/sessionsTranscriptGetById.js.map +1 -1
  155. package/funcs/toolsCreate.d.ts +1 -1
  156. package/funcs/toolsCreate.d.ts.map +1 -1
  157. package/funcs/toolsCreate.js +5 -4
  158. package/funcs/toolsCreate.js.map +1 -1
  159. package/funcs/toolsGetByName.d.ts.map +1 -1
  160. package/funcs/toolsGetByName.js +4 -3
  161. package/funcs/toolsGetByName.js.map +1 -1
  162. package/funcs/toolsList.d.ts +1 -1
  163. package/funcs/toolsList.d.ts.map +1 -1
  164. package/funcs/toolsList.js +4 -3
  165. package/funcs/toolsList.js.map +1 -1
  166. package/funcs/toolsUpdate.d.ts +1 -1
  167. package/funcs/toolsUpdate.d.ts.map +1 -1
  168. package/funcs/toolsUpdate.js +5 -4
  169. package/funcs/toolsUpdate.js.map +1 -1
  170. package/funcs/v1PostSessionEventsDashboard.d.ts.map +1 -1
  171. package/funcs/v1PostSessionEventsDashboard.js +4 -3
  172. package/funcs/v1PostSessionEventsDashboard.js.map +1 -1
  173. package/funcs/v1PostSessionSummaryDashboard.d.ts.map +1 -1
  174. package/funcs/v1PostSessionSummaryDashboard.js +4 -3
  175. package/funcs/v1PostSessionSummaryDashboard.js.map +1 -1
  176. package/funcs/v1PostSessionTransfersDashboard.d.ts.map +1 -1
  177. package/funcs/v1PostSessionTransfersDashboard.js +4 -3
  178. package/funcs/v1PostSessionTransfersDashboard.js.map +1 -1
  179. package/funcs/v1PostSessionsDashboard.d.ts.map +1 -1
  180. package/funcs/v1PostSessionsDashboard.js +4 -3
  181. package/funcs/v1PostSessionsDashboard.js.map +1 -1
  182. package/jsr.json +27 -0
  183. package/lib/config.d.ts +3 -3
  184. package/lib/config.js +3 -3
  185. package/lib/config.js.map +1 -1
  186. package/lib/encodings.d.ts +10 -9
  187. package/lib/encodings.d.ts.map +1 -1
  188. package/lib/encodings.js +73 -47
  189. package/lib/encodings.js.map +1 -1
  190. package/lib/primitives.d.ts +1 -0
  191. package/lib/primitives.d.ts.map +1 -1
  192. package/lib/primitives.js +10 -0
  193. package/lib/primitives.js.map +1 -1
  194. package/lib/sdks.d.ts.map +1 -1
  195. package/lib/sdks.js +4 -1
  196. package/lib/sdks.js.map +1 -1
  197. package/mintlify/mint-backup.json +290 -0
  198. package/mintlify/mint.json +289 -0
  199. package/models/components/agentcreate.d.ts +66 -16
  200. package/models/components/agentcreate.d.ts.map +1 -1
  201. package/models/components/agentcreate.js +34 -11
  202. package/models/components/agentcreate.js.map +1 -1
  203. package/models/components/agentresponse.d.ts +43 -27
  204. package/models/components/agentresponse.d.ts.map +1 -1
  205. package/models/components/agentresponse.js +17 -17
  206. package/models/components/agentresponse.js.map +1 -1
  207. package/models/components/agenttooldefaults.d.ts +9 -0
  208. package/models/components/agenttooldefaults.d.ts.map +1 -1
  209. package/models/components/agenttooldefaults.js.map +1 -1
  210. package/models/components/agenttoolfielddefault.d.ts +9 -0
  211. package/models/components/agenttoolfielddefault.d.ts.map +1 -1
  212. package/models/components/agenttoolfielddefault.js.map +1 -1
  213. package/models/components/agentupdate.d.ts +67 -17
  214. package/models/components/agentupdate.d.ts.map +1 -1
  215. package/models/components/agentupdate.js +34 -11
  216. package/models/components/agentupdate.js.map +1 -1
  217. package/models/components/agentvoice.d.ts +12 -0
  218. package/models/components/agentvoice.d.ts.map +1 -1
  219. package/models/components/agentvoice.js.map +1 -1
  220. package/models/components/agentvoicevarname.d.ts +6 -0
  221. package/models/components/agentvoicevarname.d.ts.map +1 -1
  222. package/models/components/agentvoicevarname.js +3 -0
  223. package/models/components/agentvoicevarname.js.map +1 -1
  224. package/models/components/channel.d.ts +4 -1
  225. package/models/components/channel.d.ts.map +1 -1
  226. package/models/components/channel.js.map +1 -1
  227. package/models/components/channelservices.d.ts +6 -0
  228. package/models/components/channelservices.d.ts.map +1 -1
  229. package/models/components/channelservices.js +3 -0
  230. package/models/components/channelservices.js.map +1 -1
  231. package/models/components/channeltargetcreaterequest.d.ts +22 -3
  232. package/models/components/channeltargetcreaterequest.d.ts.map +1 -1
  233. package/models/components/channeltargetcreaterequest.js +7 -6
  234. package/models/components/channeltargetcreaterequest.js.map +1 -1
  235. package/models/components/channeltargetresponse.d.ts +90 -0
  236. package/models/components/channeltargetresponse.d.ts.map +1 -0
  237. package/models/components/{channeltarget.js → channeltargetresponse.js} +37 -36
  238. package/models/components/channeltargetresponse.js.map +1 -0
  239. package/models/components/channeltargetupdaterequest.d.ts +27 -5
  240. package/models/components/channeltargetupdaterequest.d.ts.map +1 -1
  241. package/models/components/channeltargetupdaterequest.js +9 -8
  242. package/models/components/channeltargetupdaterequest.js.map +1 -1
  243. package/models/components/conversation.d.ts +42 -0
  244. package/models/components/conversation.d.ts.map +1 -1
  245. package/models/components/conversation.js.map +1 -1
  246. package/models/components/custommessagecreaterequest.d.ts +3 -3
  247. package/models/components/custommessagecreaterequest.d.ts.map +1 -1
  248. package/models/components/custommessagecreaterequest.js +3 -3
  249. package/models/components/custommessagecreaterequest.js.map +1 -1
  250. package/models/components/custommessageresponse.d.ts +11 -3
  251. package/models/components/custommessageresponse.d.ts.map +1 -1
  252. package/models/components/custommessageresponse.js +3 -3
  253. package/models/components/custommessageresponse.js.map +1 -1
  254. package/models/components/{daocustommessagerule.d.ts → custommessagerule.d.ts} +14 -14
  255. package/models/components/custommessagerule.d.ts.map +1 -0
  256. package/models/components/{daocustommessagerule.js → custommessagerule.js} +17 -17
  257. package/models/components/custommessagerule.js.map +1 -0
  258. package/models/components/custommessageupdaterequest.d.ts +3 -3
  259. package/models/components/custommessageupdaterequest.d.ts.map +1 -1
  260. package/models/components/custommessageupdaterequest.js +3 -3
  261. package/models/components/custommessageupdaterequest.js.map +1 -1
  262. package/models/components/dashboard.d.ts +15 -0
  263. package/models/components/dashboard.d.ts.map +1 -1
  264. package/models/components/dashboard.js.map +1 -1
  265. package/models/components/event.d.ts +33 -0
  266. package/models/components/event.d.ts.map +1 -1
  267. package/models/components/event.js.map +1 -1
  268. package/models/components/index.d.ts +19 -27
  269. package/models/components/index.d.ts.map +1 -1
  270. package/models/components/index.js +19 -27
  271. package/models/components/index.js.map +1 -1
  272. package/models/components/internaltool.d.ts +46 -0
  273. package/models/components/internaltool.d.ts.map +1 -0
  274. package/models/components/{sdkinternaltool.js → internaltool.js} +20 -20
  275. package/models/components/internaltool.js.map +1 -0
  276. package/models/components/listresponsechanneltargetresponse.d.ts +38 -0
  277. package/models/components/listresponsechanneltargetresponse.d.ts.map +1 -0
  278. package/models/components/{listresponsedirectorymember.js → listresponsechanneltargetresponse.js} +20 -20
  279. package/models/components/listresponsechanneltargetresponse.js.map +1 -0
  280. package/models/components/listresponsepromptresponse.d.ts +38 -0
  281. package/models/components/listresponsepromptresponse.d.ts.map +1 -0
  282. package/models/components/{listresponsechanneltarget.js → listresponsepromptresponse.js} +20 -20
  283. package/models/components/listresponsepromptresponse.js.map +1 -0
  284. package/models/components/listresponsetoolresponse.d.ts +38 -0
  285. package/models/components/listresponsetoolresponse.d.ts.map +1 -0
  286. package/models/components/{listresponseprompt.js → listresponsetoolresponse.js} +20 -20
  287. package/models/components/listresponsetoolresponse.js.map +1 -0
  288. package/models/components/promptcreaterequest.d.ts +55 -0
  289. package/models/components/promptcreaterequest.d.ts.map +1 -0
  290. package/models/components/{promptcreate.js → promptcreaterequest.js} +20 -20
  291. package/models/components/promptcreaterequest.js.map +1 -0
  292. package/models/components/prompthistory.d.ts +35 -8
  293. package/models/components/prompthistory.d.ts.map +1 -1
  294. package/models/components/prompthistory.js +8 -8
  295. package/models/components/prompthistory.js.map +1 -1
  296. package/models/components/promptllmconfig.d.ts +48 -0
  297. package/models/components/promptllmconfig.d.ts.map +1 -0
  298. package/models/components/{llmconfig.js → promptllmconfig.js} +20 -20
  299. package/models/components/promptllmconfig.js.map +1 -0
  300. package/models/components/{provider.d.ts → promptllmprovider.d.ts} +8 -8
  301. package/models/components/promptllmprovider.d.ts.map +1 -0
  302. package/models/components/{provider.js → promptllmprovider.js} +12 -13
  303. package/models/components/promptllmprovider.js.map +1 -0
  304. package/models/components/promptresponse.d.ts +87 -0
  305. package/models/components/promptresponse.d.ts.map +1 -0
  306. package/models/components/{prompt.js → promptresponse.js} +20 -21
  307. package/models/components/promptresponse.js.map +1 -0
  308. package/models/components/promptupdaterequest.d.ts +65 -0
  309. package/models/components/promptupdaterequest.d.ts.map +1 -0
  310. package/models/components/{promptupdate.js → promptupdaterequest.js} +20 -20
  311. package/models/components/promptupdaterequest.js.map +1 -0
  312. package/models/components/service.d.ts +4 -1
  313. package/models/components/service.d.ts.map +1 -1
  314. package/models/components/service.js.map +1 -1
  315. package/models/components/session.d.ts +60 -0
  316. package/models/components/session.d.ts.map +1 -1
  317. package/models/components/session.js.map +1 -1
  318. package/models/components/sessionaction.d.ts +15 -0
  319. package/models/components/sessionaction.d.ts.map +1 -1
  320. package/models/components/sessionaction.js.map +1 -1
  321. package/models/components/sessionlabel.d.ts +25 -1
  322. package/models/components/sessionlabel.d.ts.map +1 -1
  323. package/models/components/sessionlabel.js.map +1 -1
  324. package/models/components/sessionlabelcreate.d.ts +18 -0
  325. package/models/components/sessionlabelcreate.d.ts.map +1 -1
  326. package/models/components/sessionlabelcreate.js.map +1 -1
  327. package/models/components/sessionrecordingresponse.d.ts +12 -0
  328. package/models/components/sessionrecordingresponse.d.ts.map +1 -1
  329. package/models/components/sessionrecordingresponse.js.map +1 -1
  330. package/models/components/sessiontext.d.ts +15 -0
  331. package/models/components/sessiontext.d.ts.map +1 -1
  332. package/models/components/sessiontext.js.map +1 -1
  333. package/models/components/sessiontranscriptionresponse.d.ts +12 -0
  334. package/models/components/sessiontranscriptionresponse.d.ts.map +1 -1
  335. package/models/components/sessiontranscriptionresponse.js.map +1 -1
  336. package/models/components/sttprovider.d.ts +6 -0
  337. package/models/components/sttprovider.d.ts.map +1 -1
  338. package/models/components/sttprovider.js +3 -0
  339. package/models/components/sttprovider.js.map +1 -1
  340. package/models/components/targetmodes.d.ts +6 -0
  341. package/models/components/targetmodes.d.ts.map +1 -1
  342. package/models/components/targetmodes.js +3 -0
  343. package/models/components/targetmodes.js.map +1 -1
  344. package/models/components/testmessage.d.ts +21 -0
  345. package/models/components/testmessage.d.ts.map +1 -1
  346. package/models/components/testmessage.js.map +1 -1
  347. package/models/components/testmessageresponse.d.ts +19 -4
  348. package/models/components/testmessageresponse.d.ts.map +1 -1
  349. package/models/components/testmessageresponse.js +4 -4
  350. package/models/components/testmessageresponse.js.map +1 -1
  351. package/models/components/toolargumentlocation.d.ts +52 -0
  352. package/models/components/toolargumentlocation.d.ts.map +1 -0
  353. package/models/components/{custommessage.js → toolargumentlocation.js} +26 -28
  354. package/models/components/toolargumentlocation.js.map +1 -0
  355. package/models/components/toolcreaterequest.d.ts +132 -0
  356. package/models/components/toolcreaterequest.d.ts.map +1 -0
  357. package/models/components/{toolcreate.js → toolcreaterequest.js} +20 -20
  358. package/models/components/toolcreaterequest.js.map +1 -0
  359. package/models/components/{sdktooldefinition.d.ts → tooldefinition.d.ts} +113 -21
  360. package/models/components/tooldefinition.d.ts.map +1 -0
  361. package/models/components/{sdktooldefinition.js → tooldefinition.js} +23 -23
  362. package/models/components/tooldefinition.js.map +1 -0
  363. package/models/components/{function.d.ts → toolfunction.d.ts} +15 -15
  364. package/models/components/toolfunction.d.ts.map +1 -0
  365. package/models/components/{function.js → toolfunction.js} +17 -17
  366. package/models/components/toolfunction.js.map +1 -0
  367. package/models/components/toolhttpendpoint.d.ts +53 -0
  368. package/models/components/toolhttpendpoint.d.ts.map +1 -0
  369. package/models/components/toolhttpendpoint.js +74 -0
  370. package/models/components/toolhttpendpoint.js.map +1 -0
  371. package/models/components/toolhttpmethod.d.ts +34 -0
  372. package/models/components/toolhttpmethod.d.ts.map +1 -0
  373. package/models/components/{directorymemberproperties.js → toolhttpmethod.js} +17 -18
  374. package/models/components/toolhttpmethod.js.map +1 -0
  375. package/models/components/toolparameterdefault.d.ts +2 -2
  376. package/models/components/toolparametertransform.d.ts +4 -4
  377. package/models/components/toolparametertransform.js +1 -1
  378. package/models/components/toolparametertransformcondition.d.ts +1 -1
  379. package/models/components/toolresponse.d.ts +149 -0
  380. package/models/components/toolresponse.d.ts.map +1 -0
  381. package/models/components/{tool.js → toolresponse.js} +20 -21
  382. package/models/components/toolresponse.js.map +1 -0
  383. package/models/components/toolupdaterequest.d.ts +137 -0
  384. package/models/components/toolupdaterequest.d.ts.map +1 -0
  385. package/models/components/{toolupdate.js → toolupdaterequest.js} +20 -20
  386. package/models/components/toolupdaterequest.js.map +1 -0
  387. package/models/operations/index.d.ts +0 -4
  388. package/models/operations/index.d.ts.map +1 -1
  389. package/models/operations/index.js +0 -4
  390. package/models/operations/index.js.map +1 -1
  391. package/openapi-final.json +3083 -0
  392. package/openapi.json +8479 -0
  393. package/package.json +1 -1
  394. package/sdk/agents.d.ts +2 -2
  395. package/sdk/agents.d.ts.map +1 -1
  396. package/sdk/prompts.d.ts +4 -4
  397. package/sdk/prompts.d.ts.map +1 -1
  398. package/sdk/prompts.js.map +1 -1
  399. package/sdk/sdk.d.ts +0 -3
  400. package/sdk/sdk.d.ts.map +1 -1
  401. package/sdk/sdk.js +0 -4
  402. package/sdk/sdk.js.map +1 -1
  403. package/sdk/targets.d.ts +4 -4
  404. package/sdk/targets.d.ts.map +1 -1
  405. package/sdk/tools.d.ts +3 -3
  406. package/sdk/tools.d.ts.map +1 -1
  407. package/sdk/tools.js.map +1 -1
  408. package/src/funcs/agentsAgentGetAvailableVoices.ts +5 -3
  409. package/src/funcs/agentsCreate.ts +8 -6
  410. package/src/funcs/agentsDelete.ts +5 -3
  411. package/src/funcs/agentsGetById.ts +5 -3
  412. package/src/funcs/agentsList.ts +5 -3
  413. package/src/funcs/agentsTestSendTestMessage.ts +5 -3
  414. package/src/funcs/agentsUpdate.ts +8 -6
  415. package/src/funcs/channelsDelete.ts +5 -3
  416. package/src/funcs/channelsList.ts +5 -3
  417. package/src/funcs/channelsTargetsAvailableTargets.ts +5 -3
  418. package/src/funcs/channelsTargetsCreate.ts +8 -6
  419. package/src/funcs/channelsTargetsGetById.ts +8 -6
  420. package/src/funcs/channelsTargetsList.ts +8 -6
  421. package/src/funcs/channelsTargetsUpdate.ts +8 -6
  422. package/src/funcs/conversationsList.ts +5 -3
  423. package/src/funcs/customMessagesCreate.ts +5 -3
  424. package/src/funcs/customMessagesDelete.ts +5 -3
  425. package/src/funcs/customMessagesGetById.ts +5 -3
  426. package/src/funcs/customMessagesList.ts +5 -3
  427. package/src/funcs/customMessagesUpdate.ts +5 -3
  428. package/src/funcs/dashboardsPostSessionEventsDashboard.ts +5 -3
  429. package/src/funcs/dashboardsPostSessionSummaryDashboard.ts +5 -3
  430. package/src/funcs/dashboardsPostSessionTransfersDashboard.ts +5 -3
  431. package/src/funcs/dashboardsPostSessionsDashboard.ts +5 -3
  432. package/src/funcs/eventsList.ts +5 -3
  433. package/src/funcs/promptsCreate.ts +10 -8
  434. package/src/funcs/promptsDelete.ts +5 -3
  435. package/src/funcs/promptsGetById.ts +8 -6
  436. package/src/funcs/promptsList.ts +8 -6
  437. package/src/funcs/promptsPromptsHistory.ts +5 -3
  438. package/src/funcs/promptsUpdate.ts +10 -8
  439. package/src/funcs/servicesCreate.ts +5 -3
  440. package/src/funcs/servicesList.ts +5 -3
  441. package/src/funcs/servicesUpdate.ts +5 -3
  442. package/src/funcs/sessionLabelsCreate.ts +5 -3
  443. package/src/funcs/sessionLabelsGetById.ts +5 -3
  444. package/src/funcs/sessionLabelsList.ts +5 -3
  445. package/src/funcs/sessionsGenerateSessionRecordingUrls.ts +5 -3
  446. package/src/funcs/sessionsGetById.ts +5 -3
  447. package/src/funcs/sessionsList.ts +5 -3
  448. package/src/funcs/sessionsSessionRecordingStream.ts +5 -3
  449. package/src/funcs/sessionsTranscriptGetById.ts +5 -3
  450. package/src/funcs/toolsCreate.ts +10 -8
  451. package/src/funcs/toolsGetByName.ts +5 -3
  452. package/src/funcs/toolsList.ts +8 -6
  453. package/src/funcs/toolsUpdate.ts +10 -8
  454. package/src/funcs/v1PostSessionEventsDashboard.ts +5 -3
  455. package/src/funcs/v1PostSessionSummaryDashboard.ts +5 -3
  456. package/src/funcs/v1PostSessionTransfersDashboard.ts +5 -3
  457. package/src/funcs/v1PostSessionsDashboard.ts +5 -3
  458. package/src/lib/config.ts +3 -3
  459. package/src/lib/encodings.ts +95 -61
  460. package/src/lib/primitives.ts +14 -0
  461. package/src/lib/sdks.ts +4 -1
  462. package/src/models/components/agentcreate.ts +99 -20
  463. package/src/models/components/agentresponse.ts +73 -53
  464. package/src/models/components/agenttooldefaults.ts +9 -0
  465. package/src/models/components/agenttoolfielddefault.ts +9 -0
  466. package/src/models/components/agentupdate.ts +104 -21
  467. package/src/models/components/agentvoice.ts +12 -0
  468. package/src/models/components/agentvoicevarname.ts +6 -0
  469. package/src/models/components/channel.ts +4 -1
  470. package/src/models/components/channelservices.ts +6 -0
  471. package/src/models/components/channeltargetcreaterequest.ts +32 -9
  472. package/src/models/components/channeltargetresponse.ts +179 -0
  473. package/src/models/components/channeltargetupdaterequest.ts +39 -13
  474. package/src/models/components/conversation.ts +42 -0
  475. package/src/models/components/custommessagecreaterequest.ts +9 -9
  476. package/src/models/components/custommessageresponse.ts +17 -9
  477. package/src/models/components/{daocustommessagerule.ts → custommessagerule.ts} +21 -21
  478. package/src/models/components/custommessageupdaterequest.ts +9 -9
  479. package/src/models/components/dashboard.ts +15 -0
  480. package/src/models/components/event.ts +33 -0
  481. package/src/models/components/index.ts +19 -27
  482. package/src/models/components/internaltool.ts +86 -0
  483. package/src/models/components/listresponsechanneltargetresponse.ts +104 -0
  484. package/src/models/components/{listresponsechanneltarget.ts → listresponsepromptresponse.ts} +30 -30
  485. package/src/models/components/{listresponseprompt.ts → listresponsetoolresponse.ts} +30 -30
  486. package/src/models/components/{promptcreate.ts → promptcreaterequest.ts} +35 -31
  487. package/src/models/components/prompthistory.ts +43 -16
  488. package/src/models/components/{llmconfig.ts → promptllmconfig.ts} +29 -27
  489. package/src/models/components/promptllmprovider.ts +39 -0
  490. package/src/models/components/promptresponse.ts +162 -0
  491. package/src/models/components/{promptupdate.ts → promptupdaterequest.ts} +37 -33
  492. package/src/models/components/service.ts +4 -1
  493. package/src/models/components/session.ts +60 -0
  494. package/src/models/components/sessionaction.ts +15 -0
  495. package/src/models/components/sessionlabel.ts +25 -1
  496. package/src/models/components/sessionlabelcreate.ts +18 -0
  497. package/src/models/components/sessionrecordingresponse.ts +12 -0
  498. package/src/models/components/sessiontext.ts +15 -0
  499. package/src/models/components/sessiontranscriptionresponse.ts +12 -0
  500. package/src/models/components/sttprovider.ts +6 -0
  501. package/src/models/components/targetmodes.ts +6 -0
  502. package/src/models/components/testmessage.ts +21 -0
  503. package/src/models/components/testmessageresponse.ts +23 -8
  504. package/src/models/components/toolargumentlocation.ts +53 -0
  505. package/src/models/components/toolcreaterequest.ts +187 -0
  506. package/src/models/components/{sdktooldefinition.ts → tooldefinition.ts} +131 -43
  507. package/src/models/components/{function.ts → toolfunction.ts} +21 -21
  508. package/src/models/components/toolhttpendpoint.ts +111 -0
  509. package/src/models/components/toolhttpmethod.ts +39 -0
  510. package/src/models/components/toolparameterdefault.ts +2 -2
  511. package/src/models/components/toolparametertransform.ts +4 -4
  512. package/src/models/components/toolparametertransformcondition.ts +1 -1
  513. package/src/models/components/toolresponse.ts +206 -0
  514. package/src/models/components/toolupdaterequest.ts +194 -0
  515. package/src/models/operations/index.ts +0 -4
  516. package/src/sdk/agents.ts +2 -2
  517. package/src/sdk/prompts.ts +6 -6
  518. package/src/sdk/sdk.ts +0 -6
  519. package/src/sdk/targets.ts +4 -4
  520. package/src/sdk/tools.ts +5 -5
  521. package/tsconfig.json +41 -0
  522. package/docs/sdks/directory/README.md +0 -559
  523. package/funcs/directoryCreate.d.ts +0 -16
  524. package/funcs/directoryCreate.d.ts.map +0 -1
  525. package/funcs/directoryCreate.js +0 -100
  526. package/funcs/directoryCreate.js.map +0 -1
  527. package/funcs/directoryDelete.d.ts +0 -16
  528. package/funcs/directoryDelete.d.ts.map +0 -1
  529. package/funcs/directoryDelete.js +0 -106
  530. package/funcs/directoryDelete.js.map +0 -1
  531. package/funcs/directoryDirectoryMemberBulkLoad.d.ts +0 -16
  532. package/funcs/directoryDirectoryMemberBulkLoad.d.ts.map +0 -1
  533. package/funcs/directoryDirectoryMemberBulkLoad.js +0 -113
  534. package/funcs/directoryDirectoryMemberBulkLoad.js.map +0 -1
  535. package/funcs/directoryDirectoryMemberDownload.d.ts +0 -14
  536. package/funcs/directoryDirectoryMemberDownload.d.ts.map +0 -1
  537. package/funcs/directoryDirectoryMemberDownload.js +0 -86
  538. package/funcs/directoryDirectoryMemberDownload.js.map +0 -1
  539. package/funcs/directoryGetById.d.ts +0 -17
  540. package/funcs/directoryGetById.d.ts.map +0 -1
  541. package/funcs/directoryGetById.js +0 -106
  542. package/funcs/directoryGetById.js.map +0 -1
  543. package/funcs/directoryList.d.ts +0 -17
  544. package/funcs/directoryList.d.ts.map +0 -1
  545. package/funcs/directoryList.js +0 -112
  546. package/funcs/directoryList.js.map +0 -1
  547. package/funcs/directoryUpdate.d.ts +0 -17
  548. package/funcs/directoryUpdate.d.ts.map +0 -1
  549. package/funcs/directoryUpdate.js +0 -107
  550. package/funcs/directoryUpdate.js.map +0 -1
  551. package/models/components/agent.d.ts +0 -70
  552. package/models/components/agent.d.ts.map +0 -1
  553. package/models/components/agent.js +0 -111
  554. package/models/components/agent.js.map +0 -1
  555. package/models/components/bodydirectorymemberbulkload.d.ts +0 -56
  556. package/models/components/bodydirectorymemberbulkload.d.ts.map +0 -1
  557. package/models/components/bodydirectorymemberbulkload.js +0 -100
  558. package/models/components/bodydirectorymemberbulkload.js.map +0 -1
  559. package/models/components/channeltarget.d.ts +0 -53
  560. package/models/components/channeltarget.d.ts.map +0 -1
  561. package/models/components/channeltarget.js.map +0 -1
  562. package/models/components/custommessage.d.ts +0 -42
  563. package/models/components/custommessage.d.ts.map +0 -1
  564. package/models/components/custommessage.js.map +0 -1
  565. package/models/components/daochanneltargetagent.d.ts +0 -47
  566. package/models/components/daochanneltargetagent.d.ts.map +0 -1
  567. package/models/components/daochanneltargetagent.js +0 -92
  568. package/models/components/daochanneltargetagent.js.map +0 -1
  569. package/models/components/daocustommessagerule.d.ts.map +0 -1
  570. package/models/components/daocustommessagerule.js.map +0 -1
  571. package/models/components/directoryextension.d.ts +0 -52
  572. package/models/components/directoryextension.d.ts.map +0 -1
  573. package/models/components/directoryextension.js +0 -84
  574. package/models/components/directoryextension.js.map +0 -1
  575. package/models/components/directorymember.d.ts +0 -63
  576. package/models/components/directorymember.d.ts.map +0 -1
  577. package/models/components/directorymember.js +0 -108
  578. package/models/components/directorymember.js.map +0 -1
  579. package/models/components/directorymembercreate.d.ts +0 -61
  580. package/models/components/directorymembercreate.d.ts.map +0 -1
  581. package/models/components/directorymembercreate.js +0 -106
  582. package/models/components/directorymembercreate.js.map +0 -1
  583. package/models/components/directorymemberproperties.d.ts +0 -40
  584. package/models/components/directorymemberproperties.d.ts.map +0 -1
  585. package/models/components/directorymemberproperties.js.map +0 -1
  586. package/models/components/function.d.ts.map +0 -1
  587. package/models/components/function.js.map +0 -1
  588. package/models/components/httpendpoint.d.ts +0 -114
  589. package/models/components/httpendpoint.d.ts.map +0 -1
  590. package/models/components/httpendpoint.js +0 -119
  591. package/models/components/httpendpoint.js.map +0 -1
  592. package/models/components/listresponsechanneltarget.d.ts +0 -38
  593. package/models/components/listresponsechanneltarget.d.ts.map +0 -1
  594. package/models/components/listresponsechanneltarget.js.map +0 -1
  595. package/models/components/listresponsedirectorymember.d.ts +0 -38
  596. package/models/components/listresponsedirectorymember.d.ts.map +0 -1
  597. package/models/components/listresponsedirectorymember.js.map +0 -1
  598. package/models/components/listresponseprompt.d.ts +0 -38
  599. package/models/components/listresponseprompt.d.ts.map +0 -1
  600. package/models/components/listresponseprompt.js.map +0 -1
  601. package/models/components/listresponsetool.d.ts +0 -38
  602. package/models/components/listresponsetool.d.ts.map +0 -1
  603. package/models/components/listresponsetool.js +0 -81
  604. package/models/components/listresponsetool.js.map +0 -1
  605. package/models/components/llmconfig.d.ts +0 -48
  606. package/models/components/llmconfig.d.ts.map +0 -1
  607. package/models/components/llmconfig.js.map +0 -1
  608. package/models/components/prompt.d.ts +0 -80
  609. package/models/components/prompt.d.ts.map +0 -1
  610. package/models/components/prompt.js.map +0 -1
  611. package/models/components/promptcreate.d.ts +0 -55
  612. package/models/components/promptcreate.d.ts.map +0 -1
  613. package/models/components/promptcreate.js.map +0 -1
  614. package/models/components/promptupdate.d.ts +0 -65
  615. package/models/components/promptupdate.d.ts.map +0 -1
  616. package/models/components/promptupdate.js.map +0 -1
  617. package/models/components/provider.d.ts.map +0 -1
  618. package/models/components/provider.js.map +0 -1
  619. package/models/components/sdkinternaltool.d.ts +0 -46
  620. package/models/components/sdkinternaltool.d.ts.map +0 -1
  621. package/models/components/sdkinternaltool.js.map +0 -1
  622. package/models/components/sdktooldefinition.d.ts.map +0 -1
  623. package/models/components/sdktooldefinition.js.map +0 -1
  624. package/models/components/target.d.ts +0 -65
  625. package/models/components/target.d.ts.map +0 -1
  626. package/models/components/target.js +0 -94
  627. package/models/components/target.js.map +0 -1
  628. package/models/components/tool.d.ts +0 -50
  629. package/models/components/tool.d.ts.map +0 -1
  630. package/models/components/tool.js.map +0 -1
  631. package/models/components/toolcreate.d.ts +0 -40
  632. package/models/components/toolcreate.d.ts.map +0 -1
  633. package/models/components/toolcreate.js.map +0 -1
  634. package/models/components/toolupdate.d.ts +0 -45
  635. package/models/components/toolupdate.d.ts.map +0 -1
  636. package/models/components/toolupdate.js.map +0 -1
  637. package/models/operations/directorymemberdelete.d.ts +0 -29
  638. package/models/operations/directorymemberdelete.d.ts.map +0 -1
  639. package/models/operations/directorymemberdelete.js +0 -68
  640. package/models/operations/directorymemberdelete.js.map +0 -1
  641. package/models/operations/directorymembergetbyid.d.ts +0 -29
  642. package/models/operations/directorymembergetbyid.d.ts.map +0 -1
  643. package/models/operations/directorymembergetbyid.js +0 -68
  644. package/models/operations/directorymembergetbyid.js.map +0 -1
  645. package/models/operations/directorymemberlist.d.ts +0 -46
  646. package/models/operations/directorymemberlist.d.ts.map +0 -1
  647. package/models/operations/directorymemberlist.js +0 -101
  648. package/models/operations/directorymemberlist.js.map +0 -1
  649. package/models/operations/directorymemberupdate.d.ts +0 -32
  650. package/models/operations/directorymemberupdate.d.ts.map +0 -1
  651. package/models/operations/directorymemberupdate.js +0 -73
  652. package/models/operations/directorymemberupdate.js.map +0 -1
  653. package/sdk/directory.d.ts +0 -55
  654. package/sdk/directory.d.ts.map +0 -1
  655. package/sdk/directory.js +0 -82
  656. package/sdk/directory.js.map +0 -1
  657. package/src/funcs/directoryCreate.ts +0 -132
  658. package/src/funcs/directoryDelete.ts +0 -140
  659. package/src/funcs/directoryDirectoryMemberBulkLoad.ts +0 -149
  660. package/src/funcs/directoryDirectoryMemberDownload.ts +0 -108
  661. package/src/funcs/directoryGetById.ts +0 -140
  662. package/src/funcs/directoryList.ts +0 -146
  663. package/src/funcs/directoryUpdate.ts +0 -141
  664. package/src/models/components/agent.ts +0 -153
  665. package/src/models/components/bodydirectorymemberbulkload.ts +0 -134
  666. package/src/models/components/channeltarget.ts +0 -136
  667. package/src/models/components/custommessage.ts +0 -79
  668. package/src/models/components/daochanneltargetagent.ts +0 -117
  669. package/src/models/components/directoryextension.ts +0 -113
  670. package/src/models/components/directorymember.ts +0 -155
  671. package/src/models/components/directorymembercreate.ts +0 -163
  672. package/src/models/components/directorymemberproperties.ts +0 -39
  673. package/src/models/components/httpendpoint.ts +0 -158
  674. package/src/models/components/listresponsedirectorymember.ts +0 -103
  675. package/src/models/components/listresponsetool.ts +0 -101
  676. package/src/models/components/prompt.ts +0 -152
  677. package/src/models/components/provider.ts +0 -37
  678. package/src/models/components/sdkinternaltool.ts +0 -88
  679. package/src/models/components/target.ts +0 -132
  680. package/src/models/components/tool.ts +0 -101
  681. package/src/models/components/toolcreate.ts +0 -91
  682. package/src/models/components/toolupdate.ts +0 -98
  683. package/src/models/operations/directorymemberdelete.ts +0 -77
  684. package/src/models/operations/directorymembergetbyid.ts +0 -77
  685. package/src/models/operations/directorymemberlist.ts +0 -128
  686. package/src/models/operations/directorymemberupdate.ts +0 -84
  687. package/src/sdk/directory.ts +0 -134
@@ -0,0 +1,3083 @@
1
+ openapi: "3.1.0"
2
+ info:
3
+ title: "SyllableSDK"
4
+ description: "\n# Syllble Platform SDK\n\nSyllble SDK gives you the power of awesome AI agentry. \U0001F680\n\n## Overview\n\nThe Syllble SDK provides a comprehensive set of tools and APIs to integrate powerful AI capabilities into your applications. Whether you're building chatbots, virtual assistants, or any other AI-driven solutions, Syllble SDK has got you covered.\n\n## Features\n\n- **Natural Language Processing (NLP)**: Understand and generate human language with ease.\n- **Machine Learning Models**: Leverage pre-trained models or train your own custom models.\n- **Speech Recognition**: Convert speech to text and vice versa.\n- **Image Recognition**: Identify objects, faces, and scenes in images.\n- **Data Analytics**: Analyze and visualize data to gain insights.\n- **Integration**: Seamlessly integrate with other services and platforms.\n\n"
5
+ version: "0.0.2"
6
+ servers:
7
+ - url: "http://127.0.0.1:8001"
8
+ paths:
9
+ "/api/v1/agents/":
10
+ get:
11
+ tags:
12
+ - "agents"
13
+ summary: "Agent List"
14
+ description: "List the existing agents"
15
+ operationId: "agent_list"
16
+ security:
17
+ - APIKeyHeader: []
18
+ parameters:
19
+ - name: "page"
20
+ in: "query"
21
+ required: false
22
+ schema:
23
+ anyOf:
24
+ - type: "integer"
25
+ minimum: 0
26
+ - type: "null"
27
+ default: 0
28
+ title: "Page"
29
+ - name: "limit"
30
+ in: "query"
31
+ required: false
32
+ schema:
33
+ type: "integer"
34
+ minimum: 0
35
+ default: 25
36
+ title: "Limit"
37
+ - name: "search_fields"
38
+ in: "query"
39
+ required: false
40
+ schema:
41
+ type: "array"
42
+ items: {"$ref": "#/components/schemas/AgentProperties"}
43
+ default: []
44
+ title: "Search Fields"
45
+ - name: "search_field_values"
46
+ in: "query"
47
+ required: false
48
+ schema:
49
+ type: "array"
50
+ items:
51
+ type: "string"
52
+ default: []
53
+ title: "Search Field Values"
54
+ - name: "order_by"
55
+ in: "query"
56
+ required: false
57
+ schema:
58
+ allOf:
59
+ - {"$ref": "#/components/schemas/AgentProperties"}
60
+ title: "Order By"
61
+ - name: "order_by_direction"
62
+ in: "query"
63
+ required: false
64
+ schema:
65
+ allOf:
66
+ - {"$ref": "#/components/schemas/OrderByDirection"}
67
+ title: "Order By Direction"
68
+ - name: "fields"
69
+ in: "query"
70
+ required: false
71
+ schema:
72
+ anyOf:
73
+ - type: "array"
74
+ items: {"$ref": "#/components/schemas/AgentProperties"}
75
+ - type: "null"
76
+ title: "Fields"
77
+ - name: "start_datetime"
78
+ in: "query"
79
+ required: false
80
+ schema:
81
+ anyOf:
82
+ - type: "string"
83
+ - type: "null"
84
+ title: "Start Datetime"
85
+ - name: "end_datetime"
86
+ in: "query"
87
+ required: false
88
+ schema:
89
+ anyOf:
90
+ - type: "string"
91
+ - type: "null"
92
+ title: "End Datetime"
93
+ responses:
94
+ "200":
95
+ description: "Successful Response"
96
+ content:
97
+ "application/json":
98
+ schema: {"$ref": "#/components/schemas/ListResponse_Agent_"}
99
+ "422":
100
+ description: "Validation Error"
101
+ content:
102
+ "application/json":
103
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
104
+ post:
105
+ tags:
106
+ - "agents"
107
+ summary: "Create Agent"
108
+ description: "Create a new agent"
109
+ operationId: "agent_create"
110
+ security:
111
+ - APIKeyHeader: []
112
+ requestBody:
113
+ required: true
114
+ content:
115
+ "application/json":
116
+ schema: {"$ref": "#/components/schemas/AgentCreate"}
117
+ responses:
118
+ "200":
119
+ description: "Successful Response"
120
+ content:
121
+ "application/json":
122
+ schema: {"$ref": "#/components/schemas/Agent"}
123
+ "422":
124
+ description: "Validation Error"
125
+ content:
126
+ "application/json":
127
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
128
+ put:
129
+ tags:
130
+ - "agents"
131
+ summary: "Update Agent"
132
+ description: "Update an existing agent"
133
+ operationId: "agent_update"
134
+ security:
135
+ - APIKeyHeader: []
136
+ requestBody:
137
+ required: true
138
+ content:
139
+ "application/json":
140
+ schema: {"$ref": "#/components/schemas/Agent"}
141
+ responses:
142
+ "200":
143
+ description: "Successful Response"
144
+ content:
145
+ "application/json":
146
+ schema: {"$ref": "#/components/schemas/Agent"}
147
+ "422":
148
+ description: "Validation Error"
149
+ content:
150
+ "application/json":
151
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
152
+ "/api/v1/agents/{agent_id}":
153
+ get:
154
+ tags:
155
+ - "agents"
156
+ summary: "Get Agent By Id"
157
+ description: "Get an agent by ID."
158
+ operationId: "agent_get_by_id"
159
+ security:
160
+ - APIKeyHeader: []
161
+ parameters:
162
+ - name: "agent_id"
163
+ in: "path"
164
+ required: true
165
+ schema:
166
+ type: "integer"
167
+ title: "Agent Id"
168
+ responses:
169
+ "200":
170
+ description: "Successful Response"
171
+ content:
172
+ "application/json":
173
+ schema: {"$ref": "#/components/schemas/Agent"}
174
+ "422":
175
+ description: "Validation Error"
176
+ content:
177
+ "application/json":
178
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
179
+ delete:
180
+ tags:
181
+ - "agents"
182
+ summary: "Delete Agent"
183
+ description: "Delete an agent by ID"
184
+ operationId: "agent_delete"
185
+ security:
186
+ - APIKeyHeader: []
187
+ parameters:
188
+ - name: "agent_id"
189
+ in: "path"
190
+ required: true
191
+ schema:
192
+ type: "integer"
193
+ title: "Agent Id"
194
+ - name: "reason"
195
+ in: "query"
196
+ required: true
197
+ schema:
198
+ type: "string"
199
+ title: "Reason"
200
+ responses:
201
+ "200":
202
+ description: "Successful Response"
203
+ content:
204
+ "application/json":
205
+ schema: {}
206
+ "422":
207
+ description: "Validation Error"
208
+ content:
209
+ "application/json":
210
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
211
+ "/api/v1/channels/available-targets":
212
+ get:
213
+ tags:
214
+ - "channels.targets"
215
+ summary: "Available Targets List"
216
+ description: "List the available phone numbers"
217
+ operationId: "available_targets"
218
+ security:
219
+ - APIKeyHeader: []
220
+ parameters:
221
+ - name: "page"
222
+ in: "query"
223
+ required: false
224
+ schema:
225
+ anyOf:
226
+ - type: "integer"
227
+ minimum: 0
228
+ - type: "null"
229
+ default: 0
230
+ title: "Page"
231
+ - name: "limit"
232
+ in: "query"
233
+ required: false
234
+ schema:
235
+ type: "integer"
236
+ minimum: 0
237
+ default: 25
238
+ title: "Limit"
239
+ - name: "search_fields"
240
+ in: "query"
241
+ required: false
242
+ schema:
243
+ type: "array"
244
+ items: {"$ref": "#/components/schemas/AvailableTargetProperties"}
245
+ default: []
246
+ title: "Search Fields"
247
+ - name: "search_field_values"
248
+ in: "query"
249
+ required: false
250
+ schema:
251
+ type: "array"
252
+ items:
253
+ type: "string"
254
+ default: []
255
+ title: "Search Field Values"
256
+ - name: "order_by"
257
+ in: "query"
258
+ required: false
259
+ schema:
260
+ allOf:
261
+ - {"$ref": "#/components/schemas/AvailableTargetProperties"}
262
+ title: "Order By"
263
+ - name: "order_by_direction"
264
+ in: "query"
265
+ required: false
266
+ schema:
267
+ allOf:
268
+ - {"$ref": "#/components/schemas/OrderByDirection"}
269
+ title: "Order By Direction"
270
+ - name: "fields"
271
+ in: "query"
272
+ required: false
273
+ schema:
274
+ anyOf:
275
+ - type: "array"
276
+ items: {"$ref": "#/components/schemas/AvailableTargetProperties"}
277
+ - type: "null"
278
+ title: "Fields"
279
+ - name: "start_datetime"
280
+ in: "query"
281
+ required: false
282
+ schema:
283
+ anyOf:
284
+ - type: "string"
285
+ - type: "null"
286
+ title: "Start Datetime"
287
+ - name: "end_datetime"
288
+ in: "query"
289
+ required: false
290
+ schema:
291
+ anyOf:
292
+ - type: "string"
293
+ - type: "null"
294
+ title: "End Datetime"
295
+ responses:
296
+ "200":
297
+ description: "Successful Response"
298
+ content:
299
+ "application/json":
300
+ schema: {"$ref": "#/components/schemas/ListResponse_AvailableTarget_"}
301
+ "422":
302
+ description: "Validation Error"
303
+ content:
304
+ "application/json":
305
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
306
+ "/api/v1/channels/":
307
+ get:
308
+ tags:
309
+ - "channels"
310
+ summary: "Get Channels"
311
+ operationId: "channels_list"
312
+ security:
313
+ - APIKeyHeader: []
314
+ parameters:
315
+ - name: "page"
316
+ in: "query"
317
+ required: false
318
+ schema:
319
+ anyOf:
320
+ - type: "integer"
321
+ minimum: 0
322
+ - type: "null"
323
+ default: 0
324
+ title: "Page"
325
+ - name: "limit"
326
+ in: "query"
327
+ required: false
328
+ schema:
329
+ type: "integer"
330
+ minimum: 0
331
+ default: 25
332
+ title: "Limit"
333
+ - name: "search_fields"
334
+ in: "query"
335
+ required: false
336
+ schema:
337
+ type: "array"
338
+ items: {"$ref": "#/components/schemas/ChannelProperties"}
339
+ default: []
340
+ title: "Search Fields"
341
+ - name: "search_field_values"
342
+ in: "query"
343
+ required: false
344
+ schema:
345
+ type: "array"
346
+ items:
347
+ type: "string"
348
+ default: []
349
+ title: "Search Field Values"
350
+ - name: "order_by"
351
+ in: "query"
352
+ required: false
353
+ schema:
354
+ allOf:
355
+ - {"$ref": "#/components/schemas/ChannelProperties"}
356
+ title: "Order By"
357
+ - name: "order_by_direction"
358
+ in: "query"
359
+ required: false
360
+ schema:
361
+ allOf:
362
+ - {"$ref": "#/components/schemas/OrderByDirection"}
363
+ title: "Order By Direction"
364
+ - name: "fields"
365
+ in: "query"
366
+ required: false
367
+ schema:
368
+ anyOf:
369
+ - type: "array"
370
+ items: {"$ref": "#/components/schemas/ChannelProperties"}
371
+ - type: "null"
372
+ title: "Fields"
373
+ - name: "start_datetime"
374
+ in: "query"
375
+ required: false
376
+ schema:
377
+ anyOf:
378
+ - type: "string"
379
+ - type: "null"
380
+ title: "Start Datetime"
381
+ - name: "end_datetime"
382
+ in: "query"
383
+ required: false
384
+ schema:
385
+ anyOf:
386
+ - type: "string"
387
+ - type: "null"
388
+ title: "End Datetime"
389
+ responses:
390
+ "200":
391
+ description: "Successful Response"
392
+ content:
393
+ "application/json":
394
+ schema: {"$ref": "#/components/schemas/ListResponse_Channel_"}
395
+ "422":
396
+ description: "Validation Error"
397
+ content:
398
+ "application/json":
399
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
400
+ "/api/v1/channels/targets":
401
+ get:
402
+ tags:
403
+ - "channels.targets"
404
+ summary: "Get Channel Targets"
405
+ operationId: "channel_targets_list"
406
+ security:
407
+ - APIKeyHeader: []
408
+ parameters:
409
+ - name: "page"
410
+ in: "query"
411
+ required: false
412
+ schema:
413
+ anyOf:
414
+ - type: "integer"
415
+ minimum: 0
416
+ - type: "null"
417
+ default: 0
418
+ title: "Page"
419
+ - name: "limit"
420
+ in: "query"
421
+ required: false
422
+ schema:
423
+ type: "integer"
424
+ minimum: 0
425
+ default: 25
426
+ title: "Limit"
427
+ - name: "search_fields"
428
+ in: "query"
429
+ required: false
430
+ schema:
431
+ type: "array"
432
+ items: {"$ref": "#/components/schemas/ChannelTargetProperties"}
433
+ default: []
434
+ title: "Search Fields"
435
+ - name: "search_field_values"
436
+ in: "query"
437
+ required: false
438
+ schema:
439
+ type: "array"
440
+ items:
441
+ type: "string"
442
+ default: []
443
+ title: "Search Field Values"
444
+ - name: "order_by"
445
+ in: "query"
446
+ required: false
447
+ schema:
448
+ allOf:
449
+ - {"$ref": "#/components/schemas/ChannelTargetProperties"}
450
+ title: "Order By"
451
+ - name: "order_by_direction"
452
+ in: "query"
453
+ required: false
454
+ schema:
455
+ allOf:
456
+ - {"$ref": "#/components/schemas/OrderByDirection"}
457
+ title: "Order By Direction"
458
+ - name: "fields"
459
+ in: "query"
460
+ required: false
461
+ schema:
462
+ anyOf:
463
+ - type: "array"
464
+ items: {"$ref": "#/components/schemas/ChannelTargetProperties"}
465
+ - type: "null"
466
+ title: "Fields"
467
+ - name: "start_datetime"
468
+ in: "query"
469
+ required: false
470
+ schema:
471
+ anyOf:
472
+ - type: "string"
473
+ - type: "null"
474
+ title: "Start Datetime"
475
+ - name: "end_datetime"
476
+ in: "query"
477
+ required: false
478
+ schema:
479
+ anyOf:
480
+ - type: "string"
481
+ - type: "null"
482
+ title: "End Datetime"
483
+ responses:
484
+ "200":
485
+ description: "Successful Response"
486
+ content:
487
+ "application/json":
488
+ schema: {"$ref": "#/components/schemas/ListResponse_ChannelTarget_"}
489
+ "422":
490
+ description: "Validation Error"
491
+ content:
492
+ "application/json":
493
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
494
+ "/api/v1/channels/{channel_id}/targets":
495
+ post:
496
+ tags:
497
+ - "channels.targets"
498
+ summary: "Assign A Channel Target"
499
+ operationId: "channel_targets_create"
500
+ security:
501
+ - APIKeyHeader: []
502
+ parameters:
503
+ - name: "channel_id"
504
+ in: "path"
505
+ required: true
506
+ schema:
507
+ type: "integer"
508
+ title: "Channel Id"
509
+ requestBody:
510
+ required: true
511
+ content:
512
+ "application/json":
513
+ schema: {"$ref": "#/components/schemas/ChannelTargetCreateRequest"}
514
+ responses:
515
+ "200":
516
+ description: "Successful Response"
517
+ content:
518
+ "application/json":
519
+ schema: {"$ref": "#/components/schemas/ChannelTarget"}
520
+ "422":
521
+ description: "Validation Error"
522
+ content:
523
+ "application/json":
524
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
525
+ "/api/v1/channels/{channel_id}/targets/{target_id}":
526
+ get:
527
+ tags:
528
+ - "channels.targets"
529
+ summary: "Get A Channel Target"
530
+ operationId: "channel_targets_get_by_id"
531
+ security:
532
+ - APIKeyHeader: []
533
+ parameters:
534
+ - name: "channel_id"
535
+ in: "path"
536
+ required: true
537
+ schema:
538
+ type: "integer"
539
+ title: "Channel Id"
540
+ - name: "target_id"
541
+ in: "path"
542
+ required: true
543
+ schema:
544
+ type: "integer"
545
+ title: "Target Id"
546
+ responses:
547
+ "200":
548
+ description: "Successful Response"
549
+ content:
550
+ "application/json":
551
+ schema: {"$ref": "#/components/schemas/ChannelTarget"}
552
+ "422":
553
+ description: "Validation Error"
554
+ content:
555
+ "application/json":
556
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
557
+ put:
558
+ tags:
559
+ - "channels.targets"
560
+ summary: "Edit Channel Target"
561
+ description: "Update channel target by ID"
562
+ operationId: "channels_target_update"
563
+ security:
564
+ - APIKeyHeader: []
565
+ parameters:
566
+ - name: "channel_id"
567
+ in: "path"
568
+ required: true
569
+ schema:
570
+ type: "integer"
571
+ title: "Channel Id"
572
+ - name: "target_id"
573
+ in: "path"
574
+ required: true
575
+ schema:
576
+ type: "integer"
577
+ title: "Target Id"
578
+ requestBody:
579
+ required: true
580
+ content:
581
+ "application/json":
582
+ schema: {"$ref": "#/components/schemas/ChannelTarget"}
583
+ responses:
584
+ "200":
585
+ description: "Successful Response"
586
+ content:
587
+ "application/json":
588
+ schema: {"$ref": "#/components/schemas/ChannelTarget"}
589
+ "422":
590
+ description: "Validation Error"
591
+ content:
592
+ "application/json":
593
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
594
+ "/api/v1/channels/{channel_id}":
595
+ delete:
596
+ tags:
597
+ - "channels"
598
+ summary: "Delete Channel"
599
+ description: "Delete channel by ID"
600
+ operationId: "channels_delete"
601
+ security:
602
+ - APIKeyHeader: []
603
+ parameters:
604
+ - name: "channel_id"
605
+ in: "path"
606
+ required: true
607
+ schema:
608
+ type: "string"
609
+ title: "Channel Id"
610
+ responses:
611
+ "200":
612
+ description: "Successful Response"
613
+ content:
614
+ "application/json":
615
+ schema: {"$ref": "#/components/schemas/ChannelTarget"}
616
+ "422":
617
+ description: "Validation Error"
618
+ content:
619
+ "application/json":
620
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
621
+ "/api/v1/agents/test/messages":
622
+ post:
623
+ tags:
624
+ - "agents.test"
625
+ summary: "Send New Message"
626
+ description: "Send a new message"
627
+ operationId: "send_test_message"
628
+ requestBody:
629
+ content:
630
+ "application/json":
631
+ schema: {"$ref": "#/components/schemas/TestMessage"}
632
+ required: true
633
+ responses:
634
+ "200":
635
+ description: "Successful Response"
636
+ content:
637
+ "application/json":
638
+ schema: {"$ref": "#/components/schemas/TestMessageResponse"}
639
+ "422":
640
+ description: "Validation Error"
641
+ content:
642
+ "application/json":
643
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
644
+ security:
645
+ - APIKeyHeader: []
646
+ "/api/v1/conversations/":
647
+ get:
648
+ tags:
649
+ - "conversations"
650
+ summary: "Conversations List"
651
+ operationId: "conversations_list"
652
+ security:
653
+ - APIKeyHeader: []
654
+ parameters:
655
+ - name: "page"
656
+ in: "query"
657
+ required: false
658
+ schema:
659
+ anyOf:
660
+ - type: "integer"
661
+ minimum: 0
662
+ - type: "null"
663
+ default: 0
664
+ title: "Page"
665
+ - name: "limit"
666
+ in: "query"
667
+ required: false
668
+ schema:
669
+ type: "integer"
670
+ minimum: 0
671
+ default: 25
672
+ title: "Limit"
673
+ - name: "search_fields"
674
+ in: "query"
675
+ required: false
676
+ schema:
677
+ type: "array"
678
+ items: {"$ref": "#/components/schemas/ConversationProperties"}
679
+ default: []
680
+ title: "Search Fields"
681
+ - name: "search_field_values"
682
+ in: "query"
683
+ required: false
684
+ schema:
685
+ type: "array"
686
+ items:
687
+ type: "string"
688
+ default: []
689
+ title: "Search Field Values"
690
+ - name: "order_by"
691
+ in: "query"
692
+ required: false
693
+ schema:
694
+ allOf:
695
+ - {"$ref": "#/components/schemas/ConversationProperties"}
696
+ title: "Order By"
697
+ - name: "order_by_direction"
698
+ in: "query"
699
+ required: false
700
+ schema:
701
+ allOf:
702
+ - {"$ref": "#/components/schemas/OrderByDirection"}
703
+ title: "Order By Direction"
704
+ - name: "fields"
705
+ in: "query"
706
+ required: false
707
+ schema:
708
+ anyOf:
709
+ - type: "array"
710
+ items: {"$ref": "#/components/schemas/ConversationProperties"}
711
+ - type: "null"
712
+ title: "Fields"
713
+ - name: "start_datetime"
714
+ in: "query"
715
+ required: false
716
+ schema:
717
+ anyOf:
718
+ - type: "string"
719
+ - type: "null"
720
+ title: "Start Datetime"
721
+ - name: "end_datetime"
722
+ in: "query"
723
+ required: false
724
+ schema:
725
+ anyOf:
726
+ - type: "string"
727
+ - type: "null"
728
+ title: "End Datetime"
729
+ responses:
730
+ "200":
731
+ description: "Successful Response"
732
+ content:
733
+ "application/json":
734
+ schema: {"$ref": "#/components/schemas/ListResponse_Conversation_"}
735
+ "422":
736
+ description: "Validation Error"
737
+ content:
738
+ "application/json":
739
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
740
+ "/api/v1/conversations/{conversation_id}":
741
+ get:
742
+ tags:
743
+ - "conversations"
744
+ summary: "Get Conversation By Id"
745
+ operationId: "conversation_get_by_id"
746
+ security:
747
+ - APIKeyHeader: []
748
+ parameters:
749
+ - name: "conversation_id"
750
+ in: "path"
751
+ required: true
752
+ schema:
753
+ type: "string"
754
+ title: "Conversation Id"
755
+ responses:
756
+ "200":
757
+ description: "Successful Response"
758
+ content:
759
+ "application/json":
760
+ schema: {"$ref": "#/components/schemas/ConversationTranscriptionResponse"}
761
+ "422":
762
+ description: "Validation Error"
763
+ content:
764
+ "application/json":
765
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
766
+ "/api/v1/dashboards/total_call_volume_by_weekday":
767
+ get:
768
+ tags:
769
+ - "dashboards"
770
+ summary: "Get Total Call Volume By Weekday"
771
+ description: "Get total call volume by weekday."
772
+ operationId: "total_call_volume_by_weekday"
773
+ responses:
774
+ "200":
775
+ description: "Successful Response"
776
+ content:
777
+ "application/json":
778
+ schema:
779
+ type: "object"
780
+ title: "Response Total Call Volume By Weekday"
781
+ security:
782
+ - APIKeyHeader: []
783
+ "/api/v1/dashboards/get_total_call_volume_by_hour":
784
+ get:
785
+ tags:
786
+ - "dashboards"
787
+ summary: "Get Total Call Volume By Hour"
788
+ description: "Get total call volume by hour."
789
+ operationId: "get_total_call_volume_by_hour"
790
+ responses:
791
+ "200":
792
+ description: "Successful Response"
793
+ content:
794
+ "application/json":
795
+ schema:
796
+ type: "object"
797
+ title: "Response Get Total Call Volume By Hour"
798
+ security:
799
+ - APIKeyHeader: []
800
+ "/api/v1/dashboards/get_weekly_call_volume_by_weekday":
801
+ get:
802
+ tags:
803
+ - "dashboards"
804
+ summary: "Get Weekly Call Volume By Weekday"
805
+ description: "Get weekly call volume by weekday."
806
+ operationId: "get_weekly_call_volume_by_weekday"
807
+ responses:
808
+ "200":
809
+ description: "Successful Response"
810
+ content:
811
+ "application/json":
812
+ schema:
813
+ type: "object"
814
+ title: "Response Get Weekly Call Volume By Weekday"
815
+ security:
816
+ - APIKeyHeader: []
817
+ "/api/v1/dashboards/get_daily_call_volume_by_hour":
818
+ get:
819
+ tags:
820
+ - "dashboards"
821
+ summary: "Get Daily Call Volume By Hour"
822
+ description: "Get daily call volume by hour."
823
+ operationId: "get_daily_call_volume_by_hour"
824
+ responses:
825
+ "200":
826
+ description: "Successful Response"
827
+ content:
828
+ "application/json":
829
+ schema:
830
+ type: "object"
831
+ title: "Response Get Daily Call Volume By Hour"
832
+ security:
833
+ - APIKeyHeader: []
834
+ "/api/v1/dashboards/get_monthly_call_volume_by_week":
835
+ get:
836
+ tags:
837
+ - "dashboards"
838
+ summary: "Get Monthly Call Volume By Week"
839
+ description: "Get monthly cal volume by week."
840
+ operationId: "get_monthly_call_volume_by_week"
841
+ responses:
842
+ "200":
843
+ description: "Successful Response"
844
+ content:
845
+ "application/json":
846
+ schema:
847
+ type: "object"
848
+ title: "Response Get Monthly Call Volume By Week"
849
+ security:
850
+ - APIKeyHeader: []
851
+ "/api/v1/dashboards/get_monthly_call_volume_by_day":
852
+ get:
853
+ tags:
854
+ - "dashboards"
855
+ summary: "Get Monthly Call Volume By Day"
856
+ description: "Get monthly call volume by day."
857
+ operationId: "get_monthly_call_volume_by_day"
858
+ responses:
859
+ "200":
860
+ description: "Successful Response"
861
+ content:
862
+ "application/json":
863
+ schema:
864
+ type: "object"
865
+ title: "Response Get Monthly Call Volume By Day"
866
+ security:
867
+ - APIKeyHeader: []
868
+ "/api/v1/dashboards/get_session_summary":
869
+ get:
870
+ tags:
871
+ - "dashboards"
872
+ summary: "Get Session Summary"
873
+ description: "Get session summary data"
874
+ operationId: "get_session_summary"
875
+ security:
876
+ - APIKeyHeader: []
877
+ parameters:
878
+ - name: "page"
879
+ in: "query"
880
+ required: false
881
+ schema:
882
+ type: "integer"
883
+ default: 0
884
+ title: "Page"
885
+ - name: "limit"
886
+ in: "query"
887
+ required: false
888
+ schema:
889
+ type: "integer"
890
+ default: 100
891
+ title: "Limit"
892
+ - name: "start_date"
893
+ in: "query"
894
+ required: false
895
+ schema:
896
+ anyOf:
897
+ - type: "string"
898
+ - type: "null"
899
+ title: "Start Date"
900
+ - name: "end_date"
901
+ in: "query"
902
+ required: false
903
+ schema:
904
+ anyOf:
905
+ - type: "string"
906
+ - type: "null"
907
+ title: "End Date"
908
+ - name: "order_by"
909
+ in: "query"
910
+ required: false
911
+ schema:
912
+ anyOf:
913
+ - type: "string"
914
+ - type: "null"
915
+ title: "Order By"
916
+ - name: "agent_id"
917
+ in: "query"
918
+ required: false
919
+ schema:
920
+ anyOf:
921
+ - type: "integer"
922
+ - type: "null"
923
+ title: "Agent Id"
924
+ responses:
925
+ "200":
926
+ description: "Successful Response"
927
+ content:
928
+ "application/json":
929
+ schema:
930
+ type: "object"
931
+ title: "Response Get Session Summary"
932
+ "422":
933
+ description: "Validation Error"
934
+ content:
935
+ "application/json":
936
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
937
+ "/api/v1/dashboards/get_agents":
938
+ get:
939
+ tags:
940
+ - "dashboards"
941
+ summary: "Get Agents"
942
+ description: "Get list of agents for session summary dropdown"
943
+ operationId: "get_session_agents"
944
+ responses:
945
+ "200":
946
+ description: "Successful Response"
947
+ content:
948
+ "application/json":
949
+ schema:
950
+ type: "object"
951
+ title: "Response Get Session Agents"
952
+ security:
953
+ - APIKeyHeader: []
954
+ "/api/v1/events/":
955
+ get:
956
+ tags:
957
+ - "events"
958
+ summary: "Events List"
959
+ operationId: "events_list"
960
+ security:
961
+ - APIKeyHeader: []
962
+ parameters:
963
+ - name: "page"
964
+ in: "query"
965
+ required: false
966
+ schema:
967
+ anyOf:
968
+ - type: "integer"
969
+ minimum: 0
970
+ - type: "null"
971
+ default: 0
972
+ title: "Page"
973
+ - name: "limit"
974
+ in: "query"
975
+ required: false
976
+ schema:
977
+ type: "integer"
978
+ minimum: 0
979
+ default: 25
980
+ title: "Limit"
981
+ - name: "search_fields"
982
+ in: "query"
983
+ required: false
984
+ schema:
985
+ type: "array"
986
+ items: {"$ref": "#/components/schemas/EventProperties"}
987
+ default: []
988
+ title: "Search Fields"
989
+ - name: "search_field_values"
990
+ in: "query"
991
+ required: false
992
+ schema:
993
+ type: "array"
994
+ items:
995
+ type: "string"
996
+ default: []
997
+ title: "Search Field Values"
998
+ - name: "order_by"
999
+ in: "query"
1000
+ required: false
1001
+ schema:
1002
+ allOf:
1003
+ - {"$ref": "#/components/schemas/EventProperties"}
1004
+ title: "Order By"
1005
+ - name: "order_by_direction"
1006
+ in: "query"
1007
+ required: false
1008
+ schema:
1009
+ allOf:
1010
+ - {"$ref": "#/components/schemas/OrderByDirection"}
1011
+ title: "Order By Direction"
1012
+ - name: "fields"
1013
+ in: "query"
1014
+ required: false
1015
+ schema:
1016
+ anyOf:
1017
+ - type: "array"
1018
+ items: {"$ref": "#/components/schemas/EventProperties"}
1019
+ - type: "null"
1020
+ title: "Fields"
1021
+ - name: "start_datetime"
1022
+ in: "query"
1023
+ required: false
1024
+ schema:
1025
+ anyOf:
1026
+ - type: "string"
1027
+ - type: "null"
1028
+ title: "Start Datetime"
1029
+ - name: "end_datetime"
1030
+ in: "query"
1031
+ required: false
1032
+ schema:
1033
+ anyOf:
1034
+ - type: "string"
1035
+ - type: "null"
1036
+ title: "End Datetime"
1037
+ responses:
1038
+ "200":
1039
+ description: "Successful Response"
1040
+ content:
1041
+ "application/json":
1042
+ schema: {"$ref": "#/components/schemas/ListResponse_Event_"}
1043
+ "422":
1044
+ description: "Validation Error"
1045
+ content:
1046
+ "application/json":
1047
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1048
+ "/api/v1/custom_messages/":
1049
+ get:
1050
+ tags:
1051
+ - "custom_messages"
1052
+ summary: "Custom Messages List"
1053
+ description: "List the existing custom_messages"
1054
+ operationId: "custom_messages_list"
1055
+ security:
1056
+ - APIKeyHeader: []
1057
+ parameters:
1058
+ - name: "page"
1059
+ in: "query"
1060
+ required: false
1061
+ schema:
1062
+ anyOf:
1063
+ - type: "integer"
1064
+ minimum: 0
1065
+ - type: "null"
1066
+ default: 0
1067
+ title: "Page"
1068
+ - name: "limit"
1069
+ in: "query"
1070
+ required: false
1071
+ schema:
1072
+ type: "integer"
1073
+ minimum: 0
1074
+ default: 25
1075
+ title: "Limit"
1076
+ - name: "search_fields"
1077
+ in: "query"
1078
+ required: false
1079
+ schema:
1080
+ type: "array"
1081
+ items: {"$ref": "#/components/schemas/CustomMessageProperties"}
1082
+ default: []
1083
+ title: "Search Fields"
1084
+ - name: "search_field_values"
1085
+ in: "query"
1086
+ required: false
1087
+ schema:
1088
+ type: "array"
1089
+ items:
1090
+ type: "string"
1091
+ default: []
1092
+ title: "Search Field Values"
1093
+ - name: "order_by"
1094
+ in: "query"
1095
+ required: false
1096
+ schema:
1097
+ allOf:
1098
+ - {"$ref": "#/components/schemas/CustomMessageProperties"}
1099
+ title: "Order By"
1100
+ - name: "order_by_direction"
1101
+ in: "query"
1102
+ required: false
1103
+ schema:
1104
+ allOf:
1105
+ - {"$ref": "#/components/schemas/OrderByDirection"}
1106
+ title: "Order By Direction"
1107
+ - name: "fields"
1108
+ in: "query"
1109
+ required: false
1110
+ schema:
1111
+ anyOf:
1112
+ - type: "array"
1113
+ items: {"$ref": "#/components/schemas/CustomMessageProperties"}
1114
+ - type: "null"
1115
+ title: "Fields"
1116
+ - name: "start_datetime"
1117
+ in: "query"
1118
+ required: false
1119
+ schema:
1120
+ anyOf:
1121
+ - type: "string"
1122
+ - type: "null"
1123
+ title: "Start Datetime"
1124
+ - name: "end_datetime"
1125
+ in: "query"
1126
+ required: false
1127
+ schema:
1128
+ anyOf:
1129
+ - type: "string"
1130
+ - type: "null"
1131
+ title: "End Datetime"
1132
+ responses:
1133
+ "200":
1134
+ description: "Successful Response"
1135
+ content:
1136
+ "application/json":
1137
+ schema: {"$ref": "#/components/schemas/ListResponse_CustomMessage_"}
1138
+ "422":
1139
+ description: "Validation Error"
1140
+ content:
1141
+ "application/json":
1142
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1143
+ post:
1144
+ tags:
1145
+ - "custom_messages"
1146
+ summary: "Create Custom Message"
1147
+ description: "Create a new greeting"
1148
+ operationId: "custom_messages_create"
1149
+ security:
1150
+ - APIKeyHeader: []
1151
+ requestBody:
1152
+ required: true
1153
+ content:
1154
+ "application/json":
1155
+ schema: {"$ref": "#/components/schemas/CustomMessageCreate"}
1156
+ responses:
1157
+ "200":
1158
+ description: "Successful Response"
1159
+ content:
1160
+ "application/json":
1161
+ schema: {"$ref": "#/components/schemas/CustomMessage"}
1162
+ "422":
1163
+ description: "Validation Error"
1164
+ content:
1165
+ "application/json":
1166
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1167
+ put:
1168
+ tags:
1169
+ - "custom_messages"
1170
+ summary: "Update Custom Message"
1171
+ description: "Update a greeting"
1172
+ operationId: "custom_messages_update"
1173
+ security:
1174
+ - APIKeyHeader: []
1175
+ requestBody:
1176
+ required: true
1177
+ content:
1178
+ "application/json":
1179
+ schema: {"$ref": "#/components/schemas/CustomMessage"}
1180
+ responses:
1181
+ "200":
1182
+ description: "Successful Response"
1183
+ content:
1184
+ "application/json":
1185
+ schema: {"$ref": "#/components/schemas/CustomMessage"}
1186
+ "422":
1187
+ description: "Validation Error"
1188
+ content:
1189
+ "application/json":
1190
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1191
+ "/api/v1/custom_messages/{custom_message_id}":
1192
+ get:
1193
+ tags:
1194
+ - "custom_messages"
1195
+ summary: "Get Custom Message By Id"
1196
+ description: "Get the greeting by its ID"
1197
+ operationId: "custom_message_get_by_id"
1198
+ security:
1199
+ - APIKeyHeader: []
1200
+ parameters:
1201
+ - name: "custom_message_id"
1202
+ in: "path"
1203
+ required: true
1204
+ schema:
1205
+ type: "integer"
1206
+ title: "Custom Message Id"
1207
+ responses:
1208
+ "200":
1209
+ description: "Successful Response"
1210
+ content:
1211
+ "application/json":
1212
+ schema: {"$ref": "#/components/schemas/CustomMessage"}
1213
+ "422":
1214
+ description: "Validation Error"
1215
+ content:
1216
+ "application/json":
1217
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1218
+ delete:
1219
+ tags:
1220
+ - "custom_messages"
1221
+ summary: "Delete Custom Message"
1222
+ description: "Delete greeting by ID"
1223
+ operationId: "custom_messages_delete"
1224
+ security:
1225
+ - APIKeyHeader: []
1226
+ parameters:
1227
+ - name: "custom_message_id"
1228
+ in: "path"
1229
+ required: true
1230
+ schema:
1231
+ type: "integer"
1232
+ title: "Custom Message Id"
1233
+ - name: "reason"
1234
+ in: "query"
1235
+ required: true
1236
+ schema:
1237
+ type: "string"
1238
+ title: "Reason"
1239
+ responses:
1240
+ "200":
1241
+ description: "Successful Response"
1242
+ content:
1243
+ "application/json":
1244
+ schema: {}
1245
+ "422":
1246
+ description: "Validation Error"
1247
+ content:
1248
+ "application/json":
1249
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1250
+ "/api/v1/prompts/":
1251
+ get:
1252
+ tags:
1253
+ - "prompts"
1254
+ summary: "Prompt List"
1255
+ description: "List the existing prompts"
1256
+ operationId: "prompts_list"
1257
+ security:
1258
+ - APIKeyHeader: []
1259
+ parameters:
1260
+ - name: "page"
1261
+ in: "query"
1262
+ required: false
1263
+ schema:
1264
+ anyOf:
1265
+ - type: "integer"
1266
+ minimum: 0
1267
+ - type: "null"
1268
+ default: 0
1269
+ title: "Page"
1270
+ - name: "limit"
1271
+ in: "query"
1272
+ required: false
1273
+ schema:
1274
+ type: "integer"
1275
+ minimum: 0
1276
+ default: 25
1277
+ title: "Limit"
1278
+ - name: "search_fields"
1279
+ in: "query"
1280
+ required: false
1281
+ schema:
1282
+ type: "array"
1283
+ items: {"$ref": "#/components/schemas/PromptProperties"}
1284
+ default: []
1285
+ title: "Search Fields"
1286
+ - name: "search_field_values"
1287
+ in: "query"
1288
+ required: false
1289
+ schema:
1290
+ type: "array"
1291
+ items:
1292
+ type: "string"
1293
+ default: []
1294
+ title: "Search Field Values"
1295
+ - name: "order_by"
1296
+ in: "query"
1297
+ required: false
1298
+ schema:
1299
+ allOf:
1300
+ - {"$ref": "#/components/schemas/PromptProperties"}
1301
+ title: "Order By"
1302
+ - name: "order_by_direction"
1303
+ in: "query"
1304
+ required: false
1305
+ schema:
1306
+ allOf:
1307
+ - {"$ref": "#/components/schemas/OrderByDirection"}
1308
+ title: "Order By Direction"
1309
+ - name: "fields"
1310
+ in: "query"
1311
+ required: false
1312
+ schema:
1313
+ anyOf:
1314
+ - type: "array"
1315
+ items: {"$ref": "#/components/schemas/PromptProperties"}
1316
+ - type: "null"
1317
+ title: "Fields"
1318
+ - name: "start_datetime"
1319
+ in: "query"
1320
+ required: false
1321
+ schema:
1322
+ anyOf:
1323
+ - type: "string"
1324
+ - type: "null"
1325
+ title: "Start Datetime"
1326
+ - name: "end_datetime"
1327
+ in: "query"
1328
+ required: false
1329
+ schema:
1330
+ anyOf:
1331
+ - type: "string"
1332
+ - type: "null"
1333
+ title: "End Datetime"
1334
+ responses:
1335
+ "200":
1336
+ description: "Successful Response"
1337
+ content:
1338
+ "application/json":
1339
+ schema: {"$ref": "#/components/schemas/ListResponse_Prompt_"}
1340
+ "422":
1341
+ description: "Validation Error"
1342
+ content:
1343
+ "application/json":
1344
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1345
+ post:
1346
+ tags:
1347
+ - "prompts"
1348
+ summary: "Create Prompt"
1349
+ description: "Create a new prompt"
1350
+ operationId: "prompts_create"
1351
+ security:
1352
+ - APIKeyHeader: []
1353
+ requestBody:
1354
+ required: true
1355
+ content:
1356
+ "application/json":
1357
+ schema: {"$ref": "#/components/schemas/PromptCreate"}
1358
+ responses:
1359
+ "200":
1360
+ description: "Successful Response"
1361
+ content:
1362
+ "application/json":
1363
+ schema: {"$ref": "#/components/schemas/Prompt"}
1364
+ "422":
1365
+ description: "Validation Error"
1366
+ content:
1367
+ "application/json":
1368
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1369
+ put:
1370
+ tags:
1371
+ - "prompts"
1372
+ summary: "Update Prompt"
1373
+ description: "Update an existing prompt"
1374
+ operationId: "prompts_update"
1375
+ security:
1376
+ - APIKeyHeader: []
1377
+ requestBody:
1378
+ required: true
1379
+ content:
1380
+ "application/json":
1381
+ schema: {"$ref": "#/components/schemas/Prompt"}
1382
+ responses:
1383
+ "200":
1384
+ description: "Successful Response"
1385
+ content:
1386
+ "application/json":
1387
+ schema: {"$ref": "#/components/schemas/Prompt"}
1388
+ "422":
1389
+ description: "Validation Error"
1390
+ content:
1391
+ "application/json":
1392
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1393
+ "/api/v1/prompts/{prompt_id}":
1394
+ get:
1395
+ tags:
1396
+ - "prompts"
1397
+ summary: "Get Prompt By Id"
1398
+ description: "Get a prompt by ID"
1399
+ operationId: "prompts_get_by_id"
1400
+ security:
1401
+ - APIKeyHeader: []
1402
+ parameters:
1403
+ - name: "prompt_id"
1404
+ in: "path"
1405
+ required: true
1406
+ schema:
1407
+ type: "integer"
1408
+ title: "Prompt Id"
1409
+ responses:
1410
+ "200":
1411
+ description: "Successful Response"
1412
+ content:
1413
+ "application/json":
1414
+ schema: {"$ref": "#/components/schemas/Prompt"}
1415
+ "422":
1416
+ description: "Validation Error"
1417
+ content:
1418
+ "application/json":
1419
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1420
+ delete:
1421
+ tags:
1422
+ - "prompts"
1423
+ summary: "Delete Prompt"
1424
+ description: "Delete an prompt by ID"
1425
+ operationId: "prompts_delete"
1426
+ security:
1427
+ - APIKeyHeader: []
1428
+ parameters:
1429
+ - name: "prompt_id"
1430
+ in: "path"
1431
+ required: true
1432
+ schema:
1433
+ type: "integer"
1434
+ title: "Prompt Id"
1435
+ - name: "reason"
1436
+ in: "query"
1437
+ required: true
1438
+ schema:
1439
+ type: "string"
1440
+ title: "Reason"
1441
+ responses:
1442
+ "200":
1443
+ description: "Successful Response"
1444
+ content:
1445
+ "application/json":
1446
+ schema: {}
1447
+ "422":
1448
+ description: "Validation Error"
1449
+ content:
1450
+ "application/json":
1451
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1452
+ "/api/v1/sessions/":
1453
+ get:
1454
+ tags:
1455
+ - "sessions"
1456
+ summary: "Sessions List"
1457
+ operationId: "sessions_list"
1458
+ security:
1459
+ - APIKeyHeader: []
1460
+ parameters:
1461
+ - name: "page"
1462
+ in: "query"
1463
+ required: false
1464
+ schema:
1465
+ anyOf:
1466
+ - type: "integer"
1467
+ minimum: 0
1468
+ - type: "null"
1469
+ default: 0
1470
+ title: "Page"
1471
+ - name: "limit"
1472
+ in: "query"
1473
+ required: false
1474
+ schema:
1475
+ type: "integer"
1476
+ minimum: 0
1477
+ default: 25
1478
+ title: "Limit"
1479
+ - name: "search_fields"
1480
+ in: "query"
1481
+ required: false
1482
+ schema:
1483
+ type: "array"
1484
+ items: {"$ref": "#/components/schemas/SessionProperties"}
1485
+ default: []
1486
+ title: "Search Fields"
1487
+ - name: "search_field_values"
1488
+ in: "query"
1489
+ required: false
1490
+ schema:
1491
+ type: "array"
1492
+ items:
1493
+ type: "string"
1494
+ default: []
1495
+ title: "Search Field Values"
1496
+ - name: "order_by"
1497
+ in: "query"
1498
+ required: false
1499
+ schema:
1500
+ allOf:
1501
+ - {"$ref": "#/components/schemas/SessionProperties"}
1502
+ title: "Order By"
1503
+ - name: "order_by_direction"
1504
+ in: "query"
1505
+ required: false
1506
+ schema:
1507
+ allOf:
1508
+ - {"$ref": "#/components/schemas/OrderByDirection"}
1509
+ title: "Order By Direction"
1510
+ - name: "fields"
1511
+ in: "query"
1512
+ required: false
1513
+ schema:
1514
+ anyOf:
1515
+ - type: "array"
1516
+ items: {"$ref": "#/components/schemas/SessionProperties"}
1517
+ - type: "null"
1518
+ title: "Fields"
1519
+ - name: "start_datetime"
1520
+ in: "query"
1521
+ required: false
1522
+ schema:
1523
+ anyOf:
1524
+ - type: "string"
1525
+ - type: "null"
1526
+ title: "Start Datetime"
1527
+ - name: "end_datetime"
1528
+ in: "query"
1529
+ required: false
1530
+ schema:
1531
+ anyOf:
1532
+ - type: "string"
1533
+ - type: "null"
1534
+ title: "End Datetime"
1535
+ responses:
1536
+ "200":
1537
+ description: "Successful Response"
1538
+ content:
1539
+ "application/json":
1540
+ schema: {"$ref": "#/components/schemas/ListResponse_Session_"}
1541
+ "422":
1542
+ description: "Validation Error"
1543
+ content:
1544
+ "application/json":
1545
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1546
+ "/api/v1/tools/":
1547
+ get:
1548
+ tags:
1549
+ - "tools"
1550
+ summary: "Tool List"
1551
+ description: "List the existing agents"
1552
+ operationId: "tool_list"
1553
+ security:
1554
+ - APIKeyHeader: []
1555
+ parameters:
1556
+ - name: "page"
1557
+ in: "query"
1558
+ required: false
1559
+ schema:
1560
+ anyOf:
1561
+ - type: "integer"
1562
+ minimum: 0
1563
+ - type: "null"
1564
+ default: 0
1565
+ title: "Page"
1566
+ - name: "limit"
1567
+ in: "query"
1568
+ required: false
1569
+ schema:
1570
+ type: "integer"
1571
+ minimum: 0
1572
+ default: 25
1573
+ title: "Limit"
1574
+ - name: "search_fields"
1575
+ in: "query"
1576
+ required: false
1577
+ schema:
1578
+ type: "array"
1579
+ items: {"$ref": "#/components/schemas/ToolProperties"}
1580
+ default: []
1581
+ title: "Search Fields"
1582
+ - name: "search_field_values"
1583
+ in: "query"
1584
+ required: false
1585
+ schema:
1586
+ type: "array"
1587
+ items:
1588
+ type: "string"
1589
+ default: []
1590
+ title: "Search Field Values"
1591
+ - name: "order_by"
1592
+ in: "query"
1593
+ required: false
1594
+ schema:
1595
+ allOf:
1596
+ - {"$ref": "#/components/schemas/ToolProperties"}
1597
+ title: "Order By"
1598
+ - name: "order_by_direction"
1599
+ in: "query"
1600
+ required: false
1601
+ schema:
1602
+ allOf:
1603
+ - {"$ref": "#/components/schemas/OrderByDirection"}
1604
+ title: "Order By Direction"
1605
+ - name: "fields"
1606
+ in: "query"
1607
+ required: false
1608
+ schema:
1609
+ anyOf:
1610
+ - type: "array"
1611
+ items: {"$ref": "#/components/schemas/ToolProperties"}
1612
+ - type: "null"
1613
+ title: "Fields"
1614
+ - name: "start_datetime"
1615
+ in: "query"
1616
+ required: false
1617
+ schema:
1618
+ anyOf:
1619
+ - type: "string"
1620
+ - type: "null"
1621
+ title: "Start Datetime"
1622
+ - name: "end_datetime"
1623
+ in: "query"
1624
+ required: false
1625
+ schema:
1626
+ anyOf:
1627
+ - type: "string"
1628
+ - type: "null"
1629
+ title: "End Datetime"
1630
+ responses:
1631
+ "200":
1632
+ description: "Successful Response"
1633
+ content:
1634
+ "application/json":
1635
+ schema: {"$ref": "#/components/schemas/ListResponse_SchemasBubblegumV2ToolsTool_"}
1636
+ "422":
1637
+ description: "Validation Error"
1638
+ content:
1639
+ "application/json":
1640
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1641
+ "/api/v1/tools/{tool_name}":
1642
+ get:
1643
+ tags:
1644
+ - "tools"
1645
+ summary: "Tool Info"
1646
+ description: "Get the details of a specific tool"
1647
+ operationId: "tool_get_by_name"
1648
+ security:
1649
+ - APIKeyHeader: []
1650
+ parameters:
1651
+ - name: "tool_name"
1652
+ in: "path"
1653
+ required: true
1654
+ schema:
1655
+ type: "string"
1656
+ title: "Tool Name"
1657
+ responses:
1658
+ "200":
1659
+ description: "Successful Response"
1660
+ content:
1661
+ "application/json":
1662
+ schema: {"$ref": "#/components/schemas/ToolDetailResponse"}
1663
+ "422":
1664
+ description: "Validation Error"
1665
+ content:
1666
+ "application/json":
1667
+ schema: {"$ref": "#/components/schemas/HTTPValidationError"}
1668
+ "/api/v1/organizations/":
1669
+ get:
1670
+ tags:
1671
+ - "organizations"
1672
+ summary: "Organizations List"
1673
+ description: "List all organizations"
1674
+ operationId: "organizations_list"
1675
+ responses:
1676
+ "200":
1677
+ description: "Successful Response"
1678
+ content:
1679
+ "application/json":
1680
+ schema:
1681
+ items: {"$ref": "#/components/schemas/Organization"}
1682
+ type: "array"
1683
+ title: "Response Organizations List"
1684
+ security:
1685
+ - APIKeyHeader: []
1686
+ components:
1687
+ schemas:
1688
+ "Agent":
1689
+ properties:
1690
+ "name":
1691
+ type: "string"
1692
+ title: "Name"
1693
+ "timezone":
1694
+ type: "string"
1695
+ title: "Timezone"
1696
+ "type":
1697
+ type: "string"
1698
+ title: "Type"
1699
+ "prompt_id":
1700
+ type: "integer"
1701
+ title: "Prompt Id"
1702
+ "custom_message_id":
1703
+ anyOf:
1704
+ - type: "integer"
1705
+ - type: "null"
1706
+ title: "Custom Message Id"
1707
+ "languages":
1708
+ items:
1709
+ type: "string"
1710
+ type: "array"
1711
+ title: "Languages"
1712
+ "prompt_tool_defaults":
1713
+ items: {"$ref": "#/components/schemas/AgentToolDefaults"}
1714
+ type: "array"
1715
+ title: "Prompt Tool Defaults"
1716
+ "tool_headers":
1717
+ anyOf:
1718
+ - additionalProperties:
1719
+ type: "string"
1720
+ type: "object"
1721
+ - type: "null"
1722
+ title: "Tool Headers"
1723
+ "variables":
1724
+ anyOf:
1725
+ - type: "object"
1726
+ - type: "null"
1727
+ title: "Variables"
1728
+ "id":
1729
+ type: "integer"
1730
+ title: "Id"
1731
+ description: "The Agent ID"
1732
+ type: "object"
1733
+ required:
1734
+ - "name"
1735
+ - "timezone"
1736
+ - "type"
1737
+ - "prompt_id"
1738
+ - "custom_message_id"
1739
+ - "languages"
1740
+ - "id"
1741
+ title: "Agent"
1742
+ "AgentCreate":
1743
+ properties:
1744
+ "name":
1745
+ type: "string"
1746
+ title: "Name"
1747
+ "timezone":
1748
+ type: "string"
1749
+ title: "Timezone"
1750
+ "type":
1751
+ type: "string"
1752
+ title: "Type"
1753
+ "prompt_id":
1754
+ type: "integer"
1755
+ title: "Prompt Id"
1756
+ "custom_message_id":
1757
+ anyOf:
1758
+ - type: "integer"
1759
+ - type: "null"
1760
+ title: "Custom Message Id"
1761
+ "languages":
1762
+ items:
1763
+ type: "string"
1764
+ type: "array"
1765
+ title: "Languages"
1766
+ "prompt_tool_defaults":
1767
+ items: {"$ref": "#/components/schemas/AgentToolDefaults"}
1768
+ type: "array"
1769
+ title: "Prompt Tool Defaults"
1770
+ "tool_headers":
1771
+ anyOf:
1772
+ - additionalProperties:
1773
+ type: "string"
1774
+ type: "object"
1775
+ - type: "null"
1776
+ title: "Tool Headers"
1777
+ "variables":
1778
+ anyOf:
1779
+ - type: "object"
1780
+ - type: "null"
1781
+ title: "Variables"
1782
+ type: "object"
1783
+ required:
1784
+ - "name"
1785
+ - "timezone"
1786
+ - "type"
1787
+ - "prompt_id"
1788
+ - "custom_message_id"
1789
+ - "languages"
1790
+ title: "AgentCreate"
1791
+ "AgentProperties":
1792
+ type: "string"
1793
+ enum:
1794
+ - "id"
1795
+ - "name"
1796
+ - "type"
1797
+ - "timezone"
1798
+ - "prompt_id"
1799
+ - "custom_message_id"
1800
+ - "languages"
1801
+ - "variables"
1802
+ - "prompt_tool_defaults"
1803
+ - "tool_headers"
1804
+ title: "AgentProperties"
1805
+ "AgentToolDefaults":
1806
+ properties:
1807
+ "tool_name":
1808
+ type: "string"
1809
+ title: "Tool Name"
1810
+ "default_values":
1811
+ items: {"$ref": "#/components/schemas/AgentToolFieldDefault"}
1812
+ type: "array"
1813
+ title: "Default Values"
1814
+ type: "object"
1815
+ required:
1816
+ - "tool_name"
1817
+ - "default_values"
1818
+ title: "AgentToolDefaults"
1819
+ "AgentToolFieldDefault":
1820
+ properties:
1821
+ "field_name":
1822
+ type: "string"
1823
+ title: "Field Name"
1824
+ "default_value":
1825
+ title: "Default Value"
1826
+ type: "object"
1827
+ required:
1828
+ - "field_name"
1829
+ - "default_value"
1830
+ title: "AgentToolFieldDefault"
1831
+ "AvailableTarget":
1832
+ properties:
1833
+ "channel_id":
1834
+ type: "integer"
1835
+ title: "Channel Id"
1836
+ "channel_name":
1837
+ anyOf:
1838
+ - type: "string"
1839
+ - type: "null"
1840
+ title: "Channel Name"
1841
+ "target":
1842
+ type: "string"
1843
+ title: "Target"
1844
+ type: "object"
1845
+ required:
1846
+ - "channel_id"
1847
+ - "channel_name"
1848
+ - "target"
1849
+ title: "AvailableTarget"
1850
+ "AvailableTargetProperties":
1851
+ type: "string"
1852
+ enum:
1853
+ - "channel_id"
1854
+ - "channel_name"
1855
+ - "target"
1856
+ title: "AvailableTargetProperties"
1857
+ "Channel":
1858
+ properties:
1859
+ "id":
1860
+ type: "string"
1861
+ title: "Id"
1862
+ "name":
1863
+ type: "string"
1864
+ title: "Name"
1865
+ "channel_service":
1866
+ type: "string"
1867
+ title: "Channel Service"
1868
+ "supported_modes":
1869
+ type: "string"
1870
+ title: "Supported Modes"
1871
+ type: "object"
1872
+ required:
1873
+ - "id"
1874
+ - "name"
1875
+ - "channel_service"
1876
+ - "supported_modes"
1877
+ title: "Channel"
1878
+ "ChannelProperties":
1879
+ type: "string"
1880
+ enum:
1881
+ - "id"
1882
+ - "name"
1883
+ - "channel_service"
1884
+ - "supported_modes"
1885
+ title: "ChannelProperties"
1886
+ "ChannelTarget":
1887
+ properties:
1888
+ "id":
1889
+ type: "integer"
1890
+ title: "Id"
1891
+ "channel_id":
1892
+ anyOf:
1893
+ - type: "integer"
1894
+ - type: "null"
1895
+ title: "Channel Id"
1896
+ "channel_name":
1897
+ anyOf:
1898
+ - type: "string"
1899
+ - type: "null"
1900
+ title: "Channel Name"
1901
+ "agent_id":
1902
+ anyOf:
1903
+ - type: "integer"
1904
+ - type: "null"
1905
+ title: "Agent Id"
1906
+ "target":
1907
+ anyOf:
1908
+ - type: "string"
1909
+ - type: "null"
1910
+ title: "Target"
1911
+ "target_mode":
1912
+ anyOf:
1913
+ - type: "string"
1914
+ - type: "null"
1915
+ title: "Target Mode"
1916
+ "fallback_target":
1917
+ anyOf:
1918
+ - type: "string"
1919
+ - type: "null"
1920
+ title: "Fallback Target"
1921
+ "is_test":
1922
+ anyOf:
1923
+ - type: "boolean"
1924
+ - type: "null"
1925
+ title: "Is Test"
1926
+ type: "object"
1927
+ required:
1928
+ - "id"
1929
+ - "channel_id"
1930
+ - "channel_name"
1931
+ - "agent_id"
1932
+ - "target"
1933
+ - "target_mode"
1934
+ - "fallback_target"
1935
+ - "is_test"
1936
+ title: "ChannelTarget"
1937
+ "ChannelTargetCreateRequest":
1938
+ properties:
1939
+ "channel_id":
1940
+ anyOf:
1941
+ - type: "integer"
1942
+ - type: "null"
1943
+ title: "Channel Id"
1944
+ "channel_name":
1945
+ anyOf:
1946
+ - type: "string"
1947
+ - type: "null"
1948
+ title: "Channel Name"
1949
+ "agent_id":
1950
+ anyOf:
1951
+ - type: "integer"
1952
+ - type: "null"
1953
+ title: "Agent Id"
1954
+ "target":
1955
+ anyOf:
1956
+ - type: "string"
1957
+ - type: "null"
1958
+ title: "Target"
1959
+ "target_mode":
1960
+ anyOf:
1961
+ - type: "string"
1962
+ - type: "null"
1963
+ title: "Target Mode"
1964
+ "fallback_target":
1965
+ anyOf:
1966
+ - type: "string"
1967
+ - type: "null"
1968
+ title: "Fallback Target"
1969
+ "is_test":
1970
+ anyOf:
1971
+ - type: "boolean"
1972
+ - type: "null"
1973
+ title: "Is Test"
1974
+ type: "object"
1975
+ required:
1976
+ - "channel_id"
1977
+ - "channel_name"
1978
+ - "agent_id"
1979
+ - "target"
1980
+ - "target_mode"
1981
+ - "fallback_target"
1982
+ - "is_test"
1983
+ title: "ChannelTargetCreateRequest"
1984
+ "ChannelTargetProperties":
1985
+ type: "string"
1986
+ enum:
1987
+ - "id"
1988
+ - "channel_id"
1989
+ - "channel_name"
1990
+ - "agent_id"
1991
+ - "target"
1992
+ - "target_mode"
1993
+ - "fallback_target"
1994
+ - "is_test"
1995
+ title: "ChannelTargetProperties"
1996
+ "Conversation":
1997
+ properties:
1998
+ "timestamp":
1999
+ type: "string"
2000
+ format: "date-time"
2001
+ title: "Timestamp"
2002
+ "conversation_id":
2003
+ type: "string"
2004
+ title: "Conversation Id"
2005
+ "session_id":
2006
+ anyOf:
2007
+ - type: "string"
2008
+ - type: "null"
2009
+ title: "Session Id"
2010
+ "agent_id":
2011
+ anyOf:
2012
+ - type: "string"
2013
+ - type: "null"
2014
+ title: "Agent Id"
2015
+ "agent_name":
2016
+ anyOf:
2017
+ - type: "string"
2018
+ - type: "null"
2019
+ title: "Agent Name"
2020
+ "agent_type":
2021
+ anyOf:
2022
+ - type: "string"
2023
+ - type: "null"
2024
+ title: "Agent Type"
2025
+ "prompt_id":
2026
+ anyOf:
2027
+ - type: "string"
2028
+ - type: "null"
2029
+ title: "Prompt Id"
2030
+ "prompt_name":
2031
+ anyOf:
2032
+ - type: "string"
2033
+ - type: "null"
2034
+ title: "Prompt Name"
2035
+ "prompt_version":
2036
+ anyOf:
2037
+ - type: "string"
2038
+ - type: "null"
2039
+ title: "Prompt Version"
2040
+ "call_id":
2041
+ anyOf:
2042
+ - type: "string"
2043
+ - type: "null"
2044
+ title: "Call Id"
2045
+ "source":
2046
+ anyOf:
2047
+ - type: "string"
2048
+ - type: "null"
2049
+ title: "Source"
2050
+ "target":
2051
+ anyOf:
2052
+ - type: "string"
2053
+ - type: "null"
2054
+ title: "Target"
2055
+ "is_legacy":
2056
+ anyOf:
2057
+ - type: "boolean"
2058
+ - type: "null"
2059
+ title: "Is Legacy"
2060
+ "is_test":
2061
+ anyOf:
2062
+ - type: "boolean"
2063
+ - type: "null"
2064
+ title: "Is Test"
2065
+ type: "object"
2066
+ required:
2067
+ - "timestamp"
2068
+ - "conversation_id"
2069
+ title: "Conversation"
2070
+ "ConversationAction":
2071
+ properties:
2072
+ "timestamp":
2073
+ type: "string"
2074
+ format: "date-time"
2075
+ title: "Timestamp"
2076
+ "tool_name":
2077
+ anyOf:
2078
+ - type: "string"
2079
+ - type: "null"
2080
+ title: "Tool Name"
2081
+ "tool_request":
2082
+ anyOf:
2083
+ - type: "string"
2084
+ - type: "null"
2085
+ title: "Tool Request"
2086
+ "tool_result":
2087
+ anyOf:
2088
+ - type: "string"
2089
+ - type: "null"
2090
+ title: "Tool Result"
2091
+ type: "object"
2092
+ required:
2093
+ - "timestamp"
2094
+ title: "ConversationAction"
2095
+ "ConversationProperties":
2096
+ type: "string"
2097
+ enum:
2098
+ - "timestamp"
2099
+ - "agent_type"
2100
+ - "agent_id"
2101
+ - "agent_name"
2102
+ - "prompt_id"
2103
+ - "prompt_name"
2104
+ - "call_id"
2105
+ - "source"
2106
+ - "target"
2107
+ - "is_legacy"
2108
+ - "is_test"
2109
+ title: "ConversationProperties"
2110
+ "ConversationText":
2111
+ properties:
2112
+ "timestamp":
2113
+ type: "string"
2114
+ format: "date-time"
2115
+ title: "Timestamp"
2116
+ "lang":
2117
+ anyOf:
2118
+ - type: "string"
2119
+ - type: "null"
2120
+ title: "Lang"
2121
+ "source":
2122
+ anyOf:
2123
+ - type: "string"
2124
+ - type: "null"
2125
+ title: "Source"
2126
+ "text":
2127
+ anyOf:
2128
+ - type: "string"
2129
+ - type: "null"
2130
+ title: "Text"
2131
+ type: "object"
2132
+ required:
2133
+ - "timestamp"
2134
+ title: "ConversationText"
2135
+ "ConversationTranscriptionResponse":
2136
+ properties:
2137
+ "conversation_id":
2138
+ type: "string"
2139
+ title: "Conversation Id"
2140
+ "transcription":
2141
+ items: {"$ref": "#/components/schemas/ConversationText"}
2142
+ type: "array"
2143
+ title: "Transcription"
2144
+ "actions":
2145
+ items: {"$ref": "#/components/schemas/ConversationAction"}
2146
+ type: "array"
2147
+ title: "Actions"
2148
+ type: "object"
2149
+ required:
2150
+ - "conversation_id"
2151
+ - "transcription"
2152
+ - "actions"
2153
+ title: "ConversationTranscriptionResponse"
2154
+ "CustomMessage":
2155
+ properties:
2156
+ "name":
2157
+ type: "string"
2158
+ title: "Name"
2159
+ description: "The name of the greeting"
2160
+ "text":
2161
+ type: "string"
2162
+ title: "Text"
2163
+ description: "The text of the greeting"
2164
+ "id":
2165
+ type: "integer"
2166
+ title: "Id"
2167
+ description: "The ID of the greeting"
2168
+ "type":
2169
+ type: "string"
2170
+ title: "Type"
2171
+ default: "greeting"
2172
+ type: "object"
2173
+ required:
2174
+ - "name"
2175
+ - "text"
2176
+ - "id"
2177
+ title: "CustomMessage"
2178
+ "CustomMessageCreate":
2179
+ properties:
2180
+ "name":
2181
+ type: "string"
2182
+ title: "Name"
2183
+ description: "The name of the greeting"
2184
+ "text":
2185
+ type: "string"
2186
+ title: "Text"
2187
+ description: "The text of the greeting"
2188
+ type: "object"
2189
+ required:
2190
+ - "name"
2191
+ - "text"
2192
+ title: "CustomMessageCreate"
2193
+ "CustomMessageProperties":
2194
+ type: "string"
2195
+ enum:
2196
+ - "id"
2197
+ - "name"
2198
+ - "text"
2199
+ title: "CustomMessageProperties"
2200
+ "Defaults":
2201
+ properties:
2202
+ "anyof_schema_1_validator":
2203
+ anyOf:
2204
+ - type: "object"
2205
+ - type: "null"
2206
+ title: "Anyof Schema 1 Validator"
2207
+ "anyof_schema_2_validator":
2208
+ anyOf:
2209
+ - additionalProperties: {"$ref": "#/components/schemas/ToolParameterDefault"}
2210
+ type: "object"
2211
+ - type: "null"
2212
+ title: "Anyof Schema 2 Validator"
2213
+ "actual_instance":
2214
+ title: "Actual Instance"
2215
+ "any_of_schemas":
2216
+ items:
2217
+ type: "string"
2218
+ type: "array"
2219
+ uniqueItems: true
2220
+ title: "Any Of Schemas"
2221
+ default: ["object", "Dict[str, ToolParameterDefault]"]
2222
+ type: "object"
2223
+ title: "Defaults"
2224
+ description: "The default values for the parameters of the function/tool call."
2225
+ "Event":
2226
+ properties:
2227
+ "timestamp":
2228
+ type: "string"
2229
+ format: "date-time"
2230
+ title: "Timestamp"
2231
+ "session_id":
2232
+ anyOf:
2233
+ - type: "string"
2234
+ - type: "null"
2235
+ title: "Session Id"
2236
+ "conversation_id":
2237
+ anyOf:
2238
+ - type: "string"
2239
+ - type: "null"
2240
+ title: "Conversation Id"
2241
+ "source":
2242
+ anyOf:
2243
+ - type: "string"
2244
+ - type: "null"
2245
+ title: "Source"
2246
+ "source_id":
2247
+ anyOf:
2248
+ - type: "string"
2249
+ - type: "null"
2250
+ title: "Source Id"
2251
+ "category":
2252
+ anyOf:
2253
+ - type: "string"
2254
+ - type: "null"
2255
+ title: "Category"
2256
+ "type":
2257
+ anyOf:
2258
+ - type: "string"
2259
+ - type: "null"
2260
+ title: "Type"
2261
+ "user_id":
2262
+ anyOf:
2263
+ - type: "string"
2264
+ - type: "null"
2265
+ title: "User Id"
2266
+ "description":
2267
+ anyOf:
2268
+ - type: "string"
2269
+ - type: "null"
2270
+ title: "Description"
2271
+ "attributes":
2272
+ anyOf:
2273
+ - type: "object"
2274
+ - type: "null"
2275
+ title: "Attributes"
2276
+ type: "object"
2277
+ required:
2278
+ - "timestamp"
2279
+ title: "Event"
2280
+ "EventProperties":
2281
+ type: "string"
2282
+ enum:
2283
+ - "timestamp"
2284
+ - "session_id"
2285
+ - "conversation_id"
2286
+ - "source"
2287
+ - "source_id"
2288
+ - "category"
2289
+ - "type"
2290
+ - "user_id"
2291
+ - "description"
2292
+ - "attributes"
2293
+ title: "EventProperties"
2294
+ "Function":
2295
+ properties:
2296
+ "name":
2297
+ type: "string"
2298
+ title: "Name"
2299
+ description: "The name of the function/tool call."
2300
+ "description":
2301
+ type: "string"
2302
+ title: "Description"
2303
+ description: "The description of the tool."
2304
+ "parameters":
2305
+ type: "object"
2306
+ title: "Parameters"
2307
+ description: "The JSON Schema of parameters of the function/tool call."
2308
+ type: "object"
2309
+ required:
2310
+ - "name"
2311
+ - "description"
2312
+ - "parameters"
2313
+ title: "Function"
2314
+ description: "A tool definition to be used by the OpenAI API. See: - https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling"
2315
+ "HTTPValidationError":
2316
+ properties:
2317
+ "detail":
2318
+ items: {"$ref": "#/components/schemas/ValidationError"}
2319
+ type: "array"
2320
+ title: "Detail"
2321
+ type: "object"
2322
+ title: "HTTPValidationError"
2323
+ "HttpEndpoint":
2324
+ properties:
2325
+ "url":
2326
+ type: "string"
2327
+ title: "Url"
2328
+ description: "The endpoint URL of the external service to call."
2329
+ "method":
2330
+ type: "string"
2331
+ title: "Method"
2332
+ description: "The HTTP method to use for the service call."
2333
+ "argument_location":
2334
+ type: "string"
2335
+ title: "Argument Location"
2336
+ description: "How to pass the arguments to the request."
2337
+ type: "object"
2338
+ required:
2339
+ - "url"
2340
+ - "method"
2341
+ - "argument_location"
2342
+ title: "HttpEndpoint"
2343
+ description: "The configuration for an HTTP API call."
2344
+ "ListResponse_Agent_":
2345
+ properties:
2346
+ "items":
2347
+ items: {"$ref": "#/components/schemas/Agent"}
2348
+ type: "array"
2349
+ title: "Items"
2350
+ "page":
2351
+ type: "integer"
2352
+ title: "Page"
2353
+ "page_size":
2354
+ type: "integer"
2355
+ title: "Page Size"
2356
+ "total_pages":
2357
+ type: "integer"
2358
+ title: "Total Pages"
2359
+ "total_count":
2360
+ type: "integer"
2361
+ title: "Total Count"
2362
+ type: "object"
2363
+ required:
2364
+ - "items"
2365
+ - "page"
2366
+ - "page_size"
2367
+ - "total_pages"
2368
+ - "total_count"
2369
+ title: "ListResponse[Agent]"
2370
+ "ListResponse_AvailableTarget_":
2371
+ properties:
2372
+ "items":
2373
+ items: {"$ref": "#/components/schemas/AvailableTarget"}
2374
+ type: "array"
2375
+ title: "Items"
2376
+ "page":
2377
+ type: "integer"
2378
+ title: "Page"
2379
+ "page_size":
2380
+ type: "integer"
2381
+ title: "Page Size"
2382
+ "total_pages":
2383
+ type: "integer"
2384
+ title: "Total Pages"
2385
+ "total_count":
2386
+ type: "integer"
2387
+ title: "Total Count"
2388
+ type: "object"
2389
+ required:
2390
+ - "items"
2391
+ - "page"
2392
+ - "page_size"
2393
+ - "total_pages"
2394
+ - "total_count"
2395
+ title: "ListResponse[AvailableTarget]"
2396
+ "ListResponse_ChannelTarget_":
2397
+ properties:
2398
+ "items":
2399
+ items: {"$ref": "#/components/schemas/ChannelTarget"}
2400
+ type: "array"
2401
+ title: "Items"
2402
+ "page":
2403
+ type: "integer"
2404
+ title: "Page"
2405
+ "page_size":
2406
+ type: "integer"
2407
+ title: "Page Size"
2408
+ "total_pages":
2409
+ type: "integer"
2410
+ title: "Total Pages"
2411
+ "total_count":
2412
+ type: "integer"
2413
+ title: "Total Count"
2414
+ type: "object"
2415
+ required:
2416
+ - "items"
2417
+ - "page"
2418
+ - "page_size"
2419
+ - "total_pages"
2420
+ - "total_count"
2421
+ title: "ListResponse[ChannelTarget]"
2422
+ "ListResponse_Channel_":
2423
+ properties:
2424
+ "items":
2425
+ items: {"$ref": "#/components/schemas/Channel"}
2426
+ type: "array"
2427
+ title: "Items"
2428
+ "page":
2429
+ type: "integer"
2430
+ title: "Page"
2431
+ "page_size":
2432
+ type: "integer"
2433
+ title: "Page Size"
2434
+ "total_pages":
2435
+ type: "integer"
2436
+ title: "Total Pages"
2437
+ "total_count":
2438
+ type: "integer"
2439
+ title: "Total Count"
2440
+ type: "object"
2441
+ required:
2442
+ - "items"
2443
+ - "page"
2444
+ - "page_size"
2445
+ - "total_pages"
2446
+ - "total_count"
2447
+ title: "ListResponse[Channel]"
2448
+ "ListResponse_Conversation_":
2449
+ properties:
2450
+ "items":
2451
+ items: {"$ref": "#/components/schemas/Conversation"}
2452
+ type: "array"
2453
+ title: "Items"
2454
+ "page":
2455
+ type: "integer"
2456
+ title: "Page"
2457
+ "page_size":
2458
+ type: "integer"
2459
+ title: "Page Size"
2460
+ "total_pages":
2461
+ type: "integer"
2462
+ title: "Total Pages"
2463
+ "total_count":
2464
+ type: "integer"
2465
+ title: "Total Count"
2466
+ type: "object"
2467
+ required:
2468
+ - "items"
2469
+ - "page"
2470
+ - "page_size"
2471
+ - "total_pages"
2472
+ - "total_count"
2473
+ title: "ListResponse[Conversation]"
2474
+ "ListResponse_CustomMessage_":
2475
+ properties:
2476
+ "items":
2477
+ items: {"$ref": "#/components/schemas/CustomMessage"}
2478
+ type: "array"
2479
+ title: "Items"
2480
+ "page":
2481
+ type: "integer"
2482
+ title: "Page"
2483
+ "page_size":
2484
+ type: "integer"
2485
+ title: "Page Size"
2486
+ "total_pages":
2487
+ type: "integer"
2488
+ title: "Total Pages"
2489
+ "total_count":
2490
+ type: "integer"
2491
+ title: "Total Count"
2492
+ type: "object"
2493
+ required:
2494
+ - "items"
2495
+ - "page"
2496
+ - "page_size"
2497
+ - "total_pages"
2498
+ - "total_count"
2499
+ title: "ListResponse[CustomMessage]"
2500
+ "ListResponse_Event_":
2501
+ properties:
2502
+ "items":
2503
+ items: {"$ref": "#/components/schemas/Event"}
2504
+ type: "array"
2505
+ title: "Items"
2506
+ "page":
2507
+ type: "integer"
2508
+ title: "Page"
2509
+ "page_size":
2510
+ type: "integer"
2511
+ title: "Page Size"
2512
+ "total_pages":
2513
+ type: "integer"
2514
+ title: "Total Pages"
2515
+ "total_count":
2516
+ type: "integer"
2517
+ title: "Total Count"
2518
+ type: "object"
2519
+ required:
2520
+ - "items"
2521
+ - "page"
2522
+ - "page_size"
2523
+ - "total_pages"
2524
+ - "total_count"
2525
+ title: "ListResponse[Event]"
2526
+ "ListResponse_Prompt_":
2527
+ properties:
2528
+ "items":
2529
+ items: {"$ref": "#/components/schemas/Prompt"}
2530
+ type: "array"
2531
+ title: "Items"
2532
+ "page":
2533
+ type: "integer"
2534
+ title: "Page"
2535
+ "page_size":
2536
+ type: "integer"
2537
+ title: "Page Size"
2538
+ "total_pages":
2539
+ type: "integer"
2540
+ title: "Total Pages"
2541
+ "total_count":
2542
+ type: "integer"
2543
+ title: "Total Count"
2544
+ type: "object"
2545
+ required:
2546
+ - "items"
2547
+ - "page"
2548
+ - "page_size"
2549
+ - "total_pages"
2550
+ - "total_count"
2551
+ title: "ListResponse[Prompt]"
2552
+ "ListResponse_SchemasBubblegumV2ToolsTool_":
2553
+ properties:
2554
+ "items":
2555
+ items: {"$ref": "#/components/schemas/SchemasBubblegumV2ToolsTool"}
2556
+ type: "array"
2557
+ title: "Items"
2558
+ "page":
2559
+ type: "integer"
2560
+ title: "Page"
2561
+ "page_size":
2562
+ type: "integer"
2563
+ title: "Page Size"
2564
+ "total_pages":
2565
+ type: "integer"
2566
+ title: "Total Pages"
2567
+ "total_count":
2568
+ type: "integer"
2569
+ title: "Total Count"
2570
+ type: "object"
2571
+ required:
2572
+ - "items"
2573
+ - "page"
2574
+ - "page_size"
2575
+ - "total_pages"
2576
+ - "total_count"
2577
+ title: "ListResponse[SchemasBubblegumV2ToolsTool]"
2578
+ "ListResponse_Session_":
2579
+ properties:
2580
+ "items":
2581
+ items: {"$ref": "#/components/schemas/Session"}
2582
+ type: "array"
2583
+ title: "Items"
2584
+ "page":
2585
+ type: "integer"
2586
+ title: "Page"
2587
+ "page_size":
2588
+ type: "integer"
2589
+ title: "Page Size"
2590
+ "total_pages":
2591
+ type: "integer"
2592
+ title: "Total Pages"
2593
+ "total_count":
2594
+ type: "integer"
2595
+ title: "Total Count"
2596
+ type: "object"
2597
+ required:
2598
+ - "items"
2599
+ - "page"
2600
+ - "page_size"
2601
+ - "total_pages"
2602
+ - "total_count"
2603
+ title: "ListResponse[Session]"
2604
+ "LlmConfig":
2605
+ properties:
2606
+ "provider":
2607
+ anyOf:
2608
+ - {"$ref": "#/components/schemas/Provider"}
2609
+ - type: "null"
2610
+ description: "Provider of the LLM model."
2611
+ "model":
2612
+ anyOf:
2613
+ - type: "string"
2614
+ - type: "null"
2615
+ title: "Model"
2616
+ description: "Name of the model. Must match the deployment name in Azure AI Studio."
2617
+ default: "gpt-4o"
2618
+ "version":
2619
+ anyOf:
2620
+ - type: "string"
2621
+ - type: "null"
2622
+ title: "Version"
2623
+ "api_version":
2624
+ anyOf:
2625
+ - type: "string"
2626
+ - type: "null"
2627
+ title: "Api Version"
2628
+ type: "object"
2629
+ title: "LlmConfig"
2630
+ description: "LlmConfig"
2631
+ "OrderByDirection":
2632
+ type: "string"
2633
+ enum:
2634
+ - "asc"
2635
+ - "desc"
2636
+ title: "OrderByDirection"
2637
+ "Organization":
2638
+ properties:
2639
+ "id":
2640
+ type: "integer"
2641
+ title: "Id"
2642
+ description: "The organization ID"
2643
+ "name":
2644
+ type: "string"
2645
+ title: "Name"
2646
+ description: "The organization name"
2647
+ "display_name":
2648
+ type: "string"
2649
+ title: "Display Name"
2650
+ description: "The organization display name"
2651
+ type: "object"
2652
+ required:
2653
+ - "id"
2654
+ - "name"
2655
+ - "display_name"
2656
+ title: "Organization"
2657
+ "Prompt":
2658
+ properties:
2659
+ "name":
2660
+ type: "string"
2661
+ title: "Name"
2662
+ description: "The Prompt name"
2663
+ "type":
2664
+ type: "string"
2665
+ title: "Type"
2666
+ description: "The type of the prompt"
2667
+ "context":
2668
+ anyOf:
2669
+ - type: "string"
2670
+ - type: "null"
2671
+ title: "Context"
2672
+ "tools":
2673
+ anyOf:
2674
+ - items:
2675
+ type: "string"
2676
+ type: "array"
2677
+ - type: "null"
2678
+ title: "Tools"
2679
+ description: "The tools for the prompt"
2680
+ "llm_config":
2681
+ allOf:
2682
+ - {"$ref": "#/components/schemas/LlmConfig"}
2683
+ description: "The configuration for the language model used by the Cortex API."
2684
+ "id":
2685
+ type: "integer"
2686
+ title: "Id"
2687
+ description: "The Prompt ID"
2688
+ "last_updated":
2689
+ anyOf:
2690
+ - type: "string"
2691
+ - type: "null"
2692
+ title: "Last Updated"
2693
+ type: "object"
2694
+ required:
2695
+ - "name"
2696
+ - "type"
2697
+ - "llm_config"
2698
+ - "id"
2699
+ - "last_updated"
2700
+ title: "Prompt"
2701
+ description: "Prompt"
2702
+ "PromptCreate":
2703
+ properties:
2704
+ "name":
2705
+ type: "string"
2706
+ title: "Name"
2707
+ description: "The Prompt name"
2708
+ "type":
2709
+ type: "string"
2710
+ title: "Type"
2711
+ description: "The type of the prompt"
2712
+ "context":
2713
+ anyOf:
2714
+ - type: "string"
2715
+ - type: "null"
2716
+ title: "Context"
2717
+ "tools":
2718
+ anyOf:
2719
+ - items:
2720
+ type: "string"
2721
+ type: "array"
2722
+ - type: "null"
2723
+ title: "Tools"
2724
+ description: "The tools for the prompt"
2725
+ "llm_config":
2726
+ allOf:
2727
+ - {"$ref": "#/components/schemas/LlmConfig"}
2728
+ description: "The configuration for the language model used by the Cortex API."
2729
+ type: "object"
2730
+ required:
2731
+ - "name"
2732
+ - "type"
2733
+ - "llm_config"
2734
+ title: "PromptCreate"
2735
+ description: "PromptCreate"
2736
+ "PromptProperties":
2737
+ type: "string"
2738
+ enum:
2739
+ - "id"
2740
+ - "name"
2741
+ - "context"
2742
+ - "tools"
2743
+ - "llm_config"
2744
+ title: "PromptProperties"
2745
+ "Provider":
2746
+ type: "string"
2747
+ enum:
2748
+ - "azure_openai"
2749
+ - "openai"
2750
+ title: "Provider"
2751
+ description: "LLM API provider."
2752
+ "SchemasBubblegumV2ToolsTool":
2753
+ properties:
2754
+ "name":
2755
+ type: "string"
2756
+ title: "Name"
2757
+ description: "The name of the tool"
2758
+ "definition":
2759
+ anyOf:
2760
+ - {"$ref": "#/components/schemas/ToolDefinition"}
2761
+ - type: "null"
2762
+ description: "The definition of the tool"
2763
+ "service_id":
2764
+ type: "integer"
2765
+ title: "Service Id"
2766
+ description: "The service this tool belongs to"
2767
+ "id":
2768
+ type: "integer"
2769
+ title: "Id"
2770
+ description: "The ID of the tool"
2771
+ "service_name":
2772
+ anyOf:
2773
+ - type: "string"
2774
+ - type: "null"
2775
+ title: "Service Name"
2776
+ type: "object"
2777
+ required:
2778
+ - "name"
2779
+ - "service_id"
2780
+ - "id"
2781
+ title: "SchemasBubblegumV2ToolsTool"
2782
+ description: "SchemasBubblegumV2ToolsTool"
2783
+ "SchemasCortexV1ToolsTool":
2784
+ properties:
2785
+ "type":
2786
+ anyOf:
2787
+ - type: "string"
2788
+ - type: "null"
2789
+ title: "Type"
2790
+ description: "Always `function`."
2791
+ default: "function"
2792
+ "function":
2793
+ allOf:
2794
+ - {"$ref": "#/components/schemas/Function"}
2795
+ description: "The tool definition including the JSON Schema of its parameters."
2796
+ type: "object"
2797
+ required:
2798
+ - "function"
2799
+ title: "SchemasCortexV1ToolsTool"
2800
+ description: "A tool definition to be used by the OpenAI API."
2801
+ "Session":
2802
+ properties:
2803
+ "timestamp":
2804
+ type: "string"
2805
+ format: "date-time"
2806
+ title: "Timestamp"
2807
+ "session_id":
2808
+ anyOf:
2809
+ - type: "string"
2810
+ - type: "null"
2811
+ title: "Session Id"
2812
+ "conversation_id":
2813
+ anyOf:
2814
+ - type: "string"
2815
+ - type: "null"
2816
+ title: "Conversation Id"
2817
+ "channel_manager_service":
2818
+ anyOf:
2819
+ - type: "string"
2820
+ - type: "null"
2821
+ title: "Channel Manager Service"
2822
+ "channel_manager_type":
2823
+ anyOf:
2824
+ - type: "string"
2825
+ - type: "null"
2826
+ title: "Channel Manager Type"
2827
+ "channel_manager_sid":
2828
+ anyOf:
2829
+ - type: "string"
2830
+ - type: "null"
2831
+ title: "Channel Manager Sid"
2832
+ "source":
2833
+ anyOf:
2834
+ - type: "string"
2835
+ - type: "null"
2836
+ title: "Source"
2837
+ "target":
2838
+ anyOf:
2839
+ - type: "string"
2840
+ - type: "null"
2841
+ title: "Target"
2842
+ "is_legacy":
2843
+ anyOf:
2844
+ - type: "boolean"
2845
+ - type: "null"
2846
+ title: "Is Legacy"
2847
+ "is_test":
2848
+ anyOf:
2849
+ - type: "boolean"
2850
+ - type: "null"
2851
+ title: "Is Test"
2852
+ type: "object"
2853
+ required:
2854
+ - "timestamp"
2855
+ title: "Session"
2856
+ "SessionProperties":
2857
+ type: "string"
2858
+ enum:
2859
+ - "timestamp"
2860
+ - "session_id"
2861
+ - "conversation_id"
2862
+ - "channel_manager_service"
2863
+ - "channel_manager_type"
2864
+ - "channel_manager_sid"
2865
+ - "source"
2866
+ - "target"
2867
+ - "is_legacy"
2868
+ - "is_test"
2869
+ title: "SessionProperties"
2870
+ "TestMessage":
2871
+ properties:
2872
+ "service_name":
2873
+ type: "string"
2874
+ title: "Service Name"
2875
+ description: "Name of the service producing the message"
2876
+ "source":
2877
+ type: "string"
2878
+ title: "Source"
2879
+ description: "Name of the source of the message, should identify the user, like an email or username"
2880
+ "text":
2881
+ anyOf:
2882
+ - type: "string"
2883
+ - type: "null"
2884
+ title: "Text"
2885
+ "test_id":
2886
+ type: "string"
2887
+ title: "Test Id"
2888
+ "agent_id":
2889
+ type: "string"
2890
+ title: "Agent Id"
2891
+ "org_name":
2892
+ type: "string"
2893
+ title: "Org Name"
2894
+ type: "object"
2895
+ required:
2896
+ - "service_name"
2897
+ - "source"
2898
+ - "test_id"
2899
+ - "agent_id"
2900
+ - "org_name"
2901
+ title: "TestMessage"
2902
+ "TestMessageResponse":
2903
+ properties:
2904
+ "test_id":
2905
+ type: "string"
2906
+ title: "Test Id"
2907
+ "agent_id":
2908
+ type: "string"
2909
+ title: "Agent Id"
2910
+ "text":
2911
+ type: "string"
2912
+ title: "Text"
2913
+ "response":
2914
+ type: "object"
2915
+ title: "Response"
2916
+ type: "object"
2917
+ required:
2918
+ - "test_id"
2919
+ - "agent_id"
2920
+ - "text"
2921
+ title: "TestMessageResponse"
2922
+ "ToolDefinition":
2923
+ properties:
2924
+ "type":
2925
+ anyOf:
2926
+ - type: "string"
2927
+ - type: "null"
2928
+ title: "Type"
2929
+ "tool":
2930
+ allOf:
2931
+ - {"$ref": "#/components/schemas/SchemasCortexV1ToolsTool"}
2932
+ description: "The tool definition to be used by the OpenAI API."
2933
+ "endpoint":
2934
+ anyOf:
2935
+ - {"$ref": "#/components/schemas/HttpEndpoint"}
2936
+ - type: "null"
2937
+ "defaults":
2938
+ anyOf:
2939
+ - {"$ref": "#/components/schemas/Defaults"}
2940
+ - type: "null"
2941
+ "result":
2942
+ anyOf:
2943
+ - type: "object"
2944
+ - type: "null"
2945
+ title: "Result"
2946
+ type: "object"
2947
+ required:
2948
+ - "tool"
2949
+ title: "ToolDefinition"
2950
+ description: "A tool that can be called from GPT during the conversation. The tool can result in one of the following actions depending on the `type` field: - `action`: An `ActionRequest` to return to Bubblegum in `GetResponseResponse`. - `endpoint`: An HTTP API call to an external tool. Requires the `endpoint` field to be set too. - `context`: Sets context variables based on the tool arguments, e.g. to change the session language. Only `language` and `say` context vars are currently supported, but this will be made more generic. For example, to change the current session language: ``` { \"type\": \"context\", \"tool\": { \"function\": { \"name\": \"set_language\", \"parameters\": { \"language\": { \"type\": \"string\", \"description\": \"The ISO 639 language code to set for the session e.g. 'en-US'.\" }, \"message\": { \"type\": \"string\", \"description\": \"Inform the caller we're now speaking in the new language.\" } } } } } ``` If `defaults` is provided, it will be used as the default values for the parameters of the tool call, if GPT doesn't provide them: ``` \"defaults\": { \"hospital\": \"Queens Hospital\" } ``` Some special \"transform\" handling is supported if the value is a dict with a single `transform` key. The parameter value will be transformed by the given `action` before being used as the default value: Removing an unwanted parameter: ``` \"defaults\": { \"hospital\": { \"transform\": { \"action\": \"remove\" } } } ``` Add custom parameters from other parameters using Python's `format`: ``` \"defaults\": { \"hello\": { \"transform\": { \"format\": \"Hello, {name}!\" } } } Modify a value conditionally, e.g. change a `city` parameter with value \"Bronx\" to \"The Bronx\": ``` { \"defaults\": { \"city\": { \"transform\": { \"when\": {\"operator\": \"eq\", \"key\": \"city\", \"value\": \"Bronx\"}, \"action\": \"override\", \"format\": \"The {city}\" } } } } ```"
2951
+ "ToolDetailResponse":
2952
+ properties:
2953
+ "name":
2954
+ type: "string"
2955
+ title: "Name"
2956
+ "description":
2957
+ type: "string"
2958
+ title: "Description"
2959
+ "fields":
2960
+ items:
2961
+ type: "string"
2962
+ type: "array"
2963
+ title: "Fields"
2964
+ type: "object"
2965
+ required:
2966
+ - "name"
2967
+ - "description"
2968
+ - "fields"
2969
+ title: "ToolDetailResponse"
2970
+ "ToolParameterDefault":
2971
+ properties:
2972
+ "transform":
2973
+ allOf:
2974
+ - {"$ref": "#/components/schemas/ToolParameterTransform"}
2975
+ description: "The transform to apply to the value before using it as the default."
2976
+ type: "object"
2977
+ required:
2978
+ - "transform"
2979
+ title: "ToolParameterDefault"
2980
+ description: "The default value for a parameter of the tool call."
2981
+ "ToolParameterTransform":
2982
+ properties:
2983
+ "when":
2984
+ anyOf:
2985
+ - {"$ref": "#/components/schemas/ToolParameterTransformCondition"}
2986
+ - type: "null"
2987
+ "action":
2988
+ anyOf:
2989
+ - type: "string"
2990
+ - type: "null"
2991
+ title: "Action"
2992
+ description: "The action to perform on the value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value."
2993
+ default: "default"
2994
+ "format":
2995
+ anyOf:
2996
+ - type: "string"
2997
+ - type: "null"
2998
+ title: "Format"
2999
+ type: "object"
3000
+ title: "ToolParameterTransform"
3001
+ description: "A transform to be applied to the value of a parameter."
3002
+ "ToolParameterTransformCondition":
3003
+ properties:
3004
+ "key":
3005
+ type: "string"
3006
+ title: "Key"
3007
+ description: "The name of the parameter to check."
3008
+ "value":
3009
+ type: "string"
3010
+ title: "Value"
3011
+ description: "The value to check against the parameter."
3012
+ "operator":
3013
+ anyOf:
3014
+ - type: "string"
3015
+ - type: "null"
3016
+ title: "Operator"
3017
+ type: "object"
3018
+ required:
3019
+ - "key"
3020
+ - "value"
3021
+ title: "ToolParameterTransformCondition"
3022
+ description: "A condition to be met for a transform to be applied to the value of a parameter."
3023
+ "ToolProperties":
3024
+ type: "string"
3025
+ enum:
3026
+ - "id"
3027
+ - "name"
3028
+ - "service_name"
3029
+ - "definition"
3030
+ - "service_id"
3031
+ title: "ToolProperties"
3032
+ "ValidationError":
3033
+ properties:
3034
+ "loc":
3035
+ items:
3036
+ anyOf:
3037
+ - type: "string"
3038
+ - type: "integer"
3039
+ type: "array"
3040
+ title: "Location"
3041
+ "msg":
3042
+ type: "string"
3043
+ title: "Message"
3044
+ "type":
3045
+ type: "string"
3046
+ title: "Error Type"
3047
+ type: "object"
3048
+ required:
3049
+ - "loc"
3050
+ - "msg"
3051
+ - "type"
3052
+ title: "ValidationError"
3053
+ securitySchemes:
3054
+ "APIKeyHeader":
3055
+ type: "apiKey"
3056
+ in: "header"
3057
+ name: "Syllable-API-Key"
3058
+ tags:
3059
+ - name: "agents"
3060
+ description: "Operations related to agents"
3061
+ - name: "agents.test"
3062
+ description: "Operations for testing agents with live text"
3063
+ - name: "channels"
3064
+ description: "Operations related to channels"
3065
+ - name: "channels.targets"
3066
+ description: "Operations related to channel targets"
3067
+ - name: "conversations"
3068
+ description: "Operations related to conversations"
3069
+ - name: "custom_messages"
3070
+ description: "Operations related to custom messages"
3071
+ - name: "dashboards"
3072
+ description: "Operations related to system dashboard"
3073
+ - name: "events"
3074
+ description: "Operations related to agent events"
3075
+ - name: "organizations"
3076
+ description: "Operations related to organizations"
3077
+ - name: "prompts"
3078
+ description: "Operations related to prompts"
3079
+ - name: "sessions"
3080
+ description: "Operations related to agent sessions"
3081
+ - name: "tools"
3082
+ description: "Operations related to tools"
3083
+ x-speakeasy-name-override: [{"operationId": ".*_list$", "methodNameOverride": "list"}, {"operationId": ".*_create$", "methodNameOverride": "create"}, {"operationId": ".*_update$", "methodNameOverride": "update"}, {"operationId": ".*_delete$", "methodNameOverride": "delete"}, {"operationId": ".*_get_by_id$", "methodNameOverride": "get_by_id"}, {"operationId": ".*_get_by_name$", "methodNameOverride": "get_by_name"}]