@openrouter/sdk 0.5.1 → 0.9.11

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 (280) hide show
  1. package/FUNCTIONS.md +5 -1
  2. package/esm/funcs/analyticsGetUserActivity.d.ts +1 -1
  3. package/esm/funcs/analyticsGetUserActivity.js +4 -2
  4. package/esm/funcs/apiKeysCreate.d.ts +1 -1
  5. package/esm/funcs/apiKeysCreate.js +5 -3
  6. package/esm/funcs/apiKeysDelete.d.ts +1 -1
  7. package/esm/funcs/apiKeysDelete.js +3 -1
  8. package/esm/funcs/apiKeysGet.d.ts +1 -1
  9. package/esm/funcs/apiKeysGet.js +3 -1
  10. package/esm/funcs/apiKeysGetCurrentKeyMetadata.d.ts +1 -1
  11. package/esm/funcs/apiKeysGetCurrentKeyMetadata.js +14 -3
  12. package/esm/funcs/apiKeysList.d.ts +1 -1
  13. package/esm/funcs/apiKeysList.js +4 -2
  14. package/esm/funcs/apiKeysUpdate.d.ts +1 -1
  15. package/esm/funcs/apiKeysUpdate.js +3 -1
  16. package/esm/funcs/betaResponsesSend.d.ts +9 -5
  17. package/esm/funcs/betaResponsesSend.js +10 -5
  18. package/esm/funcs/chatSend.d.ts +11 -7
  19. package/esm/funcs/chatSend.js +28 -7
  20. package/esm/funcs/creditsCreateCoinbaseCharge.d.ts +1 -2
  21. package/esm/funcs/creditsCreateCoinbaseCharge.js +7 -4
  22. package/esm/funcs/creditsGetCredits.d.ts +2 -2
  23. package/esm/funcs/creditsGetCredits.js +15 -4
  24. package/esm/funcs/embeddingsGenerate.js +4 -2
  25. package/esm/funcs/embeddingsListModels.d.ts +2 -1
  26. package/esm/funcs/embeddingsListModels.js +15 -3
  27. package/esm/funcs/endpointsList.js +2 -0
  28. package/esm/funcs/endpointsListZdrEndpoints.d.ts +1 -1
  29. package/esm/funcs/endpointsListZdrEndpoints.js +14 -3
  30. package/esm/funcs/generationsGetGeneration.js +3 -1
  31. package/esm/funcs/guardrailsBulkAssignKeys.d.ts +1 -1
  32. package/esm/funcs/guardrailsBulkAssignKeys.js +3 -1
  33. package/esm/funcs/guardrailsBulkAssignMembers.d.ts +1 -1
  34. package/esm/funcs/guardrailsBulkAssignMembers.js +3 -1
  35. package/esm/funcs/guardrailsBulkUnassignKeys.d.ts +1 -1
  36. package/esm/funcs/guardrailsBulkUnassignKeys.js +3 -1
  37. package/esm/funcs/guardrailsBulkUnassignMembers.d.ts +1 -1
  38. package/esm/funcs/guardrailsBulkUnassignMembers.js +3 -1
  39. package/esm/funcs/guardrailsCreate.d.ts +1 -1
  40. package/esm/funcs/guardrailsCreate.js +5 -3
  41. package/esm/funcs/guardrailsDelete.d.ts +1 -1
  42. package/esm/funcs/guardrailsDelete.js +3 -1
  43. package/esm/funcs/guardrailsGet.d.ts +1 -1
  44. package/esm/funcs/guardrailsGet.js +3 -1
  45. package/esm/funcs/guardrailsList.d.ts +1 -1
  46. package/esm/funcs/guardrailsList.js +4 -2
  47. package/esm/funcs/guardrailsListGuardrailKeyAssignments.d.ts +1 -1
  48. package/esm/funcs/guardrailsListGuardrailKeyAssignments.js +3 -1
  49. package/esm/funcs/guardrailsListGuardrailMemberAssignments.d.ts +1 -1
  50. package/esm/funcs/guardrailsListGuardrailMemberAssignments.js +3 -1
  51. package/esm/funcs/guardrailsListKeyAssignments.d.ts +1 -1
  52. package/esm/funcs/guardrailsListKeyAssignments.js +4 -2
  53. package/esm/funcs/guardrailsListMemberAssignments.d.ts +1 -1
  54. package/esm/funcs/guardrailsListMemberAssignments.js +4 -2
  55. package/esm/funcs/guardrailsUpdate.d.ts +1 -1
  56. package/esm/funcs/guardrailsUpdate.js +3 -1
  57. package/esm/funcs/modelsCount.d.ts +2 -1
  58. package/esm/funcs/modelsCount.js +15 -3
  59. package/esm/funcs/modelsList.js +3 -1
  60. package/esm/funcs/modelsListForUser.d.ts +1 -1
  61. package/esm/funcs/modelsListForUser.js +15 -3
  62. package/esm/funcs/oAuthCreateAuthCode.js +4 -2
  63. package/esm/funcs/oAuthExchangeAuthCodeForAPIKey.js +4 -2
  64. package/esm/funcs/providersList.d.ts +1 -1
  65. package/esm/funcs/providersList.js +14 -3
  66. package/esm/lib/config.d.ts +2 -2
  67. package/esm/lib/config.js +2 -2
  68. package/esm/lib/model-result.d.ts +3 -5
  69. package/esm/lib/model-result.js +98 -46
  70. package/esm/models/assistantmessage.d.ts +47 -36
  71. package/esm/models/assistantmessage.js +35 -47
  72. package/esm/models/assistantmessageimages.d.ts +33 -0
  73. package/esm/models/assistantmessageimages.js +44 -0
  74. package/esm/models/chatgenerationparams.d.ts +318 -182
  75. package/esm/models/chatgenerationparams.js +157 -143
  76. package/esm/models/chatgenerationtokenusage.d.ts +48 -0
  77. package/esm/models/chatmessagecontentitem.d.ts +15 -10
  78. package/esm/models/chatmessagecontentitem.js +25 -4
  79. package/esm/models/chatmessagecontentitemaudio.d.ts +20 -2
  80. package/esm/models/chatmessagecontentitemaudio.js +9 -2
  81. package/esm/models/chatmessagecontentitemcachecontrol.d.ts +14 -3
  82. package/esm/models/chatmessagecontentitemcachecontrol.js +9 -2
  83. package/esm/models/chatmessagecontentitemimage.d.ts +26 -3
  84. package/esm/models/chatmessagecontentitemimage.js +12 -2
  85. package/esm/models/chatmessagecontentitemtext.d.ts +17 -2
  86. package/esm/models/chatmessagecontentitemtext.js +9 -2
  87. package/esm/models/chatmessagecontentitemvideo.d.ts +12 -55
  88. package/esm/models/chatmessagecontentitemvideo.js +5 -72
  89. package/esm/models/chatmessagecontentitemvideolegacy.d.ts +28 -0
  90. package/esm/models/chatmessagecontentitemvideolegacy.js +33 -0
  91. package/esm/models/chatmessagetokenlogprob.d.ts +15 -0
  92. package/esm/models/chatmessagetokenlogprobs.d.ts +9 -0
  93. package/esm/models/chatmessagetoolcall.d.ts +23 -2
  94. package/esm/models/chatmessagetoolcall.js +9 -2
  95. package/esm/models/chatresponse.d.ts +29 -1
  96. package/esm/models/chatresponse.js +6 -1
  97. package/esm/models/chatresponsechoice.d.ts +13 -2
  98. package/esm/models/chatresponsechoice.js +1 -2
  99. package/esm/models/chatstreamingchoice.d.ts +13 -2
  100. package/esm/models/chatstreamingchoice.js +1 -2
  101. package/esm/models/chatstreamingmessagechunk.d.ts +29 -2
  102. package/esm/models/chatstreamingmessagechunk.js +5 -2
  103. package/esm/models/chatstreamingmessagetoolcall.d.ts +38 -1
  104. package/esm/models/chatstreamingmessagetoolcall.js +9 -1
  105. package/esm/models/chatstreamingresponsechunk.d.ts +45 -11
  106. package/esm/models/chatstreamingresponsechunk.js +11 -25
  107. package/esm/models/chatstreamoptions.d.ts +8 -0
  108. package/esm/models/debugoptions.d.ts +18 -0
  109. package/esm/models/debugoptions.js +18 -0
  110. package/esm/models/developermessage.d.ts +35 -0
  111. package/esm/models/developermessage.js +24 -0
  112. package/esm/models/errors/index.d.ts +0 -1
  113. package/esm/models/errors/index.js +0 -1
  114. package/esm/models/index.d.ts +13 -5
  115. package/esm/models/index.js +13 -5
  116. package/esm/models/jsonschemaconfig.d.ts +17 -2
  117. package/esm/models/jsonschemaconfig.js +1 -1
  118. package/esm/models/message.d.ts +10 -23
  119. package/esm/models/message.js +3 -20
  120. package/esm/models/modelscountresponse.d.ts +4 -4
  121. package/esm/models/modelscountresponse.js +4 -4
  122. package/esm/models/namedtoolchoice.d.ts +15 -2
  123. package/esm/models/namedtoolchoice.js +6 -1
  124. package/esm/models/openairesponsesreasoningconfig.d.ts +1 -1
  125. package/esm/models/openairesponsesreasoningconfig.js +1 -1
  126. package/esm/models/openresponsesnonstreamingresponse.d.ts +4 -4
  127. package/esm/models/openresponsesnonstreamingresponse.js +3 -3
  128. package/esm/models/openresponsesreasoning.d.ts +2 -2
  129. package/esm/models/openresponsesreasoning.js +1 -1
  130. package/esm/models/openresponsesreasoningconfig.d.ts +2 -2
  131. package/esm/models/openresponsesreasoningconfig.js +1 -1
  132. package/esm/models/openresponsesrequest.d.ts +31 -13
  133. package/esm/models/openresponsesrequest.js +25 -0
  134. package/esm/models/operations/bulkassignkeystoguardrail.d.ts +30 -0
  135. package/esm/models/operations/bulkassignkeystoguardrail.js +4 -0
  136. package/esm/models/operations/bulkassignmemberstoguardrail.d.ts +30 -0
  137. package/esm/models/operations/bulkassignmemberstoguardrail.js +4 -0
  138. package/esm/models/operations/bulkunassignkeysfromguardrail.d.ts +30 -0
  139. package/esm/models/operations/bulkunassignkeysfromguardrail.js +4 -0
  140. package/esm/models/operations/bulkunassignmembersfromguardrail.d.ts +30 -0
  141. package/esm/models/operations/bulkunassignmembersfromguardrail.js +4 -0
  142. package/esm/models/operations/createauthkeyscode.d.ts +66 -2
  143. package/esm/models/operations/createauthkeyscode.js +30 -1
  144. package/esm/models/operations/createcoinbasecharge.d.ts +41 -0
  145. package/esm/models/operations/createcoinbasecharge.js +16 -0
  146. package/esm/models/operations/createembeddings.d.ts +42 -2
  147. package/esm/models/operations/createembeddings.js +16 -1
  148. package/esm/models/operations/createguardrail.d.ts +42 -2
  149. package/esm/models/operations/createguardrail.js +16 -1
  150. package/esm/models/operations/createkeys.d.ts +42 -2
  151. package/esm/models/operations/createkeys.js +16 -1
  152. package/esm/models/operations/createresponses.d.ts +40 -0
  153. package/esm/models/operations/createresponses.js +16 -0
  154. package/esm/models/operations/deleteguardrail.d.ts +30 -0
  155. package/esm/models/operations/deleteguardrail.js +8 -0
  156. package/esm/models/operations/deletekeys.d.ts +30 -0
  157. package/esm/models/operations/deletekeys.js +8 -0
  158. package/esm/models/operations/exchangeauthcodeforapikey.d.ts +42 -2
  159. package/esm/models/operations/exchangeauthcodeforapikey.js +16 -1
  160. package/esm/models/operations/getcredits.d.ts +38 -0
  161. package/esm/models/operations/getcredits.js +13 -0
  162. package/esm/models/operations/getcurrentkey.d.ts +45 -1
  163. package/esm/models/operations/getcurrentkey.js +15 -0
  164. package/esm/models/operations/getgeneration.d.ts +153 -0
  165. package/esm/models/operations/getgeneration.js +135 -0
  166. package/esm/models/operations/getguardrail.d.ts +30 -0
  167. package/esm/models/operations/getguardrail.js +7 -0
  168. package/esm/models/operations/getkey.d.ts +30 -0
  169. package/esm/models/operations/getkey.js +7 -0
  170. package/esm/models/operations/getmodels.d.ts +30 -0
  171. package/esm/models/operations/getmodels.js +4 -0
  172. package/esm/models/operations/getuseractivity.d.ts +30 -0
  173. package/esm/models/operations/getuseractivity.js +8 -0
  174. package/esm/models/operations/index.d.ts +2 -0
  175. package/esm/models/operations/index.js +2 -0
  176. package/esm/models/operations/list.d.ts +30 -0
  177. package/esm/models/operations/list.js +4 -0
  178. package/esm/models/operations/listembeddingsmodels.d.ts +40 -0
  179. package/esm/models/operations/listembeddingsmodels.js +20 -0
  180. package/esm/models/operations/listendpoints.d.ts +30 -0
  181. package/esm/models/operations/listendpoints.js +8 -0
  182. package/esm/models/operations/listendpointszdr.d.ts +38 -0
  183. package/esm/models/operations/listendpointszdr.js +14 -0
  184. package/esm/models/operations/listguardrailkeyassignments.d.ts +30 -0
  185. package/esm/models/operations/listguardrailkeyassignments.js +7 -0
  186. package/esm/models/operations/listguardrailmemberassignments.d.ts +30 -0
  187. package/esm/models/operations/listguardrailmemberassignments.js +7 -0
  188. package/esm/models/operations/listguardrails.d.ts +30 -0
  189. package/esm/models/operations/listguardrails.js +7 -0
  190. package/esm/models/operations/listkeyassignments.d.ts +30 -0
  191. package/esm/models/operations/listkeyassignments.js +7 -0
  192. package/esm/models/operations/listmemberassignments.d.ts +30 -0
  193. package/esm/models/operations/listmemberassignments.js +7 -0
  194. package/esm/models/operations/listmodelscount.d.ts +40 -0
  195. package/esm/models/operations/listmodelscount.js +20 -0
  196. package/esm/models/operations/listmodelsuser.d.ts +38 -0
  197. package/esm/models/operations/listmodelsuser.js +14 -0
  198. package/esm/models/operations/listproviders.d.ts +38 -0
  199. package/esm/models/operations/listproviders.js +13 -0
  200. package/esm/models/operations/sendchatcompletionrequest.d.ts +53 -1
  201. package/esm/models/operations/sendchatcompletionrequest.js +36 -2
  202. package/esm/models/operations/updateguardrail.d.ts +30 -0
  203. package/esm/models/operations/updateguardrail.js +4 -0
  204. package/esm/models/operations/updatekeys.d.ts +30 -0
  205. package/esm/models/operations/updatekeys.js +4 -0
  206. package/esm/models/providername.d.ts +4 -0
  207. package/esm/models/providername.js +4 -0
  208. package/esm/models/providerpreferences.d.ts +46 -27
  209. package/esm/models/providerpreferences.js +29 -15
  210. package/esm/models/providersort.d.ts +6 -0
  211. package/esm/models/providersort.js +3 -0
  212. package/esm/models/providersortconfig.d.ts +30 -2
  213. package/esm/models/providersortconfig.js +15 -2
  214. package/esm/models/publicendpoint.d.ts +0 -39
  215. package/esm/models/publicpricing.d.ts +0 -39
  216. package/esm/models/reasoningdetailencrypted.d.ts +42 -0
  217. package/esm/models/reasoningdetailencrypted.js +42 -0
  218. package/esm/models/reasoningdetailsummary.d.ts +42 -0
  219. package/esm/models/reasoningdetailsummary.js +42 -0
  220. package/esm/models/reasoningdetailtext.d.ts +44 -0
  221. package/esm/models/reasoningdetailtext.js +44 -0
  222. package/esm/models/reasoningdetailunion.d.ts +19 -0
  223. package/esm/models/reasoningdetailunion.js +28 -0
  224. package/esm/models/responseformatjsonobject.d.ts +20 -0
  225. package/esm/models/responseformatjsonobject.js +21 -0
  226. package/esm/models/responseformatjsonschema.d.ts +6 -0
  227. package/esm/models/responseformattext.d.ts +15 -0
  228. package/esm/models/responseformattext.js +13 -0
  229. package/esm/models/responseformattextconfig.d.ts +3 -3
  230. package/esm/models/responseformattextconfig.js +3 -3
  231. package/esm/models/responseformattextgrammar.d.ts +6 -0
  232. package/esm/models/responseformattextpython.d.ts +15 -0
  233. package/esm/models/responseformattextpython.js +13 -0
  234. package/esm/models/responseserrorfield.d.ts +4 -4
  235. package/esm/models/responseserrorfield.js +4 -4
  236. package/esm/models/responsesoutputitemreasoning.d.ts +2 -2
  237. package/esm/models/responsesoutputitemreasoning.js +2 -2
  238. package/esm/models/systemmessage.d.ts +12 -0
  239. package/esm/models/toolchoiceoption.d.ts +31 -0
  240. package/esm/models/toolchoiceoption.js +32 -0
  241. package/esm/models/tooldefinitionjson.d.ts +38 -4
  242. package/esm/models/tooldefinitionjson.js +14 -2
  243. package/esm/models/toolresponsemessage.d.ts +12 -0
  244. package/esm/models/usermessage.d.ts +12 -0
  245. package/esm/models/videoinput.d.ts +23 -0
  246. package/esm/models/videoinput.js +22 -0
  247. package/esm/sdk/analytics.d.ts +1 -1
  248. package/esm/sdk/analytics.js +1 -1
  249. package/esm/sdk/apikeys.d.ts +6 -6
  250. package/esm/sdk/apikeys.js +7 -7
  251. package/esm/sdk/chat.d.ts +10 -6
  252. package/esm/sdk/credits.d.ts +3 -4
  253. package/esm/sdk/credits.js +3 -3
  254. package/esm/sdk/embeddings.d.ts +1 -1
  255. package/esm/sdk/embeddings.js +2 -2
  256. package/esm/sdk/endpoints.d.ts +1 -1
  257. package/esm/sdk/endpoints.js +2 -2
  258. package/esm/sdk/guardrails.d.ts +13 -13
  259. package/esm/sdk/guardrails.js +13 -13
  260. package/esm/sdk/models.d.ts +2 -2
  261. package/esm/sdk/models.js +4 -4
  262. package/esm/sdk/providers.d.ts +1 -1
  263. package/esm/sdk/providers.js +2 -2
  264. package/esm/sdk/responses.d.ts +9 -5
  265. package/esm/sdk/sdk.d.ts +2 -2
  266. package/esm/sdk/sdk.js +3 -3
  267. package/jsr.json +1 -1
  268. package/package.json +1 -1
  269. package/esm/models/chaterror.d.ts +0 -17
  270. package/esm/models/chaterror.js +0 -25
  271. package/esm/models/errors/chaterror.d.ts +0 -19
  272. package/esm/models/errors/chaterror.js +0 -32
  273. package/esm/models/providersortunion.d.ts +0 -10
  274. package/esm/models/providersortunion.js +0 -13
  275. package/esm/models/responsesformatjsonobject.d.ts +0 -20
  276. package/esm/models/responsesformatjsonobject.js +0 -21
  277. package/esm/models/schema0.d.ts +0 -84
  278. package/esm/models/schema0.js +0 -87
  279. package/esm/models/schema2.d.ts +0 -92
  280. package/esm/models/schema2.js +0 -109
