@orq-ai/node 3.14.5-rc.1 → 3.14.6

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 (494) hide show
  1. package/bin/mcp-server.js +213 -210
  2. package/bin/mcp-server.js.map +38 -38
  3. package/docs/sdks/agents/README.md +4 -8
  4. package/docs/sdks/budgets/README.md +2 -4
  5. package/docs/sdks/tools/README.md +2 -4
  6. package/examples/package-lock.json +6 -5
  7. package/jsr.json +1 -1
  8. package/lib/config.d.ts +2 -2
  9. package/lib/config.js +2 -2
  10. package/lib/config.js.map +1 -1
  11. package/mcp-server/mcp-server.js +1 -1
  12. package/mcp-server/mcp-server.js.map +1 -1
  13. package/mcp-server/server.js +1 -1
  14. package/mcp-server/server.js.map +1 -1
  15. package/models/operations/createbudget.js +2 -2
  16. package/models/operations/createcontact.js +2 -2
  17. package/models/operations/createdataset.js +2 -2
  18. package/models/operations/createdatasetitem.js +8 -8
  19. package/models/operations/createdatasource.js +2 -2
  20. package/models/operations/createeval.js +28 -28
  21. package/models/operations/createtool.js +10 -10
  22. package/models/operations/duplicatetool.js +10 -10
  23. package/models/operations/fileget.js +2 -2
  24. package/models/operations/filelist.js +2 -2
  25. package/models/operations/fileupload.js +2 -2
  26. package/models/operations/getalltools.js +10 -10
  27. package/models/operations/getbudget.js +2 -2
  28. package/models/operations/getevals.js +28 -28
  29. package/models/operations/listbudgets.js +2 -2
  30. package/models/operations/listcontacts.js +2 -2
  31. package/models/operations/listdatasetdatapoints.js +8 -8
  32. package/models/operations/listdatasets.js +2 -2
  33. package/models/operations/listdatasources.js +2 -2
  34. package/models/operations/retrievecontact.js +2 -2
  35. package/models/operations/retrievedatapoint.js +8 -8
  36. package/models/operations/retrievedataset.js +2 -2
  37. package/models/operations/retrievedatasource.js +2 -2
  38. package/models/operations/retrievetool.js +10 -10
  39. package/models/operations/updatebudget.js +2 -2
  40. package/models/operations/updatecontact.js +2 -2
  41. package/models/operations/updatedatapoint.js +8 -8
  42. package/models/operations/updatedataset.js +2 -2
  43. package/models/operations/updatedatasource.js +2 -2
  44. package/models/operations/updateeval.js +28 -28
  45. package/models/operations/updatetool.js +10 -10
  46. package/package.json +4 -4
  47. package/packages/orq-rc/FUNCTIONS.md +103 -0
  48. package/packages/orq-rc/README.md +909 -0
  49. package/packages/orq-rc/RUNTIMES.md +48 -0
  50. package/packages/orq-rc/docs/sdks/agents/README.md +1319 -0
  51. package/packages/orq-rc/docs/sdks/budgets/README.md +401 -0
  52. package/packages/orq-rc/docs/sdks/chunking/README.md +95 -0
  53. package/packages/orq-rc/docs/sdks/contacts/README.md +450 -0
  54. package/packages/orq-rc/docs/sdks/datasets/README.md +836 -0
  55. package/packages/orq-rc/docs/sdks/deployments/README.md +312 -0
  56. package/packages/orq-rc/docs/sdks/evals/README.md +339 -0
  57. package/packages/orq-rc/docs/sdks/feedback/README.md +89 -0
  58. package/packages/orq-rc/docs/sdks/files/README.md +301 -0
  59. package/packages/orq-rc/docs/sdks/knowledge/README.md +1489 -0
  60. package/packages/orq-rc/docs/sdks/memorystores/README.md +1172 -0
  61. package/packages/orq-rc/docs/sdks/metrics/README.md +83 -0
  62. package/packages/orq-rc/docs/sdks/models/README.md +76 -0
  63. package/packages/orq-rc/docs/sdks/prompts/README.md +591 -0
  64. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +77 -0
  65. package/packages/orq-rc/docs/sdks/tools/README.md +490 -0
  66. package/packages/orq-rc/examples/README.md +31 -0
  67. package/packages/orq-rc/examples/contactsCreate.example.ts +42 -0
  68. package/packages/orq-rc/examples/package-lock.json +627 -0
  69. package/packages/orq-rc/examples/package.json +18 -0
  70. package/packages/orq-rc/jsr.json +28 -0
  71. package/packages/orq-rc/package-lock.json +3071 -0
  72. package/packages/orq-rc/package.json +43 -0
  73. package/packages/orq-rc/src/core.ts +13 -0
  74. package/packages/orq-rc/src/funcs/agentsCreate.ts +172 -0
  75. package/packages/orq-rc/src/funcs/agentsDelete.ts +176 -0
  76. package/packages/orq-rc/src/funcs/agentsInvoke.ts +167 -0
  77. package/packages/orq-rc/src/funcs/agentsList.ts +167 -0
  78. package/packages/orq-rc/src/funcs/agentsListActions.ts +169 -0
  79. package/packages/orq-rc/src/funcs/agentsListTasks.ts +183 -0
  80. package/packages/orq-rc/src/funcs/agentsRetrieve.ts +175 -0
  81. package/packages/orq-rc/src/funcs/agentsRetrieveAction.ts +173 -0
  82. package/packages/orq-rc/src/funcs/agentsRetrieveTask.ts +179 -0
  83. package/packages/orq-rc/src/funcs/agentsRun.ts +163 -0
  84. package/packages/orq-rc/src/funcs/agentsStream.ts +190 -0
  85. package/packages/orq-rc/src/funcs/agentsStreamRun.ts +188 -0
  86. package/packages/orq-rc/src/funcs/agentsUpdate.ts +176 -0
  87. package/packages/orq-rc/src/funcs/budgetsCreate.ts +160 -0
  88. package/packages/orq-rc/src/funcs/budgetsDelete.ts +167 -0
  89. package/packages/orq-rc/src/funcs/budgetsGet.ts +166 -0
  90. package/packages/orq-rc/src/funcs/budgetsList.ts +170 -0
  91. package/packages/orq-rc/src/funcs/budgetsUpdate.ts +167 -0
  92. package/packages/orq-rc/src/funcs/chunkingParse.ts +160 -0
  93. package/packages/orq-rc/src/funcs/contactsCreate.ts +165 -0
  94. package/packages/orq-rc/src/funcs/contactsDelete.ts +176 -0
  95. package/packages/orq-rc/src/funcs/contactsList.ts +169 -0
  96. package/packages/orq-rc/src/funcs/contactsRetrieve.ts +175 -0
  97. package/packages/orq-rc/src/funcs/contactsUpdate.ts +176 -0
  98. package/packages/orq-rc/src/funcs/datasetsClear.ts +167 -0
  99. package/packages/orq-rc/src/funcs/datasetsCreate.ts +165 -0
  100. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +171 -0
  101. package/packages/orq-rc/src/funcs/datasetsDelete.ts +167 -0
  102. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +182 -0
  103. package/packages/orq-rc/src/funcs/datasetsList.ts +167 -0
  104. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +174 -0
  105. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +175 -0
  106. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +181 -0
  107. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +176 -0
  108. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +179 -0
  109. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +168 -0
  110. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +176 -0
  111. package/packages/orq-rc/src/funcs/deploymentsList.ts +176 -0
  112. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +168 -0
  113. package/packages/orq-rc/src/funcs/deploymentsStream.ts +183 -0
  114. package/packages/orq-rc/src/funcs/evalsAll.ts +173 -0
  115. package/packages/orq-rc/src/funcs/evalsCreate.ts +169 -0
  116. package/packages/orq-rc/src/funcs/evalsDelete.ts +173 -0
  117. package/packages/orq-rc/src/funcs/evalsUpdate.ts +173 -0
  118. package/packages/orq-rc/src/funcs/feedbackCreate.ts +160 -0
  119. package/packages/orq-rc/src/funcs/filesCreate.ts +187 -0
  120. package/packages/orq-rc/src/funcs/filesDelete.ts +164 -0
  121. package/packages/orq-rc/src/funcs/filesGet.ts +166 -0
  122. package/packages/orq-rc/src/funcs/filesList.ts +167 -0
  123. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +158 -0
  124. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +171 -0
  125. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +166 -0
  126. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +167 -0
  127. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +174 -0
  128. package/packages/orq-rc/src/funcs/knowledgeDeleteChunks.ts +170 -0
  129. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +173 -0
  130. package/packages/orq-rc/src/funcs/knowledgeGetChunksCount.ts +170 -0
  131. package/packages/orq-rc/src/funcs/knowledgeList.ts +169 -0
  132. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +178 -0
  133. package/packages/orq-rc/src/funcs/knowledgeListChunksPaginated.ts +171 -0
  134. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +174 -0
  135. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +166 -0
  136. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +173 -0
  137. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +169 -0
  138. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +167 -0
  139. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +164 -0
  140. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +174 -0
  141. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +170 -0
  142. package/packages/orq-rc/src/funcs/memoryStoresCreate.ts +171 -0
  143. package/packages/orq-rc/src/funcs/memoryStoresCreateDocument.ts +175 -0
  144. package/packages/orq-rc/src/funcs/memoryStoresCreateMemory.ts +170 -0
  145. package/packages/orq-rc/src/funcs/memoryStoresDelete.ts +168 -0
  146. package/packages/orq-rc/src/funcs/memoryStoresDeleteDocument.ts +184 -0
  147. package/packages/orq-rc/src/funcs/memoryStoresDeleteMemory.ts +179 -0
  148. package/packages/orq-rc/src/funcs/memoryStoresList.ts +178 -0
  149. package/packages/orq-rc/src/funcs/memoryStoresListDocuments.ts +181 -0
  150. package/packages/orq-rc/src/funcs/memoryStoresListMemories.ts +176 -0
  151. package/packages/orq-rc/src/funcs/memoryStoresRetrieve.ts +177 -0
  152. package/packages/orq-rc/src/funcs/memoryStoresRetrieveDocument.ts +178 -0
  153. package/packages/orq-rc/src/funcs/memoryStoresRetrieveMemory.ts +173 -0
  154. package/packages/orq-rc/src/funcs/memoryStoresUpdate.ts +168 -0
  155. package/packages/orq-rc/src/funcs/memoryStoresUpdateDocument.ts +179 -0
  156. package/packages/orq-rc/src/funcs/memoryStoresUpdateMemory.ts +174 -0
  157. package/packages/orq-rc/src/funcs/modelsList.ts +142 -0
  158. package/packages/orq-rc/src/funcs/promptsCreate.ts +160 -0
  159. package/packages/orq-rc/src/funcs/promptsDelete.ts +164 -0
  160. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +181 -0
  161. package/packages/orq-rc/src/funcs/promptsList.ts +167 -0
  162. package/packages/orq-rc/src/funcs/promptsListVersions.ts +173 -0
  163. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +166 -0
  164. package/packages/orq-rc/src/funcs/promptsUpdate.ts +173 -0
  165. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +161 -0
  166. package/packages/orq-rc/src/funcs/toolsCreate.ts +163 -0
  167. package/packages/orq-rc/src/funcs/toolsDelete.ts +167 -0
  168. package/packages/orq-rc/src/funcs/toolsDuplicate.ts +175 -0
  169. package/packages/orq-rc/src/funcs/toolsList.ts +176 -0
  170. package/packages/orq-rc/src/funcs/toolsRetrieve.ts +166 -0
  171. package/packages/orq-rc/src/funcs/toolsUpdate.ts +176 -0
  172. package/packages/orq-rc/src/hooks/global.ts +44 -0
  173. package/packages/orq-rc/src/hooks/hooks.ts +132 -0
  174. package/packages/orq-rc/src/hooks/index.ts +6 -0
  175. package/packages/orq-rc/src/hooks/registration.ts +15 -0
  176. package/packages/orq-rc/src/hooks/types.ts +112 -0
  177. package/packages/orq-rc/src/index.ts +9 -0
  178. package/packages/orq-rc/src/lib/base64.ts +37 -0
  179. package/packages/orq-rc/src/lib/config.ts +74 -0
  180. package/packages/orq-rc/src/lib/dlv.ts +53 -0
  181. package/packages/orq-rc/src/lib/encodings.ts +483 -0
  182. package/packages/orq-rc/src/lib/env.ts +89 -0
  183. package/packages/orq-rc/src/lib/event-streams.ts +135 -0
  184. package/packages/orq-rc/src/lib/files.ts +82 -0
  185. package/packages/orq-rc/src/lib/http.ts +323 -0
  186. package/packages/orq-rc/src/lib/is-plain-object.ts +43 -0
  187. package/packages/orq-rc/src/lib/logger.ts +9 -0
  188. package/packages/orq-rc/src/lib/matchers.ts +345 -0
  189. package/packages/orq-rc/src/lib/primitives.ts +150 -0
  190. package/packages/orq-rc/src/lib/retries.ts +218 -0
  191. package/packages/orq-rc/src/lib/schemas.ts +91 -0
  192. package/packages/orq-rc/src/lib/sdks.ts +407 -0
  193. package/packages/orq-rc/src/lib/security.ts +264 -0
  194. package/packages/orq-rc/src/lib/url.ts +33 -0
  195. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +111 -0
  196. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +136 -0
  197. package/packages/orq-rc/src/mcp-server/cli.ts +13 -0
  198. package/packages/orq-rc/src/mcp-server/console-logger.ts +71 -0
  199. package/packages/orq-rc/src/mcp-server/extensions.ts +17 -0
  200. package/packages/orq-rc/src/mcp-server/mcp-server.ts +26 -0
  201. package/packages/orq-rc/src/mcp-server/prompts.ts +117 -0
  202. package/packages/orq-rc/src/mcp-server/resources.ts +172 -0
  203. package/packages/orq-rc/src/mcp-server/scopes.ts +7 -0
  204. package/packages/orq-rc/src/mcp-server/server.ts +259 -0
  205. package/packages/orq-rc/src/mcp-server/shared.ts +74 -0
  206. package/packages/orq-rc/src/mcp-server/tools/agentsCreate.ts +37 -0
  207. package/packages/orq-rc/src/mcp-server/tools/agentsDelete.ts +35 -0
  208. package/packages/orq-rc/src/mcp-server/tools/agentsInvoke.ts +37 -0
  209. package/packages/orq-rc/src/mcp-server/tools/agentsList.ts +37 -0
  210. package/packages/orq-rc/src/mcp-server/tools/agentsListActions.ts +35 -0
  211. package/packages/orq-rc/src/mcp-server/tools/agentsListTasks.ts +37 -0
  212. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieve.ts +37 -0
  213. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveAction.ts +35 -0
  214. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveTask.ts +37 -0
  215. package/packages/orq-rc/src/mcp-server/tools/agentsRun.ts +37 -0
  216. package/packages/orq-rc/src/mcp-server/tools/agentsStream.ts +37 -0
  217. package/packages/orq-rc/src/mcp-server/tools/agentsStreamRun.ts +37 -0
  218. package/packages/orq-rc/src/mcp-server/tools/agentsUpdate.ts +37 -0
  219. package/packages/orq-rc/src/mcp-server/tools/budgetsCreate.ts +37 -0
  220. package/packages/orq-rc/src/mcp-server/tools/budgetsDelete.ts +35 -0
  221. package/packages/orq-rc/src/mcp-server/tools/budgetsGet.ts +37 -0
  222. package/packages/orq-rc/src/mcp-server/tools/budgetsList.ts +37 -0
  223. package/packages/orq-rc/src/mcp-server/tools/budgetsUpdate.ts +37 -0
  224. package/packages/orq-rc/src/mcp-server/tools/chunkingParse.ts +37 -0
  225. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +37 -0
  226. package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +35 -0
  227. package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +37 -0
  228. package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +37 -0
  229. package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +37 -0
  230. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +35 -0
  231. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +37 -0
  232. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +37 -0
  233. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +35 -0
  234. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +35 -0
  235. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +37 -0
  236. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +37 -0
  237. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +37 -0
  238. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +37 -0
  239. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +37 -0
  240. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +35 -0
  241. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +37 -0
  242. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +37 -0
  243. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +37 -0
  244. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +37 -0
  245. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +37 -0
  246. package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +35 -0
  247. package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +35 -0
  248. package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +33 -0
  249. package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +35 -0
  250. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +37 -0
  251. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +37 -0
  252. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +33 -0
  253. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +37 -0
  254. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +37 -0
  255. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +35 -0
  256. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +35 -0
  257. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +35 -0
  258. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +35 -0
  259. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +33 -0
  260. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunks.ts +35 -0
  261. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +35 -0
  262. package/packages/orq-rc/src/mcp-server/tools/knowledgeGetChunksCount.ts +35 -0
  263. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +37 -0
  264. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +35 -0
  265. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunksPaginated.ts +35 -0
  266. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +35 -0
  267. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +37 -0
  268. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +35 -0
  269. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +35 -0
  270. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +37 -0
  271. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +35 -0
  272. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +35 -0
  273. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +35 -0
  274. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreate.ts +35 -0
  275. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateDocument.ts +37 -0
  276. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateMemory.ts +37 -0
  277. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDelete.ts +35 -0
  278. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteDocument.ts +40 -0
  279. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteMemory.ts +40 -0
  280. package/packages/orq-rc/src/mcp-server/tools/memoryStoresList.ts +37 -0
  281. package/packages/orq-rc/src/mcp-server/tools/memoryStoresListDocuments.ts +37 -0
  282. package/packages/orq-rc/src/mcp-server/tools/memoryStoresListMemories.ts +37 -0
  283. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieve.ts +37 -0
  284. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveDocument.ts +37 -0
  285. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveMemory.ts +37 -0
  286. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdate.ts +37 -0
  287. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateDocument.ts +37 -0
  288. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateMemory.ts +37 -0
  289. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +30 -0
  290. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +35 -0
  291. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +33 -0
  292. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +37 -0
  293. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +37 -0
  294. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +37 -0
  295. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +37 -0
  296. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +35 -0
  297. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +36 -0
  298. package/packages/orq-rc/src/mcp-server/tools/toolsCreate.ts +37 -0
  299. package/packages/orq-rc/src/mcp-server/tools/toolsDelete.ts +35 -0
  300. package/packages/orq-rc/src/mcp-server/tools/toolsDuplicate.ts +37 -0
  301. package/packages/orq-rc/src/mcp-server/tools/toolsList.ts +37 -0
  302. package/packages/orq-rc/src/mcp-server/tools/toolsRetrieve.ts +37 -0
  303. package/packages/orq-rc/src/mcp-server/tools/toolsUpdate.ts +37 -0
  304. package/packages/orq-rc/src/mcp-server/tools.ts +129 -0
  305. package/packages/orq-rc/src/models/components/deployments.ts +8147 -0
  306. package/packages/orq-rc/src/models/components/index.ts +6 -0
  307. package/packages/orq-rc/src/models/components/security.ts +71 -0
  308. package/packages/orq-rc/src/models/errors/apierror.ts +40 -0
  309. package/packages/orq-rc/src/models/errors/createagent.ts +80 -0
  310. package/packages/orq-rc/src/models/errors/createeval.ts +80 -0
  311. package/packages/orq-rc/src/models/errors/deleteagent.ts +80 -0
  312. package/packages/orq-rc/src/models/errors/deletecontact.ts +91 -0
  313. package/packages/orq-rc/src/models/errors/deleteeval.ts +80 -0
  314. package/packages/orq-rc/src/models/errors/duplicatetool.ts +91 -0
  315. package/packages/orq-rc/src/models/errors/getagent.ts +80 -0
  316. package/packages/orq-rc/src/models/errors/getagenttask.ts +80 -0
  317. package/packages/orq-rc/src/models/errors/getevals.ts +80 -0
  318. package/packages/orq-rc/src/models/errors/getpromptversion.ts +80 -0
  319. package/packages/orq-rc/src/models/errors/honoapierror.ts +90 -0
  320. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
  321. package/packages/orq-rc/src/models/errors/index.ts +29 -0
  322. package/packages/orq-rc/src/models/errors/listagenttasks.ts +80 -0
  323. package/packages/orq-rc/src/models/errors/orqerror.ts +35 -0
  324. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +50 -0
  325. package/packages/orq-rc/src/models/errors/retrievecontact.ts +91 -0
  326. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +109 -0
  327. package/packages/orq-rc/src/models/errors/streamagent.ts +80 -0
  328. package/packages/orq-rc/src/models/errors/streamrunagent.ts +80 -0
  329. package/packages/orq-rc/src/models/errors/updateagent.ts +80 -0
  330. package/packages/orq-rc/src/models/errors/updatecontact.ts +83 -0
  331. package/packages/orq-rc/src/models/errors/updateeval.ts +80 -0
  332. package/packages/orq-rc/src/models/errors/updateprompt.ts +80 -0
  333. package/packages/orq-rc/src/models/errors/updatetool.ts +91 -0
  334. package/packages/orq-rc/src/models/operations/cleardataset.ts +78 -0
  335. package/packages/orq-rc/src/models/operations/createagent.ts +3104 -0
  336. package/packages/orq-rc/src/models/operations/createbudget.ts +745 -0
  337. package/packages/orq-rc/src/models/operations/createchunk.ts +428 -0
  338. package/packages/orq-rc/src/models/operations/createcontact.ts +267 -0
  339. package/packages/orq-rc/src/models/operations/createdataset.ts +302 -0
  340. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +6943 -0
  341. package/packages/orq-rc/src/models/operations/createdatasource.ts +852 -0
  342. package/packages/orq-rc/src/models/operations/createeval.ts +9341 -0
  343. package/packages/orq-rc/src/models/operations/createfeedback.ts +286 -0
  344. package/packages/orq-rc/src/models/operations/createknowledge.ts +1850 -0
  345. package/packages/orq-rc/src/models/operations/creatememory.ts +274 -0
  346. package/packages/orq-rc/src/models/operations/creatememorydocument.ts +287 -0
  347. package/packages/orq-rc/src/models/operations/creatememorystore.ts +2032 -0
  348. package/packages/orq-rc/src/models/operations/createprompt.ts +7812 -0
  349. package/packages/orq-rc/src/models/operations/createtool.ts +4077 -0
  350. package/packages/orq-rc/src/models/operations/deleteagent.ts +78 -0
  351. package/packages/orq-rc/src/models/operations/deletebudget.ts +69 -0
  352. package/packages/orq-rc/src/models/operations/deletechunk.ts +96 -0
  353. package/packages/orq-rc/src/models/operations/deletechunks.ts +243 -0
  354. package/packages/orq-rc/src/models/operations/deletecontact.ts +69 -0
  355. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +87 -0
  356. package/packages/orq-rc/src/models/operations/deletedataset.ts +78 -0
  357. package/packages/orq-rc/src/models/operations/deletedatasource.ts +87 -0
  358. package/packages/orq-rc/src/models/operations/deleteeval.ts +66 -0
  359. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +78 -0
  360. package/packages/orq-rc/src/models/operations/deletememory.ts +87 -0
  361. package/packages/orq-rc/src/models/operations/deletememorydocument.ts +98 -0
  362. package/packages/orq-rc/src/models/operations/deletememorystore.ts +78 -0
  363. package/packages/orq-rc/src/models/operations/deleteprompt.ts +69 -0
  364. package/packages/orq-rc/src/models/operations/deletetool.ts +75 -0
  365. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +6547 -0
  366. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +10532 -0
  367. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +1266 -0
  368. package/packages/orq-rc/src/models/operations/deployments.ts +2606 -0
  369. package/packages/orq-rc/src/models/operations/deploymentstream.ts +10655 -0
  370. package/packages/orq-rc/src/models/operations/duplicatetool.ts +2349 -0
  371. package/packages/orq-rc/src/models/operations/filedelete.ts +78 -0
  372. package/packages/orq-rc/src/models/operations/fileget.ts +223 -0
  373. package/packages/orq-rc/src/models/operations/filelist.ts +337 -0
  374. package/packages/orq-rc/src/models/operations/fileupload.ts +327 -0
  375. package/packages/orq-rc/src/models/operations/getagent.ts +957 -0
  376. package/packages/orq-rc/src/models/operations/getagenttask.ts +259 -0
  377. package/packages/orq-rc/src/models/operations/getallmemories.ts +318 -0
  378. package/packages/orq-rc/src/models/operations/getallmemorydocuments.ts +338 -0
  379. package/packages/orq-rc/src/models/operations/getallmemorystores.ts +1277 -0
  380. package/packages/orq-rc/src/models/operations/getallprompts.ts +2572 -0
  381. package/packages/orq-rc/src/models/operations/getalltools.ts +2308 -0
  382. package/packages/orq-rc/src/models/operations/getbudget.ts +441 -0
  383. package/packages/orq-rc/src/models/operations/getchunkscount.ts +230 -0
  384. package/packages/orq-rc/src/models/operations/getevals.ts +7486 -0
  385. package/packages/orq-rc/src/models/operations/getonechunk.ts +315 -0
  386. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +1292 -0
  387. package/packages/orq-rc/src/models/operations/getoneprompt.ts +2437 -0
  388. package/packages/orq-rc/src/models/operations/getpromptversion.ts +2444 -0
  389. package/packages/orq-rc/src/models/operations/index.ts +102 -0
  390. package/packages/orq-rc/src/models/operations/invokeagent.ts +1569 -0
  391. package/packages/orq-rc/src/models/operations/listactions.ts +526 -0
  392. package/packages/orq-rc/src/models/operations/listagents.ts +1077 -0
  393. package/packages/orq-rc/src/models/operations/listagenttasks.ts +1106 -0
  394. package/packages/orq-rc/src/models/operations/listbudgets.ts +617 -0
  395. package/packages/orq-rc/src/models/operations/listchunks.ts +494 -0
  396. package/packages/orq-rc/src/models/operations/listchunkspaginated.ts +507 -0
  397. package/packages/orq-rc/src/models/operations/listcontacts.ts +500 -0
  398. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +4086 -0
  399. package/packages/orq-rc/src/models/operations/listdatasets.ts +406 -0
  400. package/packages/orq-rc/src/models/operations/listdatasources.ts +454 -0
  401. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +1303 -0
  402. package/packages/orq-rc/src/models/operations/listmodels.ts +273 -0
  403. package/packages/orq-rc/src/models/operations/listpromptversions.ts +2580 -0
  404. package/packages/orq-rc/src/models/operations/parse.ts +1295 -0
  405. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +190 -0
  406. package/packages/orq-rc/src/models/operations/retrieveaction.ts +426 -0
  407. package/packages/orq-rc/src/models/operations/retrievecontact.ts +210 -0
  408. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +3853 -0
  409. package/packages/orq-rc/src/models/operations/retrievedataset.ts +291 -0
  410. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +273 -0
  411. package/packages/orq-rc/src/models/operations/retrievememory.ts +201 -0
  412. package/packages/orq-rc/src/models/operations/retrievememorydocument.ts +220 -0
  413. package/packages/orq-rc/src/models/operations/retrievememorystore.ts +1160 -0
  414. package/packages/orq-rc/src/models/operations/retrievetool.ts +2333 -0
  415. package/packages/orq-rc/src/models/operations/runagent.ts +4342 -0
  416. package/packages/orq-rc/src/models/operations/searchknowledge.ts +3573 -0
  417. package/packages/orq-rc/src/models/operations/streamagent.ts +1367 -0
  418. package/packages/orq-rc/src/models/operations/streamrunagent.ts +4355 -0
  419. package/packages/orq-rc/src/models/operations/updateagent.ts +3321 -0
  420. package/packages/orq-rc/src/models/operations/updatebudget.ts +628 -0
  421. package/packages/orq-rc/src/models/operations/updatechunk.ts +448 -0
  422. package/packages/orq-rc/src/models/operations/updatecontact.ts +325 -0
  423. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +6934 -0
  424. package/packages/orq-rc/src/models/operations/updatedataset.ts +386 -0
  425. package/packages/orq-rc/src/models/operations/updatedatasource.ts +345 -0
  426. package/packages/orq-rc/src/models/operations/updateeval.ts +9704 -0
  427. package/packages/orq-rc/src/models/operations/updateknowledge.ts +2341 -0
  428. package/packages/orq-rc/src/models/operations/updatememory.ts +283 -0
  429. package/packages/orq-rc/src/models/operations/updatememorydocument.ts +296 -0
  430. package/packages/orq-rc/src/models/operations/updatememorystore.ts +1363 -0
  431. package/packages/orq-rc/src/models/operations/updateprompt.ts +8176 -0
  432. package/packages/orq-rc/src/models/operations/updatetool.ts +4288 -0
  433. package/packages/orq-rc/src/sdk/agents.ts +238 -0
  434. package/packages/orq-rc/src/sdk/budgets.ts +99 -0
  435. package/packages/orq-rc/src/sdk/chunking.ts +27 -0
  436. package/packages/orq-rc/src/sdk/contacts.ts +99 -0
  437. package/packages/orq-rc/src/sdk/datasets.ts +204 -0
  438. package/packages/orq-rc/src/sdk/deployments.ts +89 -0
  439. package/packages/orq-rc/src/sdk/evals.ts +69 -0
  440. package/packages/orq-rc/src/sdk/feedback.ts +27 -0
  441. package/packages/orq-rc/src/sdk/files.ts +78 -0
  442. package/packages/orq-rc/src/sdk/index.ts +5 -0
  443. package/packages/orq-rc/src/sdk/knowledge.ts +309 -0
  444. package/packages/orq-rc/src/sdk/memorystores.ts +286 -0
  445. package/packages/orq-rc/src/sdk/metrics.ts +27 -0
  446. package/packages/orq-rc/src/sdk/models.ts +25 -0
  447. package/packages/orq-rc/src/sdk/prompts.ts +126 -0
  448. package/packages/orq-rc/src/sdk/remoteconfigs.ts +24 -0
  449. package/packages/orq-rc/src/sdk/sdk.ts +97 -0
  450. package/packages/orq-rc/src/sdk/tools.ts +117 -0
  451. package/packages/orq-rc/src/types/async.ts +68 -0
  452. package/packages/orq-rc/src/types/blobs.ts +32 -0
  453. package/packages/orq-rc/src/types/constdatetime.ts +15 -0
  454. package/packages/orq-rc/src/types/enums.ts +16 -0
  455. package/packages/orq-rc/src/types/fp.ts +50 -0
  456. package/packages/orq-rc/src/types/index.ts +11 -0
  457. package/packages/orq-rc/src/types/operations.ts +105 -0
  458. package/packages/orq-rc/src/types/rfcdate.ts +54 -0
  459. package/packages/orq-rc/src/types/streams.ts +21 -0
  460. package/packages/orq-rc/tsconfig.json +41 -0
  461. package/src/lib/config.ts +2 -2
  462. package/src/mcp-server/mcp-server.ts +1 -1
  463. package/src/mcp-server/server.ts +1 -1
  464. package/src/models/operations/createbudget.ts +2 -2
  465. package/src/models/operations/createcontact.ts +2 -2
  466. package/src/models/operations/createdataset.ts +2 -2
  467. package/src/models/operations/createdatasetitem.ts +8 -8
  468. package/src/models/operations/createdatasource.ts +2 -2
  469. package/src/models/operations/createeval.ts +28 -28
  470. package/src/models/operations/createtool.ts +10 -10
  471. package/src/models/operations/duplicatetool.ts +10 -10
  472. package/src/models/operations/fileget.ts +2 -2
  473. package/src/models/operations/filelist.ts +2 -2
  474. package/src/models/operations/fileupload.ts +2 -2
  475. package/src/models/operations/getalltools.ts +10 -10
  476. package/src/models/operations/getbudget.ts +2 -2
  477. package/src/models/operations/getevals.ts +28 -28
  478. package/src/models/operations/listbudgets.ts +2 -2
  479. package/src/models/operations/listcontacts.ts +2 -2
  480. package/src/models/operations/listdatasetdatapoints.ts +8 -8
  481. package/src/models/operations/listdatasets.ts +2 -2
  482. package/src/models/operations/listdatasources.ts +2 -2
  483. package/src/models/operations/retrievecontact.ts +2 -2
  484. package/src/models/operations/retrievedatapoint.ts +8 -8
  485. package/src/models/operations/retrievedataset.ts +2 -2
  486. package/src/models/operations/retrievedatasource.ts +2 -2
  487. package/src/models/operations/retrievetool.ts +10 -10
  488. package/src/models/operations/updatebudget.ts +2 -2
  489. package/src/models/operations/updatecontact.ts +2 -2
  490. package/src/models/operations/updatedatapoint.ts +8 -8
  491. package/src/models/operations/updatedataset.ts +2 -2
  492. package/src/models/operations/updatedatasource.ts +2 -2
  493. package/src/models/operations/updateeval.ts +28 -28
  494. package/src/models/operations/updatetool.ts +10 -10
@@ -0,0 +1,1319 @@
1
+ # Agents
2
+ (*agents*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [retrieveTask](#retrievetask) - Retrieve a specific agent task
9
+ * [create](#create) - Create a new agent
10
+ * [list](#list) - List all agents
11
+ * [delete](#delete) - Delete an agent
12
+ * [retrieve](#retrieve) - Get an agent
13
+ * [update](#update) - Update an agent
14
+ * [invoke](#invoke) - Invoke an agent
15
+ * [listTasks](#listtasks) - List all tasks for an agent
16
+ * [run](#run) - Run an agent
17
+ * [streamRun](#streamrun) - Run and stream agent execution
18
+ * [stream](#stream) - Stream agent execution events
19
+ * [listActions](#listactions) - List all actions
20
+ * [retrieveAction](#retrieveaction) - Retrieve an action executed by an agent task.
21
+
22
+ ## retrieveTask
23
+
24
+ Retrieves detailed information about a specific task for a given agent, including execution status and results.
25
+
26
+ ### Example Usage
27
+
28
+ <!-- UsageSnippet language="typescript" operationID="GetAgentTask" method="get" path="/v2/agents/{agent_key}/tasks/{task_id}" -->
29
+ ```typescript
30
+ import { Orq } from "@orq-ai/node";
31
+
32
+ const orq = new Orq({
33
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
34
+ });
35
+
36
+ async function run() {
37
+ const result = await orq.agents.retrieveTask({
38
+ agentKey: "<value>",
39
+ taskId: "<id>",
40
+ });
41
+
42
+ console.log(result);
43
+ }
44
+
45
+ run();
46
+ ```
47
+
48
+ ### Standalone function
49
+
50
+ The standalone function version of this method:
51
+
52
+ ```typescript
53
+ import { OrqCore } from "@orq-ai/node/core.js";
54
+ import { agentsRetrieveTask } from "@orq-ai/node/funcs/agentsRetrieveTask.js";
55
+
56
+ // Use `OrqCore` for best tree-shaking performance.
57
+ // You can create one instance of it to use across an application.
58
+ const orq = new OrqCore({
59
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
60
+ });
61
+
62
+ async function run() {
63
+ const res = await agentsRetrieveTask(orq, {
64
+ agentKey: "<value>",
65
+ taskId: "<id>",
66
+ });
67
+ if (res.ok) {
68
+ const { value: result } = res;
69
+ console.log(result);
70
+ } else {
71
+ console.log("agentsRetrieveTask failed:", res.error);
72
+ }
73
+ }
74
+
75
+ run();
76
+ ```
77
+
78
+ ### Parameters
79
+
80
+ | Parameter | Type | Required | Description |
81
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
82
+ | `request` | [operations.GetAgentTaskRequest](../../models/operations/getagenttaskrequest.md) | :heavy_check_mark: | The request object to use for the request. |
83
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
84
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
85
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
86
+
87
+ ### Response
88
+
89
+ **Promise\<[operations.GetAgentTaskResponseBody](../../models/operations/getagenttaskresponsebody.md)\>**
90
+
91
+ ### Errors
92
+
93
+ | Error Type | Status Code | Content Type |
94
+ | ------------------------------- | ------------------------------- | ------------------------------- |
95
+ | errors.GetAgentTaskResponseBody | 404 | application/json |
96
+ | errors.APIError | 4XX, 5XX | \*/\* |
97
+
98
+ ## create
99
+
100
+ Creates a new AI agent with specified configuration. Agents can be configured with a primary model and an optional fallback model that will be used automatically if the primary model fails.
101
+
102
+ ### Example Usage
103
+
104
+ <!-- UsageSnippet language="typescript" operationID="CreateAgent" method="post" path="/v2/agents/" -->
105
+ ```typescript
106
+ import { Orq } from "@orq-ai/node";
107
+
108
+ const orq = new Orq({
109
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
110
+ });
111
+
112
+ async function run() {
113
+ const result = await orq.agents.create({
114
+ path: "Default",
115
+ key: "<key>",
116
+ role: "<value>",
117
+ description: "neatly unless refine aside platter alarmed shampoo shakily yippee",
118
+ instructions: "<value>",
119
+ model: "Camaro",
120
+ settings: {},
121
+ knowledgeBases: [
122
+ {
123
+ knowledgeId: "customer-knowledge-base",
124
+ },
125
+ ],
126
+ });
127
+
128
+ console.log(result);
129
+ }
130
+
131
+ run();
132
+ ```
133
+
134
+ ### Standalone function
135
+
136
+ The standalone function version of this method:
137
+
138
+ ```typescript
139
+ import { OrqCore } from "@orq-ai/node/core.js";
140
+ import { agentsCreate } from "@orq-ai/node/funcs/agentsCreate.js";
141
+
142
+ // Use `OrqCore` for best tree-shaking performance.
143
+ // You can create one instance of it to use across an application.
144
+ const orq = new OrqCore({
145
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
146
+ });
147
+
148
+ async function run() {
149
+ const res = await agentsCreate(orq, {
150
+ path: "Default",
151
+ key: "<key>",
152
+ role: "<value>",
153
+ description: "neatly unless refine aside platter alarmed shampoo shakily yippee",
154
+ instructions: "<value>",
155
+ model: "Camaro",
156
+ settings: {},
157
+ knowledgeBases: [
158
+ {
159
+ knowledgeId: "customer-knowledge-base",
160
+ },
161
+ ],
162
+ });
163
+ if (res.ok) {
164
+ const { value: result } = res;
165
+ console.log(result);
166
+ } else {
167
+ console.log("agentsCreate failed:", res.error);
168
+ }
169
+ }
170
+
171
+ run();
172
+ ```
173
+
174
+ ### Parameters
175
+
176
+ | Parameter | Type | Required | Description |
177
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
178
+ | `request` | [operations.CreateAgentRequestBody](../../models/operations/createagentrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
179
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
180
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
181
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
182
+
183
+ ### Response
184
+
185
+ **Promise\<[operations.CreateAgentResponseBody](../../models/operations/createagentresponsebody.md)\>**
186
+
187
+ ### Errors
188
+
189
+ | Error Type | Status Code | Content Type |
190
+ | ------------------------------ | ------------------------------ | ------------------------------ |
191
+ | errors.CreateAgentResponseBody | 409 | application/json |
192
+ | errors.APIError | 4XX, 5XX | \*/\* |
193
+
194
+ ## list
195
+
196
+ Retrieves a paginated list of all agents in your workspace. Each agent includes its configuration, primary model, and optional fallback model settings.
197
+
198
+ ### Example Usage
199
+
200
+ <!-- UsageSnippet language="typescript" operationID="ListAgents" method="get" path="/v2/agents/" -->
201
+ ```typescript
202
+ import { Orq } from "@orq-ai/node";
203
+
204
+ const orq = new Orq({
205
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
206
+ });
207
+
208
+ async function run() {
209
+ const result = await orq.agents.list({});
210
+
211
+ console.log(result);
212
+ }
213
+
214
+ run();
215
+ ```
216
+
217
+ ### Standalone function
218
+
219
+ The standalone function version of this method:
220
+
221
+ ```typescript
222
+ import { OrqCore } from "@orq-ai/node/core.js";
223
+ import { agentsList } from "@orq-ai/node/funcs/agentsList.js";
224
+
225
+ // Use `OrqCore` for best tree-shaking performance.
226
+ // You can create one instance of it to use across an application.
227
+ const orq = new OrqCore({
228
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
229
+ });
230
+
231
+ async function run() {
232
+ const res = await agentsList(orq, {});
233
+ if (res.ok) {
234
+ const { value: result } = res;
235
+ console.log(result);
236
+ } else {
237
+ console.log("agentsList failed:", res.error);
238
+ }
239
+ }
240
+
241
+ run();
242
+ ```
243
+
244
+ ### Parameters
245
+
246
+ | Parameter | Type | Required | Description |
247
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
248
+ | `request` | [operations.ListAgentsRequest](../../models/operations/listagentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
249
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
250
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
251
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
252
+
253
+ ### Response
254
+
255
+ **Promise\<[operations.ListAgentsResponseBody](../../models/operations/listagentsresponsebody.md)\>**
256
+
257
+ ### Errors
258
+
259
+ | Error Type | Status Code | Content Type |
260
+ | --------------- | --------------- | --------------- |
261
+ | errors.APIError | 4XX, 5XX | \*/\* |
262
+
263
+ ## delete
264
+
265
+ Permanently deletes an agent and all its configuration, including primary and fallback model settings.
266
+
267
+ ### Example Usage
268
+
269
+ <!-- UsageSnippet language="typescript" operationID="DeleteAgent" method="delete" path="/v2/agents/{agent_key}" -->
270
+ ```typescript
271
+ import { Orq } from "@orq-ai/node";
272
+
273
+ const orq = new Orq({
274
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
275
+ });
276
+
277
+ async function run() {
278
+ await orq.agents.delete({
279
+ agentKey: "<value>",
280
+ });
281
+
282
+
283
+ }
284
+
285
+ run();
286
+ ```
287
+
288
+ ### Standalone function
289
+
290
+ The standalone function version of this method:
291
+
292
+ ```typescript
293
+ import { OrqCore } from "@orq-ai/node/core.js";
294
+ import { agentsDelete } from "@orq-ai/node/funcs/agentsDelete.js";
295
+
296
+ // Use `OrqCore` for best tree-shaking performance.
297
+ // You can create one instance of it to use across an application.
298
+ const orq = new OrqCore({
299
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
300
+ });
301
+
302
+ async function run() {
303
+ const res = await agentsDelete(orq, {
304
+ agentKey: "<value>",
305
+ });
306
+ if (res.ok) {
307
+ const { value: result } = res;
308
+
309
+ } else {
310
+ console.log("agentsDelete failed:", res.error);
311
+ }
312
+ }
313
+
314
+ run();
315
+ ```
316
+
317
+ ### Parameters
318
+
319
+ | Parameter | Type | Required | Description |
320
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
321
+ | `request` | [operations.DeleteAgentRequest](../../models/operations/deleteagentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
322
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
323
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
324
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
325
+
326
+ ### Response
327
+
328
+ **Promise\<void\>**
329
+
330
+ ### Errors
331
+
332
+ | Error Type | Status Code | Content Type |
333
+ | ------------------------------ | ------------------------------ | ------------------------------ |
334
+ | errors.DeleteAgentResponseBody | 404 | application/json |
335
+ | errors.APIError | 4XX, 5XX | \*/\* |
336
+
337
+ ## retrieve
338
+
339
+ Retrieves a single agent by its unique key, including its full configuration with primary and fallback model settings.
340
+
341
+ ### Example Usage
342
+
343
+ <!-- UsageSnippet language="typescript" operationID="GetAgent" method="get" path="/v2/agents/{agent_key}" -->
344
+ ```typescript
345
+ import { Orq } from "@orq-ai/node";
346
+
347
+ const orq = new Orq({
348
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
349
+ });
350
+
351
+ async function run() {
352
+ const result = await orq.agents.retrieve({
353
+ agentKey: "<value>",
354
+ });
355
+
356
+ console.log(result);
357
+ }
358
+
359
+ run();
360
+ ```
361
+
362
+ ### Standalone function
363
+
364
+ The standalone function version of this method:
365
+
366
+ ```typescript
367
+ import { OrqCore } from "@orq-ai/node/core.js";
368
+ import { agentsRetrieve } from "@orq-ai/node/funcs/agentsRetrieve.js";
369
+
370
+ // Use `OrqCore` for best tree-shaking performance.
371
+ // You can create one instance of it to use across an application.
372
+ const orq = new OrqCore({
373
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
374
+ });
375
+
376
+ async function run() {
377
+ const res = await agentsRetrieve(orq, {
378
+ agentKey: "<value>",
379
+ });
380
+ if (res.ok) {
381
+ const { value: result } = res;
382
+ console.log(result);
383
+ } else {
384
+ console.log("agentsRetrieve failed:", res.error);
385
+ }
386
+ }
387
+
388
+ run();
389
+ ```
390
+
391
+ ### Parameters
392
+
393
+ | Parameter | Type | Required | Description |
394
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
395
+ | `request` | [operations.GetAgentRequest](../../models/operations/getagentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
396
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
397
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
398
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
399
+
400
+ ### Response
401
+
402
+ **Promise\<[operations.GetAgentResponseBody](../../models/operations/getagentresponsebody.md)\>**
403
+
404
+ ### Errors
405
+
406
+ | Error Type | Status Code | Content Type |
407
+ | --------------------------- | --------------------------- | --------------------------- |
408
+ | errors.GetAgentResponseBody | 404 | application/json |
409
+ | errors.APIError | 4XX, 5XX | \*/\* |
410
+
411
+ ## update
412
+
413
+ Updates an existing agent's configuration. You can update various fields including the model configuration and fallback model settings.
414
+
415
+ ### Example Usage
416
+
417
+ <!-- UsageSnippet language="typescript" operationID="UpdateAgent" method="patch" path="/v2/agents/{agent_key}" -->
418
+ ```typescript
419
+ import { Orq } from "@orq-ai/node";
420
+
421
+ const orq = new Orq({
422
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
423
+ });
424
+
425
+ async function run() {
426
+ const result = await orq.agents.update({
427
+ agentKey: "<value>",
428
+ requestBody: {
429
+ path: "Default",
430
+ knowledgeBases: [
431
+ {
432
+ knowledgeId: "customer-knowledge-base",
433
+ },
434
+ ],
435
+ },
436
+ });
437
+
438
+ console.log(result);
439
+ }
440
+
441
+ run();
442
+ ```
443
+
444
+ ### Standalone function
445
+
446
+ The standalone function version of this method:
447
+
448
+ ```typescript
449
+ import { OrqCore } from "@orq-ai/node/core.js";
450
+ import { agentsUpdate } from "@orq-ai/node/funcs/agentsUpdate.js";
451
+
452
+ // Use `OrqCore` for best tree-shaking performance.
453
+ // You can create one instance of it to use across an application.
454
+ const orq = new OrqCore({
455
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
456
+ });
457
+
458
+ async function run() {
459
+ const res = await agentsUpdate(orq, {
460
+ agentKey: "<value>",
461
+ requestBody: {
462
+ path: "Default",
463
+ knowledgeBases: [
464
+ {
465
+ knowledgeId: "customer-knowledge-base",
466
+ },
467
+ ],
468
+ },
469
+ });
470
+ if (res.ok) {
471
+ const { value: result } = res;
472
+ console.log(result);
473
+ } else {
474
+ console.log("agentsUpdate failed:", res.error);
475
+ }
476
+ }
477
+
478
+ run();
479
+ ```
480
+
481
+ ### Parameters
482
+
483
+ | Parameter | Type | Required | Description |
484
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
485
+ | `request` | [operations.UpdateAgentRequest](../../models/operations/updateagentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
486
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
487
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
488
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
489
+
490
+ ### Response
491
+
492
+ **Promise\<[operations.UpdateAgentResponseBody](../../models/operations/updateagentresponsebody.md)\>**
493
+
494
+ ### Errors
495
+
496
+ | Error Type | Status Code | Content Type |
497
+ | ------------------------------ | ------------------------------ | ------------------------------ |
498
+ | errors.UpdateAgentResponseBody | 404 | application/json |
499
+ | errors.APIError | 4XX, 5XX | \*/\* |
500
+
501
+ ## invoke
502
+
503
+ Executes an existing agent with the provided input. The agent uses its pre-configured primary model and will automatically fall back to its configured fallback model if the primary model fails. Fallback models are configured at the agent level, not during execution.
504
+
505
+ ### Example Usage
506
+
507
+ <!-- UsageSnippet language="typescript" operationID="InvokeAgent" method="post" path="/v2/agents/{key}/task" -->
508
+ ```typescript
509
+ import { Orq } from "@orq-ai/node";
510
+
511
+ const orq = new Orq({
512
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
513
+ });
514
+
515
+ async function run() {
516
+ const result = await orq.agents.invoke({
517
+ key: "<key>",
518
+ requestBody: {
519
+ message: {
520
+ role: "user",
521
+ parts: [],
522
+ },
523
+ contact: {
524
+ id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
525
+ displayName: "Jane Doe",
526
+ email: "jane.doe@example.com",
527
+ metadata: [
528
+ {
529
+ "department": "Engineering",
530
+ "role": "Senior Developer",
531
+ },
532
+ ],
533
+ logoUrl: "https://example.com/avatars/jane-doe.jpg",
534
+ tags: [
535
+ "hr",
536
+ "engineering",
537
+ ],
538
+ },
539
+ thread: {
540
+ id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
541
+ tags: [
542
+ "customer-support",
543
+ "priority-high",
544
+ ],
545
+ },
546
+ },
547
+ });
548
+
549
+ console.log(result);
550
+ }
551
+
552
+ run();
553
+ ```
554
+
555
+ ### Standalone function
556
+
557
+ The standalone function version of this method:
558
+
559
+ ```typescript
560
+ import { OrqCore } from "@orq-ai/node/core.js";
561
+ import { agentsInvoke } from "@orq-ai/node/funcs/agentsInvoke.js";
562
+
563
+ // Use `OrqCore` for best tree-shaking performance.
564
+ // You can create one instance of it to use across an application.
565
+ const orq = new OrqCore({
566
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
567
+ });
568
+
569
+ async function run() {
570
+ const res = await agentsInvoke(orq, {
571
+ key: "<key>",
572
+ requestBody: {
573
+ message: {
574
+ role: "user",
575
+ parts: [],
576
+ },
577
+ contact: {
578
+ id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
579
+ displayName: "Jane Doe",
580
+ email: "jane.doe@example.com",
581
+ metadata: [
582
+ {
583
+ "department": "Engineering",
584
+ "role": "Senior Developer",
585
+ },
586
+ ],
587
+ logoUrl: "https://example.com/avatars/jane-doe.jpg",
588
+ tags: [
589
+ "hr",
590
+ "engineering",
591
+ ],
592
+ },
593
+ thread: {
594
+ id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
595
+ tags: [
596
+ "customer-support",
597
+ "priority-high",
598
+ ],
599
+ },
600
+ },
601
+ });
602
+ if (res.ok) {
603
+ const { value: result } = res;
604
+ console.log(result);
605
+ } else {
606
+ console.log("agentsInvoke failed:", res.error);
607
+ }
608
+ }
609
+
610
+ run();
611
+ ```
612
+
613
+ ### Parameters
614
+
615
+ | Parameter | Type | Required | Description |
616
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
617
+ | `request` | [operations.InvokeAgentRequest](../../models/operations/invokeagentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
618
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
619
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
620
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
621
+
622
+ ### Response
623
+
624
+ **Promise\<[operations.InvokeAgentResponseBody](../../models/operations/invokeagentresponsebody.md)\>**
625
+
626
+ ### Errors
627
+
628
+ | Error Type | Status Code | Content Type |
629
+ | --------------- | --------------- | --------------- |
630
+ | errors.APIError | 4XX, 5XX | \*/\* |
631
+
632
+ ## listTasks
633
+
634
+ Retrieves a paginated list of all tasks associated with a specific agent, optionally filtered by status.
635
+
636
+ ### Example Usage
637
+
638
+ <!-- UsageSnippet language="typescript" operationID="ListAgentTasks" method="get" path="/v2/agents/{agent_key}/tasks" -->
639
+ ```typescript
640
+ import { Orq } from "@orq-ai/node";
641
+
642
+ const orq = new Orq({
643
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
644
+ });
645
+
646
+ async function run() {
647
+ const result = await orq.agents.listTasks({
648
+ agentKey: "<value>",
649
+ });
650
+
651
+ console.log(result);
652
+ }
653
+
654
+ run();
655
+ ```
656
+
657
+ ### Standalone function
658
+
659
+ The standalone function version of this method:
660
+
661
+ ```typescript
662
+ import { OrqCore } from "@orq-ai/node/core.js";
663
+ import { agentsListTasks } from "@orq-ai/node/funcs/agentsListTasks.js";
664
+
665
+ // Use `OrqCore` for best tree-shaking performance.
666
+ // You can create one instance of it to use across an application.
667
+ const orq = new OrqCore({
668
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
669
+ });
670
+
671
+ async function run() {
672
+ const res = await agentsListTasks(orq, {
673
+ agentKey: "<value>",
674
+ });
675
+ if (res.ok) {
676
+ const { value: result } = res;
677
+ console.log(result);
678
+ } else {
679
+ console.log("agentsListTasks failed:", res.error);
680
+ }
681
+ }
682
+
683
+ run();
684
+ ```
685
+
686
+ ### Parameters
687
+
688
+ | Parameter | Type | Required | Description |
689
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
690
+ | `request` | [operations.ListAgentTasksRequest](../../models/operations/listagenttasksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
691
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
692
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
693
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
694
+
695
+ ### Response
696
+
697
+ **Promise\<[operations.ListAgentTasksResponseBody](../../models/operations/listagenttasksresponsebody.md)\>**
698
+
699
+ ### Errors
700
+
701
+ | Error Type | Status Code | Content Type |
702
+ | --------------------------------- | --------------------------------- | --------------------------------- |
703
+ | errors.ListAgentTasksResponseBody | 404 | application/json |
704
+ | errors.APIError | 4XX, 5XX | \*/\* |
705
+
706
+ ## run
707
+
708
+ Executes an agent with the provided configuration using A2A message format. If the agent already exists with the same configuration, it will be reused. If the configuration differs, a new version is created. The fallback model is configured at the agent level and will be used automatically if the primary model fails during execution.
709
+
710
+ ### Example Usage
711
+
712
+ <!-- UsageSnippet language="typescript" operationID="RunAgent" method="post" path="/v2/agents/run" -->
713
+ ```typescript
714
+ import { Orq } from "@orq-ai/node";
715
+
716
+ const orq = new Orq({
717
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
718
+ });
719
+
720
+ async function run() {
721
+ const result = await orq.agents.run({
722
+ key: "<key>",
723
+ model: "F-150",
724
+ role: "<value>",
725
+ instructions: "<value>",
726
+ message: {
727
+ role: "tool",
728
+ parts: [
729
+ {
730
+ kind: "file",
731
+ file: {
732
+ uri: "https://front-pecan.info",
733
+ },
734
+ },
735
+ ],
736
+ },
737
+ contact: {
738
+ id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
739
+ displayName: "Jane Doe",
740
+ email: "jane.doe@example.com",
741
+ metadata: [
742
+ {
743
+ "department": "Engineering",
744
+ "role": "Senior Developer",
745
+ },
746
+ ],
747
+ logoUrl: "https://example.com/avatars/jane-doe.jpg",
748
+ tags: [
749
+ "hr",
750
+ "engineering",
751
+ ],
752
+ },
753
+ thread: {
754
+ id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
755
+ tags: [
756
+ "customer-support",
757
+ "priority-high",
758
+ ],
759
+ },
760
+ path: "Default",
761
+ knowledgeBases: [
762
+ {
763
+ knowledgeId: "customer-knowledge-base",
764
+ },
765
+ ],
766
+ settings: {},
767
+ });
768
+
769
+ console.log(result);
770
+ }
771
+
772
+ run();
773
+ ```
774
+
775
+ ### Standalone function
776
+
777
+ The standalone function version of this method:
778
+
779
+ ```typescript
780
+ import { OrqCore } from "@orq-ai/node/core.js";
781
+ import { agentsRun } from "@orq-ai/node/funcs/agentsRun.js";
782
+
783
+ // Use `OrqCore` for best tree-shaking performance.
784
+ // You can create one instance of it to use across an application.
785
+ const orq = new OrqCore({
786
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
787
+ });
788
+
789
+ async function run() {
790
+ const res = await agentsRun(orq, {
791
+ key: "<key>",
792
+ model: "F-150",
793
+ role: "<value>",
794
+ instructions: "<value>",
795
+ message: {
796
+ role: "tool",
797
+ parts: [
798
+ {
799
+ kind: "file",
800
+ file: {
801
+ uri: "https://front-pecan.info",
802
+ },
803
+ },
804
+ ],
805
+ },
806
+ contact: {
807
+ id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
808
+ displayName: "Jane Doe",
809
+ email: "jane.doe@example.com",
810
+ metadata: [
811
+ {
812
+ "department": "Engineering",
813
+ "role": "Senior Developer",
814
+ },
815
+ ],
816
+ logoUrl: "https://example.com/avatars/jane-doe.jpg",
817
+ tags: [
818
+ "hr",
819
+ "engineering",
820
+ ],
821
+ },
822
+ thread: {
823
+ id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
824
+ tags: [
825
+ "customer-support",
826
+ "priority-high",
827
+ ],
828
+ },
829
+ path: "Default",
830
+ knowledgeBases: [
831
+ {
832
+ knowledgeId: "customer-knowledge-base",
833
+ },
834
+ ],
835
+ settings: {},
836
+ });
837
+ if (res.ok) {
838
+ const { value: result } = res;
839
+ console.log(result);
840
+ } else {
841
+ console.log("agentsRun failed:", res.error);
842
+ }
843
+ }
844
+
845
+ run();
846
+ ```
847
+
848
+ ### Parameters
849
+
850
+ | Parameter | Type | Required | Description |
851
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
852
+ | `request` | [operations.RunAgentRequestBody](../../models/operations/runagentrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
853
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
854
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
855
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
856
+
857
+ ### Response
858
+
859
+ **Promise\<[operations.RunAgentResponseBody](../../models/operations/runagentresponsebody.md)\>**
860
+
861
+ ### Errors
862
+
863
+ | Error Type | Status Code | Content Type |
864
+ | --------------- | --------------- | --------------- |
865
+ | errors.APIError | 4XX, 5XX | \*/\* |
866
+
867
+ ## streamRun
868
+
869
+ Creates or updates an agent with the provided configuration, then streams execution events via Server-Sent Events (SSE). If the agent already exists with the same configuration, it will be reused. If the configuration differs, a new version is created. The stream will continue until the agent completes, errors, or reaches the configured timeout.
870
+
871
+ ### Example Usage
872
+
873
+ <!-- UsageSnippet language="typescript" operationID="StreamRunAgent" method="post" path="/v2/agents/stream-run" -->
874
+ ```typescript
875
+ import { Orq } from "@orq-ai/node";
876
+
877
+ const orq = new Orq({
878
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
879
+ });
880
+
881
+ async function run() {
882
+ const result = await orq.agents.streamRun({
883
+ key: "<key>",
884
+ model: "Alpine",
885
+ role: "<value>",
886
+ instructions: "<value>",
887
+ message: {
888
+ role: "user",
889
+ parts: [
890
+ {
891
+ kind: "file",
892
+ file: {
893
+ uri: "https://jumbo-zebra.info/",
894
+ },
895
+ },
896
+ ],
897
+ },
898
+ contact: {
899
+ id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
900
+ displayName: "Jane Doe",
901
+ email: "jane.doe@example.com",
902
+ metadata: [
903
+ {
904
+ "department": "Engineering",
905
+ "role": "Senior Developer",
906
+ },
907
+ ],
908
+ logoUrl: "https://example.com/avatars/jane-doe.jpg",
909
+ tags: [
910
+ "hr",
911
+ "engineering",
912
+ ],
913
+ },
914
+ thread: {
915
+ id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
916
+ tags: [
917
+ "customer-support",
918
+ "priority-high",
919
+ ],
920
+ },
921
+ path: "Default",
922
+ knowledgeBases: [
923
+ {
924
+ knowledgeId: "customer-knowledge-base",
925
+ },
926
+ ],
927
+ settings: {},
928
+ });
929
+
930
+ for await (const event of result) {
931
+ console.log(event);
932
+ }
933
+ }
934
+
935
+ run();
936
+ ```
937
+
938
+ ### Standalone function
939
+
940
+ The standalone function version of this method:
941
+
942
+ ```typescript
943
+ import { OrqCore } from "@orq-ai/node/core.js";
944
+ import { agentsStreamRun } from "@orq-ai/node/funcs/agentsStreamRun.js";
945
+
946
+ // Use `OrqCore` for best tree-shaking performance.
947
+ // You can create one instance of it to use across an application.
948
+ const orq = new OrqCore({
949
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
950
+ });
951
+
952
+ async function run() {
953
+ const res = await agentsStreamRun(orq, {
954
+ key: "<key>",
955
+ model: "Alpine",
956
+ role: "<value>",
957
+ instructions: "<value>",
958
+ message: {
959
+ role: "user",
960
+ parts: [
961
+ {
962
+ kind: "file",
963
+ file: {
964
+ uri: "https://jumbo-zebra.info/",
965
+ },
966
+ },
967
+ ],
968
+ },
969
+ contact: {
970
+ id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
971
+ displayName: "Jane Doe",
972
+ email: "jane.doe@example.com",
973
+ metadata: [
974
+ {
975
+ "department": "Engineering",
976
+ "role": "Senior Developer",
977
+ },
978
+ ],
979
+ logoUrl: "https://example.com/avatars/jane-doe.jpg",
980
+ tags: [
981
+ "hr",
982
+ "engineering",
983
+ ],
984
+ },
985
+ thread: {
986
+ id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
987
+ tags: [
988
+ "customer-support",
989
+ "priority-high",
990
+ ],
991
+ },
992
+ path: "Default",
993
+ knowledgeBases: [
994
+ {
995
+ knowledgeId: "customer-knowledge-base",
996
+ },
997
+ ],
998
+ settings: {},
999
+ });
1000
+ if (res.ok) {
1001
+ const { value: result } = res;
1002
+ for await (const event of result) {
1003
+ console.log(event);
1004
+ }
1005
+ } else {
1006
+ console.log("agentsStreamRun failed:", res.error);
1007
+ }
1008
+ }
1009
+
1010
+ run();
1011
+ ```
1012
+
1013
+ ### Parameters
1014
+
1015
+ | Parameter | Type | Required | Description |
1016
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1017
+ | `request` | [operations.StreamRunAgentRequestBody](../../models/operations/streamrunagentrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1018
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1019
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1020
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1021
+
1022
+ ### Response
1023
+
1024
+ **Promise\<[EventStream<operations.StreamRunAgentResponseBody>](../../models/.md)\>**
1025
+
1026
+ ### Errors
1027
+
1028
+ | Error Type | Status Code | Content Type |
1029
+ | --------------------------------- | --------------------------------- | --------------------------------- |
1030
+ | errors.StreamRunAgentResponseBody | 404 | application/json |
1031
+ | errors.APIError | 4XX, 5XX | \*/\* |
1032
+
1033
+ ## stream
1034
+
1035
+ Executes an agent and streams events via Server-Sent Events (SSE). The stream will continue until the agent completes, errors, or reaches the configured timeout.
1036
+
1037
+ ### Example Usage
1038
+
1039
+ <!-- UsageSnippet language="typescript" operationID="StreamAgent" method="post" path="/v2/agents/{key}/stream-task" -->
1040
+ ```typescript
1041
+ import { Orq } from "@orq-ai/node";
1042
+
1043
+ const orq = new Orq({
1044
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1045
+ });
1046
+
1047
+ async function run() {
1048
+ const result = await orq.agents.stream({
1049
+ key: "<key>",
1050
+ requestBody: {
1051
+ message: {
1052
+ role: "user",
1053
+ parts: [],
1054
+ },
1055
+ contact: {
1056
+ id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
1057
+ displayName: "Jane Doe",
1058
+ email: "jane.doe@example.com",
1059
+ metadata: [
1060
+ {
1061
+ "department": "Engineering",
1062
+ "role": "Senior Developer",
1063
+ },
1064
+ ],
1065
+ logoUrl: "https://example.com/avatars/jane-doe.jpg",
1066
+ tags: [
1067
+ "hr",
1068
+ "engineering",
1069
+ ],
1070
+ },
1071
+ thread: {
1072
+ id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
1073
+ tags: [
1074
+ "customer-support",
1075
+ "priority-high",
1076
+ ],
1077
+ },
1078
+ },
1079
+ });
1080
+
1081
+ for await (const event of result) {
1082
+ console.log(event);
1083
+ }
1084
+ }
1085
+
1086
+ run();
1087
+ ```
1088
+
1089
+ ### Standalone function
1090
+
1091
+ The standalone function version of this method:
1092
+
1093
+ ```typescript
1094
+ import { OrqCore } from "@orq-ai/node/core.js";
1095
+ import { agentsStream } from "@orq-ai/node/funcs/agentsStream.js";
1096
+
1097
+ // Use `OrqCore` for best tree-shaking performance.
1098
+ // You can create one instance of it to use across an application.
1099
+ const orq = new OrqCore({
1100
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1101
+ });
1102
+
1103
+ async function run() {
1104
+ const res = await agentsStream(orq, {
1105
+ key: "<key>",
1106
+ requestBody: {
1107
+ message: {
1108
+ role: "user",
1109
+ parts: [],
1110
+ },
1111
+ contact: {
1112
+ id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
1113
+ displayName: "Jane Doe",
1114
+ email: "jane.doe@example.com",
1115
+ metadata: [
1116
+ {
1117
+ "department": "Engineering",
1118
+ "role": "Senior Developer",
1119
+ },
1120
+ ],
1121
+ logoUrl: "https://example.com/avatars/jane-doe.jpg",
1122
+ tags: [
1123
+ "hr",
1124
+ "engineering",
1125
+ ],
1126
+ },
1127
+ thread: {
1128
+ id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
1129
+ tags: [
1130
+ "customer-support",
1131
+ "priority-high",
1132
+ ],
1133
+ },
1134
+ },
1135
+ });
1136
+ if (res.ok) {
1137
+ const { value: result } = res;
1138
+ for await (const event of result) {
1139
+ console.log(event);
1140
+ }
1141
+ } else {
1142
+ console.log("agentsStream failed:", res.error);
1143
+ }
1144
+ }
1145
+
1146
+ run();
1147
+ ```
1148
+
1149
+ ### Parameters
1150
+
1151
+ | Parameter | Type | Required | Description |
1152
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1153
+ | `request` | [operations.StreamAgentRequest](../../models/operations/streamagentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1154
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1155
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1156
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1157
+
1158
+ ### Response
1159
+
1160
+ **Promise\<[EventStream<operations.StreamAgentResponseBody>](../../models/.md)\>**
1161
+
1162
+ ### Errors
1163
+
1164
+ | Error Type | Status Code | Content Type |
1165
+ | ------------------------------ | ------------------------------ | ------------------------------ |
1166
+ | errors.StreamAgentResponseBody | 404 | application/json |
1167
+ | errors.APIError | 4XX, 5XX | \*/\* |
1168
+
1169
+ ## listActions
1170
+
1171
+ List all actions
1172
+
1173
+ ### Example Usage
1174
+
1175
+ <!-- UsageSnippet language="typescript" operationID="ListActions" method="get" path="/v2/agents/{agent_key}/tasks/{task_id}/actions" -->
1176
+ ```typescript
1177
+ import { Orq } from "@orq-ai/node";
1178
+
1179
+ const orq = new Orq({
1180
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1181
+ });
1182
+
1183
+ async function run() {
1184
+ const result = await orq.agents.listActions({
1185
+ agentKey: "<value>",
1186
+ taskId: "<id>",
1187
+ });
1188
+
1189
+ console.log(result);
1190
+ }
1191
+
1192
+ run();
1193
+ ```
1194
+
1195
+ ### Standalone function
1196
+
1197
+ The standalone function version of this method:
1198
+
1199
+ ```typescript
1200
+ import { OrqCore } from "@orq-ai/node/core.js";
1201
+ import { agentsListActions } from "@orq-ai/node/funcs/agentsListActions.js";
1202
+
1203
+ // Use `OrqCore` for best tree-shaking performance.
1204
+ // You can create one instance of it to use across an application.
1205
+ const orq = new OrqCore({
1206
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1207
+ });
1208
+
1209
+ async function run() {
1210
+ const res = await agentsListActions(orq, {
1211
+ agentKey: "<value>",
1212
+ taskId: "<id>",
1213
+ });
1214
+ if (res.ok) {
1215
+ const { value: result } = res;
1216
+ console.log(result);
1217
+ } else {
1218
+ console.log("agentsListActions failed:", res.error);
1219
+ }
1220
+ }
1221
+
1222
+ run();
1223
+ ```
1224
+
1225
+ ### Parameters
1226
+
1227
+ | Parameter | Type | Required | Description |
1228
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1229
+ | `request` | [operations.ListActionsRequest](../../models/operations/listactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1230
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1231
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1232
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1233
+
1234
+ ### Response
1235
+
1236
+ **Promise\<[operations.ListActionsResponseBody](../../models/operations/listactionsresponsebody.md)\>**
1237
+
1238
+ ### Errors
1239
+
1240
+ | Error Type | Status Code | Content Type |
1241
+ | --------------- | --------------- | --------------- |
1242
+ | errors.APIError | 4XX, 5XX | \*/\* |
1243
+
1244
+ ## retrieveAction
1245
+
1246
+ Retrieve an action executed by an agent task.
1247
+
1248
+ ### Example Usage
1249
+
1250
+ <!-- UsageSnippet language="typescript" operationID="RetrieveAction" method="get" path="/v2/agents/{agent_key}/tasks/{task_id}/actions/{action_id}" -->
1251
+ ```typescript
1252
+ import { Orq } from "@orq-ai/node";
1253
+
1254
+ const orq = new Orq({
1255
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1256
+ });
1257
+
1258
+ async function run() {
1259
+ const result = await orq.agents.retrieveAction({
1260
+ agentKey: "<value>",
1261
+ taskId: "<id>",
1262
+ actionId: "<id>",
1263
+ });
1264
+
1265
+ console.log(result);
1266
+ }
1267
+
1268
+ run();
1269
+ ```
1270
+
1271
+ ### Standalone function
1272
+
1273
+ The standalone function version of this method:
1274
+
1275
+ ```typescript
1276
+ import { OrqCore } from "@orq-ai/node/core.js";
1277
+ import { agentsRetrieveAction } from "@orq-ai/node/funcs/agentsRetrieveAction.js";
1278
+
1279
+ // Use `OrqCore` for best tree-shaking performance.
1280
+ // You can create one instance of it to use across an application.
1281
+ const orq = new OrqCore({
1282
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1283
+ });
1284
+
1285
+ async function run() {
1286
+ const res = await agentsRetrieveAction(orq, {
1287
+ agentKey: "<value>",
1288
+ taskId: "<id>",
1289
+ actionId: "<id>",
1290
+ });
1291
+ if (res.ok) {
1292
+ const { value: result } = res;
1293
+ console.log(result);
1294
+ } else {
1295
+ console.log("agentsRetrieveAction failed:", res.error);
1296
+ }
1297
+ }
1298
+
1299
+ run();
1300
+ ```
1301
+
1302
+ ### Parameters
1303
+
1304
+ | Parameter | Type | Required | Description |
1305
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1306
+ | `request` | [operations.RetrieveActionRequest](../../models/operations/retrieveactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1307
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1308
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1309
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1310
+
1311
+ ### Response
1312
+
1313
+ **Promise\<[operations.RetrieveActionResponseBody](../../models/operations/retrieveactionresponsebody.md)\>**
1314
+
1315
+ ### Errors
1316
+
1317
+ | Error Type | Status Code | Content Type |
1318
+ | --------------- | --------------- | --------------- |
1319
+ | errors.APIError | 4XX, 5XX | \*/\* |