@openrouter/sdk 0.0.1-beta.9 → 0.1.0

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 (356) hide show
  1. package/REACT_QUERY.md +3 -12
  2. package/README.md +52 -396
  3. package/esm/funcs/analyticsGetUserActivity.d.ts +1 -1
  4. package/esm/funcs/analyticsGetUserActivity.js +2 -2
  5. package/esm/funcs/apiKeysCreate.d.ts +1 -1
  6. package/esm/funcs/apiKeysCreate.js +2 -2
  7. package/esm/funcs/apiKeysDelete.d.ts +1 -1
  8. package/esm/funcs/apiKeysDelete.js +2 -2
  9. package/esm/funcs/apiKeysGet.d.ts +1 -1
  10. package/esm/funcs/apiKeysGet.js +2 -2
  11. package/esm/funcs/apiKeysGetCurrentKeyMetadata.d.ts +1 -1
  12. package/esm/funcs/apiKeysGetCurrentKeyMetadata.js +2 -2
  13. package/esm/funcs/apiKeysList.d.ts +1 -1
  14. package/esm/funcs/apiKeysList.js +2 -2
  15. package/esm/funcs/apiKeysUpdate.d.ts +1 -1
  16. package/esm/funcs/apiKeysUpdate.js +2 -2
  17. package/esm/funcs/betaResponsesSend.d.ts +9 -1
  18. package/esm/funcs/betaResponsesSend.js +38 -14
  19. package/esm/funcs/chatSend.d.ts +7 -0
  20. package/esm/funcs/chatSend.js +1 -7
  21. package/esm/funcs/creditsCreateCoinbaseCharge.d.ts +1 -1
  22. package/esm/funcs/creditsCreateCoinbaseCharge.js +15 -5
  23. package/esm/funcs/creditsGetCredits.d.ts +1 -1
  24. package/esm/funcs/creditsGetCredits.js +2 -2
  25. package/esm/funcs/endpointsList.d.ts +1 -1
  26. package/esm/funcs/endpointsList.js +2 -2
  27. package/esm/funcs/endpointsListZdrEndpoints.d.ts +2 -1
  28. package/esm/funcs/endpointsListZdrEndpoints.js +6 -2
  29. package/esm/funcs/generationsGetGeneration.d.ts +1 -1
  30. package/esm/funcs/generationsGetGeneration.js +13 -2
  31. package/esm/funcs/modelsCount.d.ts +3 -2
  32. package/esm/funcs/modelsCount.js +7 -3
  33. package/esm/funcs/modelsList.d.ts +3 -1
  34. package/esm/funcs/modelsList.js +8 -7
  35. package/esm/funcs/modelsListForUser.d.ts +3 -1
  36. package/esm/funcs/modelsListForUser.js +7 -3
  37. package/esm/funcs/oAuthCreateAuthCode.d.ts +18 -0
  38. package/esm/funcs/oAuthCreateAuthCode.js +82 -0
  39. package/esm/funcs/oAuthCreateAuthorizationUrl.d.ts +2 -2
  40. package/esm/funcs/oAuthExchangeAuthCodeForAPIKey.d.ts +18 -0
  41. package/esm/funcs/oAuthExchangeAuthCodeForAPIKey.js +82 -0
  42. package/esm/funcs/parametersGetParameters.d.ts +1 -1
  43. package/esm/funcs/parametersGetParameters.js +2 -2
  44. package/esm/funcs/providersList.d.ts +1 -1
  45. package/esm/funcs/providersList.js +1 -1
  46. package/esm/lib/config.d.ts +3 -3
  47. package/esm/lib/config.js +3 -3
  48. package/esm/lib/event-streams.d.ts +1 -1
  49. package/esm/models/badgatewayresponseerrordata.d.ts +40 -0
  50. package/esm/models/badgatewayresponseerrordata.js +35 -0
  51. package/esm/models/badrequestresponseerrordata.d.ts +40 -0
  52. package/esm/models/badrequestresponseerrordata.js +35 -0
  53. package/esm/models/chatgenerationparams.d.ts +12 -12
  54. package/esm/models/chatgenerationparams.js +16 -16
  55. package/esm/models/chatgenerationtokenusage.d.ts +2 -2
  56. package/esm/models/chatgenerationtokenusage.js +2 -4
  57. package/esm/models/chatmessagetokenlogprob.d.ts +15 -15
  58. package/esm/models/chatmessagetokenlogprob.js +16 -15
  59. package/esm/models/chatstreamingresponsechunk.d.ts +15 -15
  60. package/esm/models/chatstreamingresponsechunk.js +15 -15
  61. package/esm/models/completioncreateparams.d.ts +2 -2
  62. package/esm/models/completioncreateparams.js +2 -2
  63. package/esm/models/createchargerequest.d.ts +31 -2
  64. package/esm/models/createchargerequest.js +47 -2
  65. package/esm/models/defaultparameters.d.ts +36 -0
  66. package/esm/models/defaultparameters.js +46 -0
  67. package/esm/models/edgenetworktimeoutresponseerrordata.d.ts +40 -0
  68. package/esm/models/edgenetworktimeoutresponseerrordata.js +35 -0
  69. package/esm/models/endpointstatus.d.ts +26 -0
  70. package/esm/models/endpointstatus.js +36 -0
  71. package/esm/models/errors/badgatewayresponseerror.d.ts +52 -0
  72. package/esm/models/errors/badgatewayresponseerror.js +63 -0
  73. package/esm/models/errors/badrequestresponseerror.d.ts +52 -0
  74. package/esm/models/errors/badrequestresponseerror.js +63 -0
  75. package/esm/models/errors/edgenetworktimeoutresponseerror.d.ts +52 -0
  76. package/esm/models/errors/edgenetworktimeoutresponseerror.js +63 -0
  77. package/esm/models/errors/forbiddenresponseerror.d.ts +52 -0
  78. package/esm/models/errors/forbiddenresponseerror.js +63 -0
  79. package/esm/models/errors/index.d.ts +14 -2
  80. package/esm/models/errors/index.js +14 -2
  81. package/esm/models/errors/internalserverresponseerror.d.ts +52 -0
  82. package/esm/models/errors/internalserverresponseerror.js +63 -0
  83. package/esm/models/errors/notfoundresponseerror.d.ts +52 -0
  84. package/esm/models/errors/{errorresponse.js → notfoundresponseerror.js} +16 -17
  85. package/esm/models/errors/payloadtoolargeresponseerror.d.ts +52 -0
  86. package/esm/models/errors/payloadtoolargeresponseerror.js +63 -0
  87. package/esm/models/errors/paymentrequiredresponseerror.d.ts +52 -0
  88. package/esm/models/errors/paymentrequiredresponseerror.js +63 -0
  89. package/esm/models/errors/provideroverloadedresponseerror.d.ts +52 -0
  90. package/esm/models/errors/provideroverloadedresponseerror.js +63 -0
  91. package/esm/models/errors/requesttimeoutresponseerror.d.ts +52 -0
  92. package/esm/models/errors/requesttimeoutresponseerror.js +63 -0
  93. package/esm/models/errors/serviceunavailableresponseerror.d.ts +52 -0
  94. package/esm/models/errors/serviceunavailableresponseerror.js +63 -0
  95. package/esm/models/errors/toomanyrequestsresponseerror.d.ts +52 -0
  96. package/esm/models/errors/toomanyrequestsresponseerror.js +63 -0
  97. package/esm/models/errors/unauthorizedresponseerror.d.ts +52 -0
  98. package/esm/models/errors/unauthorizedresponseerror.js +63 -0
  99. package/esm/models/errors/unprocessableentityresponseerror.d.ts +52 -0
  100. package/esm/models/errors/unprocessableentityresponseerror.js +63 -0
  101. package/esm/models/filecitation.d.ts +58 -0
  102. package/esm/models/filecitation.js +65 -0
  103. package/esm/models/filepath.d.ts +56 -0
  104. package/esm/models/filepath.js +64 -0
  105. package/esm/models/forbiddenresponseerrordata.d.ts +40 -0
  106. package/esm/models/forbiddenresponseerrordata.js +35 -0
  107. package/esm/models/index.d.ts +67 -23
  108. package/esm/models/index.js +67 -23
  109. package/esm/models/inputmodality.d.ts +25 -0
  110. package/esm/models/inputmodality.js +35 -0
  111. package/esm/models/instructtype.d.ts +48 -0
  112. package/esm/models/instructtype.js +55 -0
  113. package/esm/models/internalserverresponseerrordata.d.ts +40 -0
  114. package/esm/models/internalserverresponseerrordata.js +35 -0
  115. package/esm/models/listendpointsresponse.d.ts +126 -2
  116. package/esm/models/listendpointsresponse.js +115 -2
  117. package/esm/models/model.d.ts +101 -0
  118. package/esm/models/model.js +82 -0
  119. package/esm/models/modelarchitecture.d.ts +104 -0
  120. package/esm/models/modelarchitecture.js +107 -0
  121. package/esm/models/modelgroup.d.ts +45 -0
  122. package/esm/models/modelgroup.js +53 -0
  123. package/esm/models/modelscountresponse.d.ts +40 -2
  124. package/esm/models/modelscountresponse.js +31 -2
  125. package/esm/models/modelslistresponse.d.ts +10 -2
  126. package/esm/models/modelslistresponse.js +7 -2
  127. package/esm/models/notfoundresponseerrordata.d.ts +40 -0
  128. package/esm/models/notfoundresponseerrordata.js +35 -0
  129. package/esm/models/openairesponsesannotation.d.ts +28 -0
  130. package/esm/models/openairesponsesannotation.js +38 -0
  131. package/esm/models/openairesponsesincludable.d.ts +25 -0
  132. package/esm/models/openairesponsesincludable.js +35 -0
  133. package/esm/models/openairesponsesincompletedetails.d.ts +49 -0
  134. package/esm/models/openairesponsesincompletedetails.js +58 -0
  135. package/esm/models/openairesponsesinputunion.d.ts +588 -0
  136. package/esm/models/openairesponsesinputunion.js +686 -0
  137. package/esm/models/openairesponsesprompt.d.ts +83 -0
  138. package/esm/models/openairesponsesprompt.js +97 -0
  139. package/esm/models/openairesponsesreasoningconfig.d.ts +33 -0
  140. package/esm/models/openairesponsesreasoningconfig.js +35 -0
  141. package/esm/models/openairesponsesreasoningeffort.d.ts +24 -0
  142. package/esm/models/openairesponsesreasoningeffort.js +34 -0
  143. package/esm/models/openairesponsesrefusalcontent.d.ts +54 -0
  144. package/esm/models/openairesponsesrefusalcontent.js +51 -0
  145. package/esm/models/openairesponsesresponsestatus.d.ts +26 -0
  146. package/esm/models/openairesponsesresponsestatus.js +36 -0
  147. package/esm/models/openairesponsesservicetier.d.ts +25 -0
  148. package/esm/models/openairesponsesservicetier.js +35 -0
  149. package/esm/models/openairesponsestoolchoiceunion.d.ts +231 -0
  150. package/esm/models/openairesponsestoolchoiceunion.js +233 -0
  151. package/esm/models/openairesponsestruncation.d.ts +22 -0
  152. package/esm/models/openairesponsestruncation.js +32 -0
  153. package/esm/models/openresponseseasyinputmessage.d.ts +75 -19
  154. package/esm/models/openresponseseasyinputmessage.js +105 -16
  155. package/esm/models/openresponseserrorevent.d.ts +63 -0
  156. package/esm/models/openresponseserrorevent.js +66 -0
  157. package/esm/models/openresponsesimagegencallcompleted.d.ts +61 -0
  158. package/esm/models/openresponsesimagegencallcompleted.js +68 -0
  159. package/esm/models/openresponsesimagegencallgenerating.d.ts +61 -0
  160. package/esm/models/openresponsesimagegencallgenerating.js +68 -0
  161. package/esm/models/openresponsesimagegencallinprogress.d.ts +61 -0
  162. package/esm/models/openresponsesimagegencallinprogress.js +68 -0
  163. package/esm/models/openresponsesimagegencallpartialimage.d.ts +65 -0
  164. package/esm/models/openresponsesimagegencallpartialimage.js +76 -0
  165. package/esm/models/openresponsesinput.d.ts +36 -5
  166. package/esm/models/openresponsesinput.js +82 -5
  167. package/esm/models/openresponsesinputmessageitem.d.ts +52 -8
  168. package/esm/models/openresponsesinputmessageitem.js +68 -5
  169. package/esm/models/openresponseslogprobs.d.ts +3 -32
  170. package/esm/models/openresponseslogprobs.js +3 -29
  171. package/esm/models/openresponsesnonstreamingresponse.d.ts +93 -123
  172. package/esm/models/openresponsesnonstreamingresponse.js +111 -145
  173. package/esm/models/openresponsesreasoning.d.ts +89 -0
  174. package/esm/models/openresponsesreasoning.js +93 -0
  175. package/esm/models/openresponsesreasoningconfig.d.ts +2 -23
  176. package/esm/models/openresponsesreasoningconfig.js +3 -33
  177. package/esm/models/openresponsesreasoningdeltaevent.d.ts +65 -0
  178. package/esm/models/openresponsesreasoningdeltaevent.js +74 -0
  179. package/esm/models/openresponsesreasoningdoneevent.d.ts +65 -0
  180. package/esm/models/openresponsesreasoningdoneevent.js +74 -0
  181. package/esm/models/openresponsesreasoningsummarypartaddedevent.d.ts +66 -0
  182. package/esm/models/openresponsesreasoningsummarypartaddedevent.js +75 -0
  183. package/esm/models/openresponsesreasoningsummarytextdeltaevent.d.ts +65 -0
  184. package/esm/models/openresponsesreasoningsummarytextdeltaevent.js +74 -0
  185. package/esm/models/openresponsesreasoningsummarytextdoneevent.d.ts +65 -0
  186. package/esm/models/openresponsesreasoningsummarytextdoneevent.js +74 -0
  187. package/esm/models/openresponsesrequest.d.ts +736 -2
  188. package/esm/models/openresponsesrequest.js +789 -2
  189. package/esm/models/openresponsesresponsetext.d.ts +59 -0
  190. package/esm/models/openresponsesresponsetext.js +64 -0
  191. package/esm/models/openresponsesstreamevent.d.ts +25 -612
  192. package/esm/models/openresponsesstreamevent.js +51 -742
  193. package/esm/models/openresponsestoplogprobs.d.ts +34 -0
  194. package/esm/models/openresponsestoplogprobs.js +33 -0
  195. package/esm/models/{responsesusage.d.ts → openresponsesusage.d.ts} +14 -14
  196. package/esm/models/{responsesusage.js → openresponsesusage.js} +14 -14
  197. package/esm/models/operations/createauthkeyscode.d.ts +145 -0
  198. package/esm/models/operations/createauthkeyscode.js +146 -0
  199. package/esm/models/operations/createresponses.d.ts +58 -0
  200. package/esm/models/operations/createresponses.js +80 -0
  201. package/esm/models/operations/exchangeauthcodeforapikey.d.ts +104 -0
  202. package/esm/models/operations/exchangeauthcodeforapikey.js +111 -0
  203. package/esm/models/operations/getmodels.d.ts +0 -26
  204. package/esm/models/operations/getmodels.js +0 -38
  205. package/esm/models/operations/getparameters.d.ts +1 -0
  206. package/esm/models/operations/getparameters.js +1 -0
  207. package/esm/models/operations/index.d.ts +3 -2
  208. package/esm/models/operations/index.js +3 -2
  209. package/esm/models/operations/listendpointszdr.d.ts +3 -24
  210. package/esm/models/operations/listendpointszdr.js +2 -29
  211. package/esm/models/operations/listmodelsuser.d.ts +0 -22
  212. package/esm/models/operations/listmodelsuser.js +0 -28
  213. package/esm/models/operations/listproviders.d.ts +0 -36
  214. package/esm/models/operations/listproviders.js +0 -28
  215. package/esm/models/operations/sendchatcompletionrequest.d.ts +1 -1
  216. package/esm/models/operations/sendchatcompletionrequest.js +2 -1
  217. package/esm/models/outputitemimagegenerationcall.d.ts +59 -0
  218. package/esm/models/outputitemimagegenerationcall.js +56 -0
  219. package/esm/models/outputmessage.d.ts +192 -0
  220. package/esm/models/outputmessage.js +202 -0
  221. package/esm/models/outputmodality.d.ts +23 -0
  222. package/esm/models/outputmodality.js +33 -0
  223. package/esm/models/parameter.d.ts +43 -0
  224. package/esm/models/parameter.js +54 -0
  225. package/esm/models/payloadtoolargeresponseerrordata.d.ts +40 -0
  226. package/esm/models/payloadtoolargeresponseerrordata.js +35 -0
  227. package/esm/models/paymentrequiredresponseerrordata.d.ts +40 -0
  228. package/esm/models/paymentrequiredresponseerrordata.js +35 -0
  229. package/esm/models/perrequestlimits.d.ts +40 -0
  230. package/esm/models/perrequestlimits.js +44 -0
  231. package/esm/models/providername.d.ts +106 -0
  232. package/esm/models/providername.js +116 -0
  233. package/esm/models/provideroverloadedresponseerrordata.d.ts +40 -0
  234. package/esm/models/provideroverloadedresponseerrordata.js +35 -0
  235. package/esm/models/publicendpoint.d.ts +140 -2
  236. package/esm/models/publicendpoint.js +156 -2
  237. package/esm/models/publicpricing.d.ts +87 -0
  238. package/esm/models/publicpricing.js +73 -0
  239. package/esm/models/quantization.d.ts +29 -0
  240. package/esm/models/quantization.js +39 -0
  241. package/esm/models/requesttimeoutresponseerrordata.d.ts +40 -0
  242. package/esm/models/requesttimeoutresponseerrordata.js +35 -0
  243. package/esm/models/responseformattextconfig.d.ts +31 -0
  244. package/esm/models/responseformattextconfig.js +38 -0
  245. package/esm/models/responseinputfile.d.ts +63 -0
  246. package/esm/models/responseinputfile.js +70 -0
  247. package/esm/models/responseinputimage.d.ts +79 -0
  248. package/esm/models/responseinputimage.js +90 -0
  249. package/esm/models/responseinputtext.d.ts +57 -0
  250. package/esm/models/responseinputtext.js +51 -0
  251. package/esm/models/responseoutputtext.d.ts +57 -0
  252. package/esm/models/responseoutputtext.js +54 -0
  253. package/esm/models/responseserrorfield.d.ts +25 -10
  254. package/esm/models/responseserrorfield.js +29 -14
  255. package/esm/models/responsesformatjsonobject.d.ts +55 -0
  256. package/esm/models/responsesformatjsonobject.js +49 -0
  257. package/esm/models/responsesformattext.d.ts +55 -0
  258. package/esm/models/responsesformattext.js +49 -0
  259. package/esm/models/responsesformattextjsonschemaconfig.d.ts +67 -0
  260. package/esm/models/responsesformattextjsonschemaconfig.js +57 -0
  261. package/esm/models/responsesoutputitemfunctioncall.d.ts +89 -0
  262. package/esm/models/responsesoutputitemfunctioncall.js +93 -0
  263. package/esm/models/responsesoutputitemreasoning.d.ts +92 -0
  264. package/esm/models/responsesoutputitemreasoning.js +93 -0
  265. package/esm/models/responsesoutputmessage.d.ts +45 -42
  266. package/esm/models/responsesoutputmessage.js +76 -65
  267. package/esm/models/responsetextconfig.d.ts +59 -0
  268. package/esm/models/responsetextconfig.js +62 -0
  269. package/esm/models/serviceunavailableresponseerrordata.d.ts +40 -0
  270. package/esm/models/serviceunavailableresponseerrordata.js +35 -0
  271. package/esm/models/toomanyrequestsresponseerrordata.d.ts +40 -0
  272. package/esm/models/toomanyrequestsresponseerrordata.js +35 -0
  273. package/esm/models/topproviderinfo.d.ts +45 -0
  274. package/esm/models/topproviderinfo.js +48 -0
  275. package/esm/models/unauthorizedresponseerrordata.d.ts +40 -0
  276. package/esm/models/unauthorizedresponseerrordata.js +35 -0
  277. package/esm/models/unprocessableentityresponseerrordata.d.ts +40 -0
  278. package/esm/models/unprocessableentityresponseerrordata.js +35 -0
  279. package/esm/models/urlcitation.d.ts +60 -0
  280. package/esm/models/urlcitation.js +69 -0
  281. package/esm/react-query/betaResponsesSend.d.ts +1 -1
  282. package/esm/react-query/index.d.ts +2 -0
  283. package/esm/react-query/index.js +2 -0
  284. package/esm/react-query/modelsCount.d.ts +2 -2
  285. package/esm/react-query/modelsList.d.ts +2 -7
  286. package/esm/react-query/modelsList.js +0 -2
  287. package/esm/react-query/modelsListForUser.d.ts +2 -1
  288. package/esm/react-query/oAuthCreateAuthCode.d.ts +23 -0
  289. package/esm/react-query/oAuthCreateAuthCode.js +42 -0
  290. package/esm/react-query/oAuthExchangeAuthCodeForAPIKey.d.ts +23 -0
  291. package/esm/react-query/oAuthExchangeAuthCodeForAPIKey.js +42 -0
  292. package/esm/sdk/chat.d.ts +7 -0
  293. package/esm/sdk/chat.js +0 -6
  294. package/esm/sdk/models.d.ts +4 -3
  295. package/esm/sdk/oauth.d.ts +46 -0
  296. package/esm/sdk/oauth.js +67 -0
  297. package/esm/sdk/responses.d.ts +8 -1
  298. package/esm/sdk/responses.js +0 -6
  299. package/esm/sdk/sdk.d.ts +3 -0
  300. package/esm/sdk/sdk.js +4 -0
  301. package/jsr.json +1 -1
  302. package/package.json +3 -1
  303. package/vitest.config.ts +26 -0
  304. package/.devcontainer/README.md +0 -35
  305. package/esm/models/errorresponse.d.ts +0 -155
  306. package/esm/models/errorresponse.js +0 -167
  307. package/esm/models/errors/errorresponse.d.ts +0 -46
  308. package/esm/models/errors/listproviders.d.ts +0 -49
  309. package/esm/models/errors/listproviders.js +0 -51
  310. package/esm/models/filecitationannotation.d.ts +0 -58
  311. package/esm/models/filecitationannotation.js +0 -64
  312. package/esm/models/filepathannotation.d.ts +0 -56
  313. package/esm/models/filepathannotation.js +0 -62
  314. package/esm/models/openresponsesformatjsonobject.d.ts +0 -55
  315. package/esm/models/openresponsesformatjsonobject.js +0 -49
  316. package/esm/models/openresponsesformatjsonschema.d.ts +0 -67
  317. package/esm/models/openresponsesformatjsonschema.js +0 -57
  318. package/esm/models/openresponsesformattext.d.ts +0 -55
  319. package/esm/models/openresponsesformattext.js +0 -49
  320. package/esm/models/openresponsesformattextconfig.d.ts +0 -31
  321. package/esm/models/openresponsesformattextconfig.js +0 -38
  322. package/esm/models/openresponsesinputcontent.d.ts +0 -43
  323. package/esm/models/openresponsesinputcontent.js +0 -50
  324. package/esm/models/openresponsesinputfile.d.ts +0 -63
  325. package/esm/models/openresponsesinputfile.js +0 -70
  326. package/esm/models/openresponsesinputimage.d.ts +0 -79
  327. package/esm/models/openresponsesinputimage.js +0 -90
  328. package/esm/models/openresponsesinputitem.d.ts +0 -39
  329. package/esm/models/openresponsesinputitem.js +0 -62
  330. package/esm/models/openresponsesinputtext.d.ts +0 -57
  331. package/esm/models/openresponsesinputtext.js +0 -51
  332. package/esm/models/openresponsesoutputtext.d.ts +0 -80
  333. package/esm/models/openresponsesoutputtext.js +0 -93
  334. package/esm/models/openresponsesprompt.d.ts +0 -39
  335. package/esm/models/openresponsesprompt.js +0 -34
  336. package/esm/models/openresponsesrefusalcontent.d.ts +0 -54
  337. package/esm/models/openresponsesrefusalcontent.js +0 -51
  338. package/esm/models/openresponsestextconfig.d.ts +0 -59
  339. package/esm/models/openresponsestextconfig.js +0 -63
  340. package/esm/models/openresponsestoolchoice.d.ts +0 -148
  341. package/esm/models/openresponsestoolchoice.js +0 -139
  342. package/esm/models/openresponsestoolunion.d.ts +0 -95
  343. package/esm/models/openresponsestoolunion.js +0 -94
  344. package/esm/models/operations/createapialpharesponses.d.ts +0 -58
  345. package/esm/models/operations/createapialpharesponses.js +0 -83
  346. package/esm/models/operations/listmodelscount.d.ts +0 -26
  347. package/esm/models/operations/listmodelscount.js +0 -34
  348. package/esm/models/outputtextcontent.d.ts +0 -80
  349. package/esm/models/outputtextcontent.js +0 -93
  350. package/esm/models/refusalcontent.d.ts +0 -54
  351. package/esm/models/refusalcontent.js +0 -51
  352. package/esm/models/toolchoicetypes.d.ts +0 -164
  353. package/esm/models/toolchoicetypes.js +0 -167
  354. package/esm/models/urlcitationannotation.d.ts +0 -60
  355. package/esm/models/urlcitationannotation.js +0 -68
  356. package/examples/README.md +0 -31
package/REACT_QUERY.md CHANGED
@@ -53,9 +53,7 @@ from TanStack Query.
53
53
  import { useAnalyticsGetUserActivity } from "@openrouter/sdk/react-query/analyticsGetUserActivity.js";
54
54
 
55
55
  export function Example() {
56
- const { data, error, status } = useAnalyticsGetUserActivity({
57
- date: "2025-08-24",
58
- });
56
+ const { data, error, status } = useAnalyticsGetUserActivity();
59
57
 
60
58
  // Render the UI here...
61
59
  }
@@ -73,9 +71,6 @@ import { useAnalyticsGetUserActivity } from "@openrouter/sdk/react-query/analyti
73
71
  export function ExampleWithOptions() {
74
72
  const [enabled, setEnabled] = useState(true);
75
73
  const { data, error, status } = useAnalyticsGetUserActivity(
76
- {
77
- date: "2025-08-24",
78
- },
79
74
  {
80
75
  // TanStack Query options:
81
76
  enabled,
@@ -258,9 +253,7 @@ export function App() {
258
253
  }
259
254
 
260
255
  function Example() {
261
- const { data } = useAnalyticsGetUserActivitySuspense({
262
- date: "2025-08-24",
263
- });
256
+ const { data } = useAnalyticsGetUserActivitySuspense();
264
257
 
265
258
  // Render the UI here...
266
259
  }
@@ -288,9 +281,7 @@ export default async function Page() {
288
281
  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
289
282
  });
290
283
 
291
- await prefetchAnalyticsGetUserActivity(queryClient, openRouter, {
292
- date: "2025-08-24",
293
- });
284
+ await prefetchAnalyticsGetUserActivity(openRouter);
294
285
 
295
286
  return (
296
287
  // HydrationBoundary is a Client Component, so hydration will happen there.
package/README.md CHANGED
@@ -1,29 +1,14 @@
1
+ ![hero illustration](./assets/banner.png)
2
+
1
3
  # OpenRouter SDK (Beta)
2
4
 
3
- The [OpenRouter](https://openrouter.ai/) SDK gives access to over 300 large language models on the OpenRouter chat and completion APIs, as well as the rest of our full API. For more information about the API: [OpenRouter Documentation](https://openrouter.ai/docs)
5
+ The [OpenRouter SDK](https://openrouter.ai/docs/sdks/typescript) is a TypeScript toolkit designed to help you build AI-powered features and solutions in any JS or TS based runtime. Giving you easy access to over 300 models across providers in an easy and type-safe way.
6
+
7
+ To learn more about how to use the OpenRouter SDK, check out our [API Reference](https://openrouter.ai/docs/sdks/typescript/reference) and [Documentation](https://openrouter.ai/docs/sdks/typescript).
4
8
 
5
9
  <!-- No Summary [summary] -->
6
10
 
7
- <!-- Start Table of Contents [toc] -->
8
- ## Table of Contents
9
- <!-- $toc-max-depth=2 -->
10
- * [OpenRouter SDK (Beta)](#openrouter-sdk-beta)
11
- * [SDK Installation](#sdk-installation)
12
- * [Requirements](#requirements)
13
- * [SDK Example Usage](#sdk-example-usage)
14
- * [Authentication](#authentication)
15
- * [Available Resources and Operations](#available-resources-and-operations)
16
- * [Standalone functions](#standalone-functions)
17
- * [React hooks with TanStack Query](#react-hooks-with-tanstack-query)
18
- * [Server-sent event streaming](#server-sent-event-streaming)
19
- * [Retries](#retries)
20
- * [Error Handling](#error-handling)
21
- * [Debugging](#debugging)
22
- * [Development](#development)
23
- * [Maturity](#maturity)
24
- * [Contributions](#contributions)
25
-
26
- <!-- End Table of Contents [toc] -->
11
+ <!-- No Table of Contents [toc] -->
27
12
 
28
13
  <!-- Start SDK Installation [installation] -->
29
14
  ## SDK Installation
@@ -73,396 +58,48 @@ yarn add @tanstack/react-query react react-dom
73
58
  For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
74
59
  <!-- End Requirements [requirements] -->
75
60
 
76
- <!-- Start SDK Example Usage [usage] -->
77
- ## SDK Example Usage
78
-
79
- ### Example
61
+ <!-- No SDK Example Usage [usage] -->
62
+ ## SDK Usage
80
63
 
81
64
  ```typescript
82
65
  import { OpenRouter } from "@openrouter/sdk";
83
66
 
84
- const openRouter = new OpenRouter({
85
- apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
86
- });
87
-
88
- async function run() {
89
- const result = await openRouter.beta.responses.send({});
90
-
91
- console.log(result);
92
- }
93
-
94
- run();
95
-
96
- ```
97
- <!-- End SDK Example Usage [usage] -->
98
-
99
- <!-- Start Authentication [security] -->
100
- ## Authentication
101
-
102
- ### Per-Client Security Schemes
103
-
104
- This SDK supports the following security scheme globally:
105
-
106
- | Name | Type | Scheme | Environment Variable |
107
- | -------- | ---- | ----------- | -------------------- |
108
- | `apiKey` | http | HTTP Bearer | `OPENROUTER_API_KEY` |
109
-
110
- To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
111
- ```typescript
112
- import { OpenRouter } from "@openrouter/sdk";
113
-
114
- const openRouter = new OpenRouter({
115
- apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
116
- });
117
-
118
- async function run() {
119
- const result = await openRouter.beta.responses.send({});
120
-
121
- console.log(result);
122
- }
123
-
124
- run();
125
-
126
- ```
127
-
128
- ### Per-Operation Security Schemes
129
-
130
- Some operations in this SDK require the security scheme to be specified at the request level. For example:
131
- ```typescript
132
- import { OpenRouter } from "@openrouter/sdk";
133
-
134
67
  const openRouter = new OpenRouter();
135
68
 
136
- async function run() {
137
- const result = await openRouter.credits.createCoinbaseCharge({
138
- bearer: process.env["OPENROUTER_BEARER"] ?? "",
139
- }, {});
140
-
141
- console.log(result);
142
- }
143
-
144
- run();
145
-
146
- ```
147
- <!-- End Authentication [security] -->
148
-
149
- <!-- Start Available Resources and Operations [operations] -->
150
- ## Available Resources and Operations
151
-
152
- <details open>
153
- <summary>Available methods</summary>
154
-
155
- ### [analytics](docs/sdks/analytics/README.md)
156
-
157
- * [getUserActivity](docs/sdks/analytics/README.md#getuseractivity) - Get user activity grouped by endpoint
158
-
159
- ### [apiKeys](docs/sdks/apikeys/README.md)
160
-
161
- * [list](docs/sdks/apikeys/README.md#list) - List API keys
162
- * [create](docs/sdks/apikeys/README.md#create) - Create a new API key
163
- * [update](docs/sdks/apikeys/README.md#update) - Update an API key
164
- * [delete](docs/sdks/apikeys/README.md#delete) - Delete an API key
165
- * [get](docs/sdks/apikeys/README.md#get) - Get a single API key
166
- * [getCurrentKeyMetadata](docs/sdks/apikeys/README.md#getcurrentkeymetadata) - Get current API key
167
-
168
- #### [beta.responses](docs/sdks/responses/README.md)
169
-
170
- * [send](docs/sdks/responses/README.md#send) - Create a response
171
-
172
- ### [chat](docs/sdks/chat/README.md)
173
-
174
- * [send](docs/sdks/chat/README.md#send) - Create a chat completion
175
-
176
- ### [completions](docs/sdks/completions/README.md)
177
-
178
- * [generate](docs/sdks/completions/README.md#generate) - Create a completion
179
-
180
- ### [credits](docs/sdks/credits/README.md)
181
-
182
- * [getCredits](docs/sdks/credits/README.md#getcredits) - Get remaining credits
183
- * [createCoinbaseCharge](docs/sdks/credits/README.md#createcoinbasecharge) - Create a Coinbase charge for crypto payment
184
-
185
- ### [endpoints](docs/sdks/endpoints/README.md)
186
-
187
- * [list](docs/sdks/endpoints/README.md#list) - List all endpoints for a model
188
- * [listZdrEndpoints](docs/sdks/endpoints/README.md#listzdrendpoints) - Preview the impact of ZDR on the available endpoints
189
-
190
- ### [generations](docs/sdks/generations/README.md)
191
-
192
- * [getGeneration](docs/sdks/generations/README.md#getgeneration) - Get request & usage metadata for a generation
193
-
194
- ### [models](docs/sdks/models/README.md)
195
-
196
- * [count](docs/sdks/models/README.md#count) - Get total count of available models
197
- * [list](docs/sdks/models/README.md#list) - List all models and their properties
198
- * [listForUser](docs/sdks/models/README.md#listforuser) - List models filtered by user provider preferences
199
-
200
- ### [parameters](docs/sdks/parameters/README.md)
201
-
202
- * [getParameters](docs/sdks/parameters/README.md#getparameters) - Get a model's supported parameters and data about which are most popular
203
-
204
- ### [providers](docs/sdks/providers/README.md)
205
-
206
- * [list](docs/sdks/providers/README.md#list) - List all providers
207
-
208
- </details>
209
- <!-- End Available Resources and Operations [operations] -->
210
-
211
- <!-- Start Standalone functions [standalone-funcs] -->
212
- ## Standalone functions
213
-
214
- All the methods listed above are available as standalone functions. These
215
- functions are ideal for use in applications running in the browser, serverless
216
- runtimes or other environments where application bundle size is a primary
217
- concern. When using a bundler to build your application, all unused
218
- functionality will be either excluded from the final bundle or tree-shaken away.
219
-
220
- To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
221
-
222
- <details>
223
-
224
- <summary>Available standalone functions</summary>
225
-
226
- - [`analyticsGetUserActivity`](docs/sdks/analytics/README.md#getuseractivity) - Get user activity grouped by endpoint
227
- - [`apiKeysCreate`](docs/sdks/apikeys/README.md#create) - Create a new API key
228
- - [`apiKeysDelete`](docs/sdks/apikeys/README.md#delete) - Delete an API key
229
- - [`apiKeysGet`](docs/sdks/apikeys/README.md#get) - Get a single API key
230
- - [`apiKeysGetCurrentKeyMetadata`](docs/sdks/apikeys/README.md#getcurrentkeymetadata) - Get current API key
231
- - [`apiKeysList`](docs/sdks/apikeys/README.md#list) - List API keys
232
- - [`apiKeysUpdate`](docs/sdks/apikeys/README.md#update) - Update an API key
233
- - [`betaResponsesSend`](docs/sdks/responses/README.md#send) - Create a response
234
- - [`chatSend`](docs/sdks/chat/README.md#send) - Create a chat completion
235
- - [`completionsGenerate`](docs/sdks/completions/README.md#generate) - Create a completion
236
- - [`creditsCreateCoinbaseCharge`](docs/sdks/credits/README.md#createcoinbasecharge) - Create a Coinbase charge for crypto payment
237
- - [`creditsGetCredits`](docs/sdks/credits/README.md#getcredits) - Get remaining credits
238
- - [`endpointsList`](docs/sdks/endpoints/README.md#list) - List all endpoints for a model
239
- - [`endpointsListZdrEndpoints`](docs/sdks/endpoints/README.md#listzdrendpoints) - Preview the impact of ZDR on the available endpoints
240
- - [`generationsGetGeneration`](docs/sdks/generations/README.md#getgeneration) - Get request & usage metadata for a generation
241
- - [`modelsCount`](docs/sdks/models/README.md#count) - Get total count of available models
242
- - [`modelsList`](docs/sdks/models/README.md#list) - List all models and their properties
243
- - [`modelsListForUser`](docs/sdks/models/README.md#listforuser) - List models filtered by user provider preferences
244
- - [`parametersGetParameters`](docs/sdks/parameters/README.md#getparameters) - Get a model's supported parameters and data about which are most popular
245
- - [`providersList`](docs/sdks/providers/README.md#list) - List all providers
246
-
247
- </details>
248
- <!-- End Standalone functions [standalone-funcs] -->
249
-
250
- <!-- Start React hooks with TanStack Query [react-query] -->
251
- ## React hooks with TanStack Query
252
-
253
- React hooks built on [TanStack Query][tanstack-query] are included in this SDK.
254
- These hooks and the utility functions provided alongside them can be used to
255
- build rich applications that pull data from the API using one of the most
256
- popular asynchronous state management library.
257
-
258
- [tanstack-query]: https://tanstack.com/query/v5/docs/framework/react/overview
259
-
260
- To learn about this feature and how to get started, check
261
- [REACT_QUERY.md](./REACT_QUERY.md).
262
-
263
- > [!WARNING]
264
- >
265
- > This feature is currently in **preview** and is subject to breaking changes
266
- > within the current major version of the SDK as we gather user feedback on it.
267
-
268
- <details>
269
-
270
- <summary>Available React hooks</summary>
271
-
272
- - [`useAnalyticsGetUserActivity`](docs/sdks/analytics/README.md#getuseractivity) - Get user activity grouped by endpoint
273
- - [`useApiKeysCreateMutation`](docs/sdks/apikeys/README.md#create) - Create a new API key
274
- - [`useApiKeysDeleteMutation`](docs/sdks/apikeys/README.md#delete) - Delete an API key
275
- - [`useApiKeysGet`](docs/sdks/apikeys/README.md#get) - Get a single API key
276
- - [`useApiKeysGetCurrentKeyMetadata`](docs/sdks/apikeys/README.md#getcurrentkeymetadata) - Get current API key
277
- - [`useApiKeysList`](docs/sdks/apikeys/README.md#list) - List API keys
278
- - [`useApiKeysUpdateMutation`](docs/sdks/apikeys/README.md#update) - Update an API key
279
- - [`useBetaResponsesSendMutation`](docs/sdks/responses/README.md#send) - Create a response
280
- - [`useChatSendMutation`](docs/sdks/chat/README.md#send) - Create a chat completion
281
- - [`useCompletionsGenerateMutation`](docs/sdks/completions/README.md#generate) - Create a completion
282
- - [`useCreditsCreateCoinbaseChargeMutation`](docs/sdks/credits/README.md#createcoinbasecharge) - Create a Coinbase charge for crypto payment
283
- - [`useCreditsGetCredits`](docs/sdks/credits/README.md#getcredits) - Get remaining credits
284
- - [`useEndpointsList`](docs/sdks/endpoints/README.md#list) - List all endpoints for a model
285
- - [`useEndpointsListZdrEndpoints`](docs/sdks/endpoints/README.md#listzdrendpoints) - Preview the impact of ZDR on the available endpoints
286
- - [`useGenerationsGetGeneration`](docs/sdks/generations/README.md#getgeneration) - Get request & usage metadata for a generation
287
- - [`useModelsCount`](docs/sdks/models/README.md#count) - Get total count of available models
288
- - [`useModelsList`](docs/sdks/models/README.md#list) - List all models and their properties
289
- - [`useModelsListForUser`](docs/sdks/models/README.md#listforuser) - List models filtered by user provider preferences
290
- - [`useParametersGetParameters`](docs/sdks/parameters/README.md#getparameters) - Get a model's supported parameters and data about which are most popular
291
- - [`useProvidersList`](docs/sdks/providers/README.md#list) - List all providers
292
-
293
- </details>
294
- <!-- End React hooks with TanStack Query [react-query] -->
295
-
296
- <!-- Start Server-sent event streaming [eventstream] -->
297
- ## Server-sent event streaming
298
-
299
- [Server-sent events][mdn-sse] are used to stream content from certain
300
- operations. These operations will expose the stream as an async iterable that
301
- can be consumed using a [`for await...of`][mdn-for-await-of] loop. The loop will
302
- terminate when the server no longer has any events to send and closes the
303
- underlying connection.
304
-
305
- ```typescript
306
- import { OpenRouter } from "@openrouter/sdk";
307
-
308
- const openRouter = new OpenRouter({
309
- apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
310
- });
311
-
312
- async function run() {
313
- const result = await openRouter.beta.responses.send({});
314
-
315
- console.log(result);
316
- }
317
-
318
- run();
319
-
320
- ```
321
-
322
- [mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events
323
- [mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
324
- <!-- End Server-sent event streaming [eventstream] -->
325
-
326
- <!-- Start Retries [retries] -->
327
- ## Retries
328
-
329
- Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
330
-
331
- To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
332
- ```typescript
333
- import { OpenRouter } from "@openrouter/sdk";
334
-
335
- const openRouter = new OpenRouter({
336
- apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
337
- });
338
-
339
- async function run() {
340
- const result = await openRouter.beta.responses.send({}, {
341
- retries: {
342
- strategy: "backoff",
343
- backoff: {
344
- initialInterval: 1,
345
- maxInterval: 50,
346
- exponent: 1.1,
347
- maxElapsedTime: 100,
348
- },
349
- retryConnectionErrors: false,
69
+ const result = await openRouter.chat.send({
70
+ messages: [
71
+ {
72
+ role: "user",
73
+ content: "Hello, how are you?",
350
74
  },
351
- });
352
-
353
- console.log(result);
354
- }
355
-
356
- run();
357
-
358
- ```
359
-
360
- If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
361
- ```typescript
362
- import { OpenRouter } from "@openrouter/sdk";
363
-
364
- const openRouter = new OpenRouter({
365
- retryConfig: {
366
- strategy: "backoff",
367
- backoff: {
368
- initialInterval: 1,
369
- maxInterval: 50,
370
- exponent: 1.1,
371
- maxElapsedTime: 100,
372
- },
373
- retryConnectionErrors: false,
75
+ ],
76
+ model: "openai/gpt-5"
77
+ provider: {
78
+ zdr: true,
79
+ sort: "price",
374
80
  },
375
- apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
376
- });
377
-
378
- async function run() {
379
- const result = await openRouter.beta.responses.send({});
380
-
381
- console.log(result);
382
- }
383
-
384
- run();
385
-
386
- ```
387
- <!-- End Retries [retries] -->
388
-
389
- <!-- Start Error Handling [errors] -->
390
- ## Error Handling
391
-
392
- [`OpenRouterError`](./src/models/errors/openroutererror.ts) is the base class for all HTTP error responses. It has the following properties:
393
-
394
- | Property | Type | Description |
395
- | ------------------- | ---------- | --------------------------------------------------------------------------------------- |
396
- | `error.message` | `string` | Error message |
397
- | `error.statusCode` | `number` | HTTP response status code eg `404` |
398
- | `error.headers` | `Headers` | HTTP response headers |
399
- | `error.body` | `string` | HTTP body. Can be empty string if no body is returned. |
400
- | `error.rawResponse` | `Response` | Raw HTTP response |
401
- | `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
402
-
403
- ### Example
404
- ```typescript
405
- import { OpenRouter } from "@openrouter/sdk";
406
- import * as errors from "@openrouter/sdk/models/errors";
407
-
408
- const openRouter = new OpenRouter({
409
- apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
81
+ stream: true
410
82
  });
411
83
 
412
- async function run() {
413
- try {
414
- const result = await openRouter.analytics.getUserActivity({
415
- date: "2025-08-24",
416
- });
417
-
418
- console.log(result);
419
- } catch (error) {
420
- // The base class for HTTP error responses
421
- if (error instanceof errors.OpenRouterError) {
422
- console.log(error.message);
423
- console.log(error.statusCode);
424
- console.log(error.body);
425
- console.log(error.headers);
426
-
427
- // Depending on the method different errors may be thrown
428
- if (error instanceof errors.ErrorResponse) {
429
- console.log(error.data$.error); // models.ErrorResponseError
430
- console.log(error.data$.userId); // string
431
- }
432
- }
433
- }
84
+ for await (const chunk of stream) {
85
+ console.log(hunk.choices[0].delta.content)
434
86
  }
435
87
 
436
- run();
437
-
438
88
  ```
439
89
 
440
- ### Error Classes
441
- **Primary error:**
442
- * [`OpenRouterError`](./src/models/errors/openroutererror.ts): The base class for HTTP error responses.
90
+ <!-- No Authentication [security] -->
443
91
 
444
- <details><summary>Less common errors (9)</summary>
92
+ <!-- No Available Resources and Operations [operations] -->
445
93
 
446
- <br />
94
+ <!-- No Standalone functions [standalone-funcs] -->
447
95
 
448
- **Network errors:**
449
- * [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
450
- * [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
451
- * [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
452
- * [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
453
- * [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
96
+ <!-- No React hooks with TanStack Query [react-query] -->
454
97
 
98
+ <!-- No Server-sent event streaming [eventstream] -->
455
99
 
456
- **Inherit from [`OpenRouterError`](./src/models/errors/openroutererror.ts)**:
457
- * [`ErrorResponse`](./src/models/errors/errorresponse.ts): Error response. Applicable to 12 of 20 methods.*
458
- * [`ChatError`](./src/models/errors/chaterror.ts): Bad request - invalid parameters. Applicable to 2 of 20 methods.*
459
- * [`InternalServerError`](./src/models/errors/internalservererror.ts): Internal Server Error. Status code `500`. Applicable to 1 of 20 methods.*
460
- * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
100
+ <!-- No Retries [retries] -->
461
101
 
462
- </details>
463
-
464
- \* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
465
- <!-- End Error Handling [errors] -->
102
+ <!-- No Error Handling [errors] -->
466
103
 
467
104
  <!-- No Server Selection [server] -->
468
105
 
@@ -491,13 +128,32 @@ You can also enable a default debug logger by setting an environment variable `O
491
128
 
492
129
  # Development
493
130
 
131
+ ## Running Tests
132
+
133
+ To run the test suite, you'll need to set up your environment with an OpenRouter API key.
134
+
135
+ ### Local Development
136
+
137
+ 1. Copy the example environment file:
138
+
139
+ ```bash
140
+ cp .env.example .env
141
+ ```
142
+
143
+ 2. Edit `.env` and add your OpenRouter API key:
144
+
145
+ ```bash
146
+ OPENROUTER_API_KEY=your_api_key_here
147
+ ```
148
+
149
+ 3. Run the tests:
150
+
151
+ ```bash
152
+ npx vitest
153
+ ```
154
+
494
155
  ## Maturity
495
156
 
496
157
  This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
497
158
  to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
498
159
  looking for the latest version.
499
-
500
- ## Contributions
501
-
502
- While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
503
- We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
@@ -14,5 +14,5 @@ import { Result } from "../types/fp.js";
14
14
  * @remarks
15
15
  * Returns user activity data grouped by endpoint for the last 30 (completed) UTC days
16
16
  */
17
- export declare function analyticsGetUserActivity(client: OpenRouterCore, request?: operations.GetUserActivityRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.GetUserActivityResponse, errors.ErrorResponse | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
17
+ export declare function analyticsGetUserActivity(client: OpenRouterCore, request?: operations.GetUserActivityRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.GetUserActivityResponse, errors.BadRequestResponseError | errors.UnauthorizedResponseError | errors.ForbiddenResponseError | errors.InternalServerResponseError | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=analyticsGetUserActivity.d.ts.map
@@ -65,7 +65,7 @@ async function $do(client, request, options) {
65
65
  const req = requestRes.value;
66
66
  const doResult = await client._do(req, {
67
67
  context,
68
- errorCodes: ["4XX", "5XX"],
68
+ errorCodes: ["400", "401", "403", "4XX", "500", "5XX"],
69
69
  retryConfig: context.retryConfig,
70
70
  retryCodes: context.retryCodes,
71
71
  });
@@ -76,7 +76,7 @@ async function $do(client, request, options) {
76
76
  const responseFields = {
77
77
  HttpMeta: { Response: response, Request: req },
78
78
  };
79
- const [result] = await M.match(M.json(200, operations.GetUserActivityResponse$inboundSchema), M.jsonErr("4XX", errors.ErrorResponse$inboundSchema), M.jsonErr("5XX", errors.ErrorResponse$inboundSchema))(response, req, { extraFields: responseFields });
79
+ const [result] = await M.match(M.json(200, operations.GetUserActivityResponse$inboundSchema), M.jsonErr(400, errors.BadRequestResponseError$inboundSchema), M.jsonErr(401, errors.UnauthorizedResponseError$inboundSchema), M.jsonErr(403, errors.ForbiddenResponseError$inboundSchema), M.jsonErr(500, errors.InternalServerResponseError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
80
80
  if (!result.ok) {
81
81
  return [result, { status: "complete", request: req, response }];
82
82
  }
@@ -11,5 +11,5 @@ import { Result } from "../types/fp.js";
11
11
  /**
12
12
  * Create a new API key
13
13
  */
14
- export declare function apiKeysCreate(client: OpenRouterCore, request: operations.CreateKeysRequest, options?: RequestOptions): APIPromise<Result<operations.CreateKeysResponse, errors.ErrorResponse | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
14
+ export declare function apiKeysCreate(client: OpenRouterCore, request: operations.CreateKeysRequest, options?: RequestOptions): APIPromise<Result<operations.CreateKeysResponse, errors.BadRequestResponseError | errors.UnauthorizedResponseError | errors.TooManyRequestsResponseError | errors.InternalServerResponseError | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
15
15
  //# sourceMappingURL=apiKeysCreate.d.ts.map
@@ -59,7 +59,7 @@ async function $do(client, request, options) {
59
59
  const req = requestRes.value;
60
60
  const doResult = await client._do(req, {
61
61
  context,
62
- errorCodes: ["4XX", "5XX"],
62
+ errorCodes: ["400", "401", "429", "4XX", "500", "5XX"],
63
63
  retryConfig: context.retryConfig,
64
64
  retryCodes: context.retryCodes,
65
65
  });
@@ -70,7 +70,7 @@ async function $do(client, request, options) {
70
70
  const responseFields = {
71
71
  HttpMeta: { Response: response, Request: req },
72
72
  };
73
- const [result] = await M.match(M.json(201, operations.CreateKeysResponse$inboundSchema), M.jsonErr("4XX", errors.ErrorResponse$inboundSchema), M.jsonErr("5XX", errors.ErrorResponse$inboundSchema))(response, req, { extraFields: responseFields });
73
+ const [result] = await M.match(M.json(201, operations.CreateKeysResponse$inboundSchema), M.jsonErr(400, errors.BadRequestResponseError$inboundSchema), M.jsonErr(401, errors.UnauthorizedResponseError$inboundSchema), M.jsonErr(429, errors.TooManyRequestsResponseError$inboundSchema), M.jsonErr(500, errors.InternalServerResponseError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
74
74
  if (!result.ok) {
75
75
  return [result, { status: "complete", request: req, response }];
76
76
  }
@@ -11,5 +11,5 @@ import { Result } from "../types/fp.js";
11
11
  /**
12
12
  * Delete an API key
13
13
  */
14
- export declare function apiKeysDelete(client: OpenRouterCore, request: operations.DeleteKeysRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteKeysResponse, errors.ErrorResponse | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
14
+ export declare function apiKeysDelete(client: OpenRouterCore, request: operations.DeleteKeysRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteKeysResponse, errors.UnauthorizedResponseError | errors.NotFoundResponseError | errors.TooManyRequestsResponseError | errors.InternalServerResponseError | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
15
15
  //# sourceMappingURL=apiKeysDelete.d.ts.map
@@ -64,7 +64,7 @@ async function $do(client, request, options) {
64
64
  const req = requestRes.value;
65
65
  const doResult = await client._do(req, {
66
66
  context,
67
- errorCodes: ["4XX", "5XX"],
67
+ errorCodes: ["401", "404", "429", "4XX", "500", "5XX"],
68
68
  retryConfig: context.retryConfig,
69
69
  retryCodes: context.retryCodes,
70
70
  });
@@ -75,7 +75,7 @@ async function $do(client, request, options) {
75
75
  const responseFields = {
76
76
  HttpMeta: { Response: response, Request: req },
77
77
  };
78
- const [result] = await M.match(M.json(200, operations.DeleteKeysResponse$inboundSchema), M.jsonErr("4XX", errors.ErrorResponse$inboundSchema), M.jsonErr("5XX", errors.ErrorResponse$inboundSchema))(response, req, { extraFields: responseFields });
78
+ const [result] = await M.match(M.json(200, operations.DeleteKeysResponse$inboundSchema), M.jsonErr(401, errors.UnauthorizedResponseError$inboundSchema), M.jsonErr(404, errors.NotFoundResponseError$inboundSchema), M.jsonErr(429, errors.TooManyRequestsResponseError$inboundSchema), M.jsonErr(500, errors.InternalServerResponseError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
79
79
  if (!result.ok) {
80
80
  return [result, { status: "complete", request: req, response }];
81
81
  }
@@ -11,5 +11,5 @@ import { Result } from "../types/fp.js";
11
11
  /**
12
12
  * Get a single API key
13
13
  */
14
- export declare function apiKeysGet(client: OpenRouterCore, request: operations.GetKeyRequest, options?: RequestOptions): APIPromise<Result<operations.GetKeyResponse, errors.ErrorResponse | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
14
+ export declare function apiKeysGet(client: OpenRouterCore, request: operations.GetKeyRequest, options?: RequestOptions): APIPromise<Result<operations.GetKeyResponse, errors.UnauthorizedResponseError | errors.NotFoundResponseError | errors.TooManyRequestsResponseError | errors.InternalServerResponseError | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
15
15
  //# sourceMappingURL=apiKeysGet.d.ts.map
@@ -64,7 +64,7 @@ async function $do(client, request, options) {
64
64
  const req = requestRes.value;
65
65
  const doResult = await client._do(req, {
66
66
  context,
67
- errorCodes: ["4XX", "5XX"],
67
+ errorCodes: ["401", "404", "429", "4XX", "500", "5XX"],
68
68
  retryConfig: context.retryConfig,
69
69
  retryCodes: context.retryCodes,
70
70
  });
@@ -75,7 +75,7 @@ async function $do(client, request, options) {
75
75
  const responseFields = {
76
76
  HttpMeta: { Response: response, Request: req },
77
77
  };
78
- const [result] = await M.match(M.json(200, operations.GetKeyResponse$inboundSchema), M.jsonErr("4XX", errors.ErrorResponse$inboundSchema), M.jsonErr("5XX", errors.ErrorResponse$inboundSchema))(response, req, { extraFields: responseFields });
78
+ const [result] = await M.match(M.json(200, operations.GetKeyResponse$inboundSchema), M.jsonErr(401, errors.UnauthorizedResponseError$inboundSchema), M.jsonErr(404, errors.NotFoundResponseError$inboundSchema), M.jsonErr(429, errors.TooManyRequestsResponseError$inboundSchema), M.jsonErr(500, errors.InternalServerResponseError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
79
79
  if (!result.ok) {
80
80
  return [result, { status: "complete", request: req, response }];
81
81
  }
@@ -14,5 +14,5 @@ import { Result } from "../types/fp.js";
14
14
  * @remarks
15
15
  * Get information on the API key associated with the current authentication session
16
16
  */
17
- export declare function apiKeysGetCurrentKeyMetadata(client: OpenRouterCore, options?: RequestOptions): APIPromise<Result<operations.GetCurrentKeyResponse, errors.ErrorResponse | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
17
+ export declare function apiKeysGetCurrentKeyMetadata(client: OpenRouterCore, options?: RequestOptions): APIPromise<Result<operations.GetCurrentKeyResponse, errors.UnauthorizedResponseError | errors.InternalServerResponseError | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=apiKeysGetCurrentKeyMetadata.d.ts.map