@@ -2,6 +2,21 @@ import * as z from "zod/v4";
2
2
  import { OpenEnum } from "../../types/enums.js";
3
3
  import { Result as SafeParseResult } from "../../types/fp.js";
4
4
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
+ export type CreateKeysGlobals = {
6
+ /**
7
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
8
+ *
9
+ * @remarks
10
+ * This is used to track API usage per application.
11
+ */
12
+ httpReferer?: string | undefined;
13
+ /**
14
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
15
+ *
16
+ * @remarks
17
+ */
18
+ xTitle?: string | undefined;
19
+ };
5
20
  /**
6
21
  * Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.
7
22
  */
@@ -14,7 +29,7 @@ export declare const CreateKeysLimitReset: {
14
29
  * Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.
15
30
  */
16
31
  export type CreateKeysLimitReset = OpenEnum<typeof CreateKeysLimitReset>;
17
- export type CreateKeysRequest = {
32
+ export type CreateKeysRequestBody = {
18
33
  /**
19
34
  * Name for the new API key
20
35
  */
@@ -36,6 +51,22 @@ export type CreateKeysRequest = {
36
51
  */
37
52
  expiresAt?: Date | null | undefined;
38
53
  };
54
+ export type CreateKeysRequest = {
55
+ /**
56
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
57
+ *
58
+ * @remarks
59
+ * This is used to track API usage per application.
60
+ */
61
+ httpReferer?: string | undefined;
62
+ /**
63
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
64
+ *
65
+ * @remarks
66
+ */
67
+ xTitle?: string | undefined;
68
+ requestBody: CreateKeysRequestBody;
69
+ };
39
70
  /**
40
71
  * The created API key information
41
72
  */
@@ -133,7 +164,7 @@ export type CreateKeysResponse = {
133
164
  /** @internal */
134
165
  export declare const CreateKeysLimitReset$outboundSchema: z.ZodType<string, CreateKeysLimitReset>;
135
166
  /** @internal */
136
- export type CreateKeysRequest$Outbound = {
167
+ export type CreateKeysRequestBody$Outbound = {
137
168
  name: string;
138
169
  limit?: number | null | undefined;
139
170
  limit_reset?: string | null | undefined;
@@ -141,6 +172,15 @@ export type CreateKeysRequest$Outbound = {
141
172
  expires_at?: string | null | undefined;
142
173
  };
143
174
  /** @internal */
175
+ export declare const CreateKeysRequestBody$outboundSchema: z.ZodType<CreateKeysRequestBody$Outbound, CreateKeysRequestBody>;
176
+ export declare function createKeysRequestBodyToJSON(createKeysRequestBody: CreateKeysRequestBody): string;
177
+ /** @internal */
178
+ export type CreateKeysRequest$Outbound = {
179
+ "HTTP-Referer"?: string | undefined;
180
+ "X-Title"?: string | undefined;
181
+ RequestBody: CreateKeysRequestBody$Outbound;
182
+ };
183
+ /** @internal */
144
184
  export declare const CreateKeysRequest$outboundSchema: z.ZodType<CreateKeysRequest$Outbound, CreateKeysRequest>;
145
185
  export declare function createKeysRequestToJSON(createKeysRequest: CreateKeysRequest): string;
146
186
  /** @internal */
@@ -17,7 +17,7 @@ export const CreateKeysLimitReset = {
17
17
  /** @internal */
18
18
  export const CreateKeysLimitReset$outboundSchema = openEnums.outboundSchema(CreateKeysLimitReset);
19
19
  /** @internal */
20
- export const CreateKeysRequest$outboundSchema = z.object({
20
+ export const CreateKeysRequestBody$outboundSchema = z.object({
21
21
  name: z.string(),
22
22
  limit: z.nullable(z.number()).optional(),
23
23
  limitReset: z.nullable(CreateKeysLimitReset$outboundSchema).optional(),
@@ -30,6 +30,21 @@ export const CreateKeysRequest$outboundSchema = z.object({
30
30
  expiresAt: "expires_at",
31
31
  });
32
32
  });
33
+ export function createKeysRequestBodyToJSON(createKeysRequestBody) {
34
+ return JSON.stringify(CreateKeysRequestBody$outboundSchema.parse(createKeysRequestBody));
35
+ }
36
+ /** @internal */
37
+ export const CreateKeysRequest$outboundSchema = z.object({
38
+ httpReferer: z.string().optional(),
39
+ xTitle: z.string().optional(),
40
+ requestBody: z.lazy(() => CreateKeysRequestBody$outboundSchema),
41
+ }).transform((v) => {
42
+ return remap$(v, {
43
+ httpReferer: "HTTP-Referer",
44
+ xTitle: "X-Title",
45
+ requestBody: "RequestBody",
46
+ });
47
+ });
33
48
  export function createKeysRequestToJSON(createKeysRequest) {
34
49
  return JSON.stringify(CreateKeysRequest$outboundSchema.parse(createKeysRequest));
35
50
  }
@@ -3,6 +3,37 @@ import { EventStream } from "../../lib/event-streams.js";
3
3
  import { Result as SafeParseResult } from "../../types/fp.js";
4
4
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
5
  import * as models from "../index.js";
6
+ export type CreateResponsesGlobals = {
7
+ /**
8
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
9
+ *
10
+ * @remarks
11
+ * This is used to track API usage per application.
12
+ */
13
+ httpReferer?: string | undefined;
14
+ /**
15
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
16
+ *
17
+ * @remarks
18
+ */
19
+ xTitle?: string | undefined;
20
+ };
21
+ export type CreateResponsesRequest = {
22
+ /**
23
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
24
+ *
25
+ * @remarks
26
+ * This is used to track API usage per application.
27
+ */
28
+ httpReferer?: string | undefined;
29
+ /**
30
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
31
+ *
32
+ * @remarks
33
+ */
34
+ xTitle?: string | undefined;
35
+ openResponsesRequest: models.OpenResponsesRequest;
36
+ };
6
37
  /**
7
38
  * Successful response
8
39
  */
@@ -14,6 +45,15 @@ export type CreateResponsesResponseBody = {
14
45
  };
15
46
  export type CreateResponsesResponse = models.OpenResponsesNonStreamingResponse | EventStream<models.OpenResponsesStreamEvent>;
16
47
  /** @internal */
48
+ export type CreateResponsesRequest$Outbound = {
49
+ "HTTP-Referer"?: string | undefined;
50
+ "X-Title"?: string | undefined;
51
+ OpenResponsesRequest: models.OpenResponsesRequest$Outbound;
52
+ };
53
+ /** @internal */
54
+ export declare const CreateResponsesRequest$outboundSchema: z.ZodType<CreateResponsesRequest$Outbound, CreateResponsesRequest>;
55
+ export declare function createResponsesRequestToJSON(createResponsesRequest: CreateResponsesRequest): string;
56
+ /** @internal */
17
57
  export declare const CreateResponsesResponseBody$inboundSchema: z.ZodType<CreateResponsesResponseBody, unknown>;
18
58
  export declare function createResponsesResponseBodyFromJSON(jsonString: string): SafeParseResult<CreateResponsesResponseBody, SDKValidationError>;
19
59
  /** @internal */
@@ -4,9 +4,25 @@
4
4
  */
5
5
  import * as z from "zod/v4";
6
6
  import { EventStream } from "../../lib/event-streams.js";
7
+ import { remap as remap$ } from "../../lib/primitives.js";
7
8
  import { safeParse } from "../../lib/schemas.js";
8
9
  import * as models from "../index.js";
9
10
  /** @internal */
11
+ export const CreateResponsesRequest$outboundSchema = z.object({
12
+ httpReferer: z.string().optional(),
13
+ xTitle: z.string().optional(),
14
+ openResponsesRequest: models.OpenResponsesRequest$outboundSchema,
15
+ }).transform((v) => {
16
+ return remap$(v, {
17
+ httpReferer: "HTTP-Referer",
18
+ xTitle: "X-Title",
19
+ openResponsesRequest: "OpenResponsesRequest",
20
+ });
21
+ });
22
+ export function createResponsesRequestToJSON(createResponsesRequest) {
23
+ return JSON.stringify(CreateResponsesRequest$outboundSchema.parse(createResponsesRequest));
24
+ }
25
+ /** @internal */
10
26
  export const CreateResponsesResponseBody$inboundSchema = z.object({
11
27
  data: z.string().transform((v, ctx) => {
12
28
  try {
@@ -1,7 +1,35 @@
1
1
  import * as z from "zod/v4";
2
2
  import { Result as SafeParseResult } from "../../types/fp.js";
3
3
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
+ export type DeleteGuardrailGlobals = {
5
+ /**
6
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
7
+ *
8
+ * @remarks
9
+ * This is used to track API usage per application.
10
+ */
11
+ httpReferer?: string | undefined;
12
+ /**
13
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
14
+ *
15
+ * @remarks
16
+ */
17
+ xTitle?: string | undefined;
18
+ };
4
19
  export type DeleteGuardrailRequest = {
20
+ /**
21
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
22
+ *
23
+ * @remarks
24
+ * This is used to track API usage per application.
25
+ */
26
+ httpReferer?: string | undefined;
27
+ /**
28
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
29
+ *
30
+ * @remarks
31
+ */
32
+ xTitle?: string | undefined;
5
33
  /**
6
34
  * The unique identifier of the guardrail to delete
7
35
  */
@@ -18,6 +46,8 @@ export type DeleteGuardrailResponse = {
18
46
  };
19
47
  /** @internal */
20
48
  export type DeleteGuardrailRequest$Outbound = {
49
+ "HTTP-Referer"?: string | undefined;
50
+ "X-Title"?: string | undefined;
21
51
  id: string;
22
52
  };
23
53
  /** @internal */
@@ -3,10 +3,18 @@
3
3
  * @generated-id: 0319276942bf
4
4
  */
5
5
  import * as z from "zod/v4";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
6
7
  import { safeParse } from "../../lib/schemas.js";
7
8
  /** @internal */
8
9
  export const DeleteGuardrailRequest$outboundSchema = z.object({
10
+ httpReferer: z.string().optional(),
11
+ xTitle: z.string().optional(),
9
12
  id: z.string(),
13
+ }).transform((v) => {
14
+ return remap$(v, {
15
+ httpReferer: "HTTP-Referer",
16
+ xTitle: "X-Title",
17
+ });
10
18
  });
11
19
  export function deleteGuardrailRequestToJSON(deleteGuardrailRequest) {
12
20
  return JSON.stringify(DeleteGuardrailRequest$outboundSchema.parse(deleteGuardrailRequest));
@@ -1,7 +1,35 @@
1
1
  import * as z from "zod/v4";
2
2
  import { Result as SafeParseResult } from "../../types/fp.js";
3
3
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
+ export type DeleteKeysGlobals = {
5
+ /**
6
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
7
+ *
8
+ * @remarks
9
+ * This is used to track API usage per application.
10
+ */
11
+ httpReferer?: string | undefined;
12
+ /**
13
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
14
+ *
15
+ * @remarks
16
+ */
17
+ xTitle?: string | undefined;
18
+ };
4
19
  export type DeleteKeysRequest = {
20
+ /**
21
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
22
+ *
23
+ * @remarks
24
+ * This is used to track API usage per application.
25
+ */
26
+ httpReferer?: string | undefined;
27
+ /**
28
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
29
+ *
30
+ * @remarks
31
+ */
32
+ xTitle?: string | undefined;
5
33
  /**
6
34
  * The hash identifier of the API key to delete
7
35
  */
@@ -18,6 +46,8 @@ export type DeleteKeysResponse = {
18
46
  };
19
47
  /** @internal */
20
48
  export type DeleteKeysRequest$Outbound = {
49
+ "HTTP-Referer"?: string | undefined;
50
+ "X-Title"?: string | undefined;
21
51
  hash: string;
22
52
  };
23
53
  /** @internal */
@@ -3,10 +3,18 @@
3
3
  * @generated-id: efa22339a3d6
4
4
  */
5
5
  import * as z from "zod/v4";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
6
7
  import { safeParse } from "../../lib/schemas.js";
7
8
  /** @internal */
8
9
  export const DeleteKeysRequest$outboundSchema = z.object({
10
+ httpReferer: z.string().optional(),
11
+ xTitle: z.string().optional(),
9
12
  hash: z.string(),
13
+ }).transform((v) => {
14
+ return remap$(v, {
15
+ httpReferer: "HTTP-Referer",
16
+ xTitle: "X-Title",
17
+ });
10
18
  });
11
19
  export function deleteKeysRequestToJSON(deleteKeysRequest) {
12
20
  return JSON.stringify(DeleteKeysRequest$outboundSchema.parse(deleteKeysRequest));
@@ -2,6 +2,21 @@ import * as z from "zod/v4";
2
2
  import { OpenEnum } from "../../types/enums.js";
3
3
  import { Result as SafeParseResult } from "../../types/fp.js";
4
4
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
+ export type ExchangeAuthCodeForAPIKeyGlobals = {
6
+ /**
7
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
8
+ *
9
+ * @remarks
10
+ * This is used to track API usage per application.
11
+ */
12
+ httpReferer?: string | undefined;
13
+ /**
14
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
15
+ *
16
+ * @remarks
17
+ */
18
+ xTitle?: string | undefined;
19
+ };
5
20
  /**
6
21
  * The method used to generate the code challenge
7
22
  */
@@ -13,7 +28,7 @@ export declare const ExchangeAuthCodeForAPIKeyCodeChallengeMethod: {
13
28
  * The method used to generate the code challenge
14
29
  */
15
30
  export type ExchangeAuthCodeForAPIKeyCodeChallengeMethod = OpenEnum<typeof ExchangeAuthCodeForAPIKeyCodeChallengeMethod>;
16
- export type ExchangeAuthCodeForAPIKeyRequest = {
31
+ export type ExchangeAuthCodeForAPIKeyRequestBody = {
17
32
  /**
18
33
  * The authorization code received from the OAuth redirect
19
34
  */
@@ -27,6 +42,22 @@ export type ExchangeAuthCodeForAPIKeyRequest = {
27
42
  */
28
43
  codeChallengeMethod?: ExchangeAuthCodeForAPIKeyCodeChallengeMethod | null | undefined;
29
44
  };
45
+ export type ExchangeAuthCodeForAPIKeyRequest = {
46
+ /**
47
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
48
+ *
49
+ * @remarks
50
+ * This is used to track API usage per application.
51
+ */
52
+ httpReferer?: string | undefined;
53
+ /**
54
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
55
+ *
56
+ * @remarks
57
+ */
58
+ xTitle?: string | undefined;
59
+ requestBody: ExchangeAuthCodeForAPIKeyRequestBody;
60
+ };
30
61
  /**
31
62
  * Successfully exchanged code for an API key
32
63
  */
@@ -43,12 +74,21 @@ export type ExchangeAuthCodeForAPIKeyResponse = {
43
74
  /** @internal */
44
75
  export declare const ExchangeAuthCodeForAPIKeyCodeChallengeMethod$outboundSchema: z.ZodType<string, ExchangeAuthCodeForAPIKeyCodeChallengeMethod>;
45
76
  /** @internal */
46
- export type ExchangeAuthCodeForAPIKeyRequest$Outbound = {
77
+ export type ExchangeAuthCodeForAPIKeyRequestBody$Outbound = {
47
78
  code: string;
48
79
  code_verifier?: string | undefined;
49
80
  code_challenge_method?: string | null | undefined;
50
81
  };
51
82
  /** @internal */
83
+ export declare const ExchangeAuthCodeForAPIKeyRequestBody$outboundSchema: z.ZodType<ExchangeAuthCodeForAPIKeyRequestBody$Outbound, ExchangeAuthCodeForAPIKeyRequestBody>;
84
+ export declare function exchangeAuthCodeForAPIKeyRequestBodyToJSON(exchangeAuthCodeForAPIKeyRequestBody: ExchangeAuthCodeForAPIKeyRequestBody): string;
85
+ /** @internal */
86
+ export type ExchangeAuthCodeForAPIKeyRequest$Outbound = {
87
+ "HTTP-Referer"?: string | undefined;
88
+ "X-Title"?: string | undefined;
89
+ RequestBody: ExchangeAuthCodeForAPIKeyRequestBody$Outbound;
90
+ };
91
+ /** @internal */
52
92
  export declare const ExchangeAuthCodeForAPIKeyRequest$outboundSchema: z.ZodType<ExchangeAuthCodeForAPIKeyRequest$Outbound, ExchangeAuthCodeForAPIKeyRequest>;
53
93
  export declare function exchangeAuthCodeForAPIKeyRequestToJSON(exchangeAuthCodeForAPIKeyRequest: ExchangeAuthCodeForAPIKeyRequest): string;
54
94
  /** @internal */
@@ -17,7 +17,7 @@ export const ExchangeAuthCodeForAPIKeyCodeChallengeMethod = {
17
17
  export const ExchangeAuthCodeForAPIKeyCodeChallengeMethod$outboundSchema = openEnums
18
18
  .outboundSchema(ExchangeAuthCodeForAPIKeyCodeChallengeMethod);
19
19
  /** @internal */
20
- export const ExchangeAuthCodeForAPIKeyRequest$outboundSchema = z.object({
20
+ export const ExchangeAuthCodeForAPIKeyRequestBody$outboundSchema = z.object({
21
21
  code: z.string(),
22
22
  codeVerifier: z.string().optional(),
23
23
  codeChallengeMethod: z.nullable(ExchangeAuthCodeForAPIKeyCodeChallengeMethod$outboundSchema).optional(),
@@ -27,6 +27,21 @@ export const ExchangeAuthCodeForAPIKeyRequest$outboundSchema = z.object({
27
27
  codeChallengeMethod: "code_challenge_method",
28
28
  });
29
29
  });
30
+ export function exchangeAuthCodeForAPIKeyRequestBodyToJSON(exchangeAuthCodeForAPIKeyRequestBody) {
31
+ return JSON.stringify(ExchangeAuthCodeForAPIKeyRequestBody$outboundSchema.parse(exchangeAuthCodeForAPIKeyRequestBody));
32
+ }
33
+ /** @internal */
34
+ export const ExchangeAuthCodeForAPIKeyRequest$outboundSchema = z.object({
35
+ httpReferer: z.string().optional(),
36
+ xTitle: z.string().optional(),
37
+ requestBody: z.lazy(() => ExchangeAuthCodeForAPIKeyRequestBody$outboundSchema),
38
+ }).transform((v) => {
39
+ return remap$(v, {
40
+ httpReferer: "HTTP-Referer",
41
+ xTitle: "X-Title",
42
+ requestBody: "RequestBody",
43
+ });
44
+ });
30
45
  export function exchangeAuthCodeForAPIKeyRequestToJSON(exchangeAuthCodeForAPIKeyRequest) {
31
46
  return JSON.stringify(ExchangeAuthCodeForAPIKeyRequest$outboundSchema.parse(exchangeAuthCodeForAPIKeyRequest));
32
47
  }
@@ -1,6 +1,36 @@
1
1
  import * as z from "zod/v4";
2
2
  import { Result as SafeParseResult } from "../../types/fp.js";
3
3
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
+ export type GetCreditsGlobals = {
5
+ /**
6
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
7
+ *
8
+ * @remarks
9
+ * This is used to track API usage per application.
10
+ */
11
+ httpReferer?: string | undefined;
12
+ /**
13
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
14
+ *
15
+ * @remarks
16
+ */
17
+ xTitle?: string | undefined;
18
+ };
19
+ export type GetCreditsRequest = {
20
+ /**
21
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
22
+ *
23
+ * @remarks
24
+ * This is used to track API usage per application.
25
+ */
26
+ httpReferer?: string | undefined;
27
+ /**
28
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
29
+ *
30
+ * @remarks
31
+ */
32
+ xTitle?: string | undefined;
33
+ };
4
34
  export type GetCreditsData = {
5
35
  /**
6
36
  * Total credits purchased
@@ -18,6 +48,14 @@ export type GetCreditsResponse = {
18
48
  data: GetCreditsData;
19
49
  };
20
50
  /** @internal */
51
+ export type GetCreditsRequest$Outbound = {
52
+ "HTTP-Referer"?: string | undefined;
53
+ "X-Title"?: string | undefined;
54
+ };
55
+ /** @internal */
56
+ export declare const GetCreditsRequest$outboundSchema: z.ZodType<GetCreditsRequest$Outbound, GetCreditsRequest>;
57
+ export declare function getCreditsRequestToJSON(getCreditsRequest: GetCreditsRequest): string;
58
+ /** @internal */
21
59
  export declare const GetCreditsData$inboundSchema: z.ZodType<GetCreditsData, unknown>;
22
60
  export declare function getCreditsDataFromJSON(jsonString: string): SafeParseResult<GetCreditsData, SDKValidationError>;
23
61
  /** @internal */
@@ -6,6 +6,19 @@ import * as z from "zod/v4";
6
6
  import { remap as remap$ } from "../../lib/primitives.js";
7
7
  import { safeParse } from "../../lib/schemas.js";
8
8
  /** @internal */
9
+ export const GetCreditsRequest$outboundSchema = z.object({
10
+ httpReferer: z.string().optional(),
11
+ xTitle: z.string().optional(),
12
+ }).transform((v) => {
13
+ return remap$(v, {
14
+ httpReferer: "HTTP-Referer",
15
+ xTitle: "X-Title",
16
+ });
17
+ });
18
+ export function getCreditsRequestToJSON(getCreditsRequest) {
19
+ return JSON.stringify(GetCreditsRequest$outboundSchema.parse(getCreditsRequest));
20
+ }
21
+ /** @internal */
9
22
  export const GetCreditsData$inboundSchema = z.object({
10
23
  total_credits: z.number(),
11
24
  total_usage: z.number(),
@@ -1,6 +1,36 @@
1
1
  import * as z from "zod/v4";
2
2
  import { Result as SafeParseResult } from "../../types/fp.js";
3
3
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
+ export type GetCurrentKeyGlobals = {
5
+ /**
6
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
7
+ *
8
+ * @remarks
9
+ * This is used to track API usage per application.
10
+ */
11
+ httpReferer?: string | undefined;
12
+ /**
13
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
14
+ *
15
+ * @remarks
16
+ */
17
+ xTitle?: string | undefined;
18
+ };
19
+ export type GetCurrentKeyRequest = {
20
+ /**
21
+ * The app identifier should be your app's URL and is used as the primary identifier for rankings.
22
+ *
23
+ * @remarks
24
+ * This is used to track API usage per application.
25
+ */
26
+ httpReferer?: string | undefined;
27
+ /**
28
+ * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
29
+ *
30
+ * @remarks
31
+ */
32
+ xTitle?: string | undefined;
33
+ };
4
34
  /**
5
35
  * Legacy rate limit information about a key. Will always return -1.
6
36
  *
@@ -69,7 +99,13 @@ export type GetCurrentKeyData = {
69
99
  */
70
100
  isFreeTier: boolean;
71
101
  /**
72
- * Whether this is a provisioning key
102
+ * Whether this is a management key
103
+ */
104
+ isManagementKey: boolean;
105
+ /**
106
+ * Whether this is a management key
107
+ *
108
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
73
109
  */
74
110
  isProvisioningKey: boolean;
75
111
  /**
@@ -105,6 +141,14 @@ export type GetCurrentKeyResponse = {
105
141
  data: GetCurrentKeyData;
106
142
  };
107
143
  /** @internal */
144
+ export type GetCurrentKeyRequest$Outbound = {
145
+ "HTTP-Referer"?: string | undefined;
146
+ "X-Title"?: string | undefined;
147
+ };
148
+ /** @internal */
149
+ export declare const GetCurrentKeyRequest$outboundSchema: z.ZodType<GetCurrentKeyRequest$Outbound, GetCurrentKeyRequest>;
150
+ export declare function getCurrentKeyRequestToJSON(getCurrentKeyRequest: GetCurrentKeyRequest): string;
151
+ /** @internal */
108
152
  export declare const RateLimit$inboundSchema: z.ZodType<RateLimit, unknown>;
109
153
  export declare function rateLimitFromJSON(jsonString: string): SafeParseResult<RateLimit, SDKValidationError>;
110
154
  /** @internal */
@@ -6,6 +6,19 @@ import * as z from "zod/v4";
6
6
  import { remap as remap$ } from "../../lib/primitives.js";
7
7
  import { safeParse } from "../../lib/schemas.js";
8
8
  /** @internal */
9
+ export const GetCurrentKeyRequest$outboundSchema = z.object({
10
+ httpReferer: z.string().optional(),
11
+ xTitle: z.string().optional(),
12
+ }).transform((v) => {
13
+ return remap$(v, {
14
+ httpReferer: "HTTP-Referer",
15
+ xTitle: "X-Title",
16
+ });
17
+ });
18
+ export function getCurrentKeyRequestToJSON(getCurrentKeyRequest) {
19
+ return JSON.stringify(GetCurrentKeyRequest$outboundSchema.parse(getCurrentKeyRequest));
20
+ }
21
+ /** @internal */
9
22
  export const RateLimit$inboundSchema = z.object({
10
23
  requests: z.number(),
11
24
  interval: z.string(),
@@ -27,6 +40,7 @@ export const GetCurrentKeyData$inboundSchema = z.object({
27
40
  byok_usage_weekly: z.number(),
28
41
  byok_usage_monthly: z.number(),
29
42
  is_free_tier: z.boolean(),
43
+ is_management_key: z.boolean(),
30
44
  is_provisioning_key: z.boolean(),
31
45
  limit_remaining: z.nullable(z.number()),
32
46
  limit_reset: z.nullable(z.string()),
@@ -43,6 +57,7 @@ export const GetCurrentKeyData$inboundSchema = z.object({
43
57
  "byok_usage_weekly": "byokUsageWeekly",
44
58
  "byok_usage_monthly": "byokUsageMonthly",
45
59
  "is_free_tier": "isFreeTier",
60
+ "is_management_key": "isManagementKey",
46
61
  "is_provisioning_key": "isProvisioningKey",
47
62
  "limit_remaining": "limitRemaining",
48
63
  "limit_reset": "limitReset",