tekimax-ts 0.1.7 → 0.1.8

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 (359) hide show
  1. package/README.md +113 -26
  2. package/dist/adapter-BtbeHotF.d.cts +81 -0
  3. package/dist/adapter-BtbeHotF.d.ts +81 -0
  4. package/dist/adapter-C5iFgx6o.d.cts +162 -0
  5. package/dist/adapter-C5iFgx6o.d.ts +162 -0
  6. package/dist/adapter-CMu9Gvvm.d.cts +81 -0
  7. package/dist/adapter-CMu9Gvvm.d.ts +81 -0
  8. package/dist/adapter-DeUJcFAn.d.cts +43 -0
  9. package/dist/adapter-DeUJcFAn.d.ts +43 -0
  10. package/dist/adapter-K9NFtBg8.d.cts +81 -0
  11. package/dist/adapter-K9NFtBg8.d.ts +81 -0
  12. package/dist/adapter-TuDzMu0Y.d.cts +43 -0
  13. package/dist/adapter-TuDzMu0Y.d.ts +43 -0
  14. package/dist/adapter-YcdKK3By.d.cts +63 -0
  15. package/dist/adapter-YcdKK3By.d.ts +63 -0
  16. package/dist/adapter-xdRwibId.d.cts +144 -0
  17. package/dist/adapter-xdRwibId.d.ts +144 -0
  18. package/dist/adapter-zXqUGXCx.d.cts +81 -0
  19. package/dist/adapter-zXqUGXCx.d.ts +81 -0
  20. package/dist/chunk-MLKGABMK.js +9 -0
  21. package/dist/gen/index.js +1572 -378
  22. package/dist/gen/types.js +290 -201
  23. package/dist/gen/zod/allowedToolChoiceSchema.js +17 -13
  24. package/dist/gen/zod/allowedToolsParamSchema.js +28 -13
  25. package/dist/gen/zod/annotationSchema.js +16 -11
  26. package/dist/gen/zod/assistantMessageItemParamSchema.js +52 -19
  27. package/dist/gen/zod/createResponseBodySchema.js +142 -44
  28. package/dist/gen/zod/createresponseSchema.js +23 -12
  29. package/dist/gen/zod/detailEnumSchema.js +8 -8
  30. package/dist/gen/zod/developerMessageItemParamSchema.js +35 -16
  31. package/dist/gen/zod/emptyModelParamSchema.js +8 -8
  32. package/dist/gen/zod/errorPayloadSchema.js +27 -14
  33. package/dist/gen/zod/errorSchema.js +17 -11
  34. package/dist/gen/zod/errorStreamingEventSchema.js +23 -13
  35. package/dist/gen/zod/functionCallItemParamSchema.js +38 -15
  36. package/dist/gen/zod/functionCallItemStatusSchema.js +12 -8
  37. package/dist/gen/zod/functionCallOutputItemParamSchema.js +90 -27
  38. package/dist/gen/zod/functionCallOutputSchema.js +67 -24
  39. package/dist/gen/zod/functionCallOutputStatusEnumSchema.js +12 -8
  40. package/dist/gen/zod/functionCallSchema.js +29 -16
  41. package/dist/gen/zod/functionCallStatusSchema.js +12 -8
  42. package/dist/gen/zod/functionToolChoiceSchema.js +10 -10
  43. package/dist/gen/zod/functionToolParamSchema.js +25 -14
  44. package/dist/gen/zod/functionToolSchema.js +24 -14
  45. package/dist/gen/zod/imageDetailSchema.js +8 -8
  46. package/dist/gen/zod/includeEnumSchema.js +11 -8
  47. package/dist/gen/zod/incompleteDetailsSchema.js +14 -10
  48. package/dist/gen/zod/index.js +871 -213
  49. package/dist/gen/zod/inputFileContentParamSchema.js +24 -13
  50. package/dist/gen/zod/inputFileContentSchema.js +23 -12
  51. package/dist/gen/zod/inputImageContentParamAutoParamSchema.js +29 -13
  52. package/dist/gen/zod/inputImageContentSchema.js +22 -13
  53. package/dist/gen/zod/inputTextContentParamSchema.js +19 -11
  54. package/dist/gen/zod/inputTextContentSchema.js +16 -11
  55. package/dist/gen/zod/inputTokensDetailsSchema.js +15 -10
  56. package/dist/gen/zod/inputVideoContentSchema.js +17 -11
  57. package/dist/gen/zod/itemFieldSchema.js +45 -20
  58. package/dist/gen/zod/itemParamSchema.js +55 -23
  59. package/dist/gen/zod/itemReferenceParamSchema.js +15 -11
  60. package/dist/gen/zod/jsonObjectResponseFormatSchema.js +9 -9
  61. package/dist/gen/zod/jsonSchemaResponseFormatParamSchema.js +38 -13
  62. package/dist/gen/zod/jsonSchemaResponseFormatSchema.js +13 -13
  63. package/dist/gen/zod/logProbSchema.js +20 -14
  64. package/dist/gen/zod/messageRoleSchema.js +13 -8
  65. package/dist/gen/zod/messageSchema.js +109 -43
  66. package/dist/gen/zod/messageStatusSchema.js +12 -8
  67. package/dist/gen/zod/metadataParamSchema.js +13 -8
  68. package/dist/gen/zod/outputTextContentParamSchema.js +21 -12
  69. package/dist/gen/zod/outputTextContentSchema.js +30 -15
  70. package/dist/gen/zod/outputTokensDetailsSchema.js +17 -10
  71. package/dist/gen/zod/reasoningBodySchema.js +173 -54
  72. package/dist/gen/zod/reasoningEffortEnumSchema.js +14 -8
  73. package/dist/gen/zod/reasoningItemParamSchema.js +26 -14
  74. package/dist/gen/zod/reasoningParamSchema.js +33 -13
  75. package/dist/gen/zod/reasoningSchema.js +27 -13
  76. package/dist/gen/zod/reasoningSummaryContentParamSchema.js +13 -10
  77. package/dist/gen/zod/reasoningSummaryEnumSchema.js +12 -8
  78. package/dist/gen/zod/reasoningTextContentSchema.js +16 -11
  79. package/dist/gen/zod/refusalContentParamSchema.js +13 -10
  80. package/dist/gen/zod/refusalContentSchema.js +18 -11
  81. package/dist/gen/zod/responseCompletedStreamingEventSchema.js +23 -13
  82. package/dist/gen/zod/responseContentPartAddedStreamingEventSchema.js +98 -39
  83. package/dist/gen/zod/responseContentPartDoneStreamingEventSchema.js +98 -39
  84. package/dist/gen/zod/responseCreatedStreamingEventSchema.js +23 -13
  85. package/dist/gen/zod/responseFailedStreamingEventSchema.js +23 -13
  86. package/dist/gen/zod/responseFunctionCallArgumentsDeltaStreamingEventSchema.js +38 -15
  87. package/dist/gen/zod/responseFunctionCallArgumentsDoneStreamingEventSchema.js +33 -14
  88. package/dist/gen/zod/responseInProgressStreamingEventSchema.js +23 -13
  89. package/dist/gen/zod/responseIncompleteStreamingEventSchema.js +23 -13
  90. package/dist/gen/zod/responseOutputItemAddedStreamingEventSchema.js +32 -14
  91. package/dist/gen/zod/responseOutputItemDoneStreamingEventSchema.js +30 -14
  92. package/dist/gen/zod/responseOutputTextAnnotationAddedStreamingEventSchema.js +43 -17
  93. package/dist/gen/zod/responseOutputTextDeltaStreamingEventSchema.js +48 -18
  94. package/dist/gen/zod/responseOutputTextDoneStreamingEventSchema.js +39 -17
  95. package/dist/gen/zod/responseQueuedStreamingEventSchema.js +23 -13
  96. package/dist/gen/zod/responseReasoningDeltaStreamingEventSchema.js +40 -16
  97. package/dist/gen/zod/responseReasoningDoneStreamingEventSchema.js +31 -15
  98. package/dist/gen/zod/responseReasoningSummaryDeltaStreamingEventSchema.js +42 -16
  99. package/dist/gen/zod/responseReasoningSummaryDoneStreamingEventSchema.js +33 -15
  100. package/dist/gen/zod/responseReasoningSummaryPartAddedStreamingEventSchema.js +102 -39
  101. package/dist/gen/zod/responseReasoningSummaryPartDoneStreamingEventSchema.js +102 -39
  102. package/dist/gen/zod/responseRefusalDeltaStreamingEventSchema.js +33 -15
  103. package/dist/gen/zod/responseRefusalDoneStreamingEventSchema.js +31 -15
  104. package/dist/gen/zod/responseResourceSchema.js +146 -51
  105. package/dist/gen/zod/responsesToolParamSchema.js +15 -11
  106. package/dist/gen/zod/serviceTierEnumSchema.js +13 -8
  107. package/dist/gen/zod/specificFunctionParamSchema.js +13 -10
  108. package/dist/gen/zod/specificToolChoiceParamSchema.js +11 -9
  109. package/dist/gen/zod/streamOptionsParamSchema.js +18 -10
  110. package/dist/gen/zod/summaryTextContentSchema.js +18 -11
  111. package/dist/gen/zod/systemMessageItemParamSchema.js +35 -16
  112. package/dist/gen/zod/textContentSchema.js +13 -11
  113. package/dist/gen/zod/textFieldSchema.js +24 -14
  114. package/dist/gen/zod/textFormatParamSchema.js +16 -10
  115. package/dist/gen/zod/textParamSchema.js +23 -12
  116. package/dist/gen/zod/textResponseFormatSchema.js +9 -9
  117. package/dist/gen/zod/toolChoiceParamSchema.js +21 -11
  118. package/dist/gen/zod/toolChoiceValueEnumSchema.js +8 -8
  119. package/dist/gen/zod/toolSchema.js +16 -11
  120. package/dist/gen/zod/topLogProbSchema.js +14 -12
  121. package/dist/gen/zod/truncationEnumSchema.js +8 -8
  122. package/dist/gen/zod/urlCitationBodySchema.js +29 -14
  123. package/dist/gen/zod/urlCitationParamSchema.js +28 -13
  124. package/dist/gen/zod/usageSchema.js +35 -16
  125. package/dist/gen/zod/userMessageItemParamSchema.js +64 -22
  126. package/dist/gen/zod/verbosityEnumSchema.js +8 -8
  127. package/dist/index.cjs +1574 -0
  128. package/dist/index.d.cts +2823 -0
  129. package/dist/index.d.mts +51000 -31111
  130. package/dist/index.d.ts +407 -29296
  131. package/dist/index.js +1136 -1405
  132. package/dist/index.mjs +2441 -1010
  133. package/dist/react/index.cjs +216 -0
  134. package/dist/react/index.d.cts +25 -0
  135. package/dist/react/index.d.ts +25 -0
  136. package/dist/react/index.js +191 -0
  137. package/dist/tekimax-C-DJ0z27.d.cts +283 -0
  138. package/dist/tekimax-C-DJ0z27.d.ts +283 -0
  139. package/package.json +47 -9
  140. package/.dockerignore +0 -5
  141. package/Dockerfile +0 -25
  142. package/kubb.config.js +0 -30
  143. package/kubb.config.ts +0 -35
  144. package/public/logos/tekimax-logo-ScreenRGB-2.png +0 -0
  145. package/spec/openapi.json +0 -3876
  146. package/src/client.ts +0 -129
  147. package/src/gen/.kubb/config.ts +0 -43
  148. package/src/gen/client/createresponse.ts +0 -27
  149. package/src/gen/client/index.ts +0 -1
  150. package/src/gen/index.ts +0 -187
  151. package/src/gen/schemas/allowedToolChoice.json +0 -1
  152. package/src/gen/schemas/allowedToolsParam.json +0 -1
  153. package/src/gen/schemas/annotation.json +0 -1
  154. package/src/gen/schemas/assistantMessageItemParam.json +0 -1
  155. package/src/gen/schemas/createResponseBody.json +0 -1
  156. package/src/gen/schemas/detailEnum.json +0 -1
  157. package/src/gen/schemas/developerMessageItemParam.json +0 -1
  158. package/src/gen/schemas/emptyModelParam.json +0 -1
  159. package/src/gen/schemas/error.json +0 -1
  160. package/src/gen/schemas/errorPayload.json +0 -1
  161. package/src/gen/schemas/errorStreamingEvent.json +0 -1
  162. package/src/gen/schemas/functionCall.json +0 -1
  163. package/src/gen/schemas/functionCallItemParam.json +0 -1
  164. package/src/gen/schemas/functionCallItemStatus.json +0 -1
  165. package/src/gen/schemas/functionCallOutput.json +0 -1
  166. package/src/gen/schemas/functionCallOutputItemParam.json +0 -1
  167. package/src/gen/schemas/functionCallOutputStatusEnum.json +0 -1
  168. package/src/gen/schemas/functionCallStatus.json +0 -1
  169. package/src/gen/schemas/functionTool.json +0 -1
  170. package/src/gen/schemas/functionToolChoice.json +0 -1
  171. package/src/gen/schemas/functionToolParam.json +0 -1
  172. package/src/gen/schemas/imageDetail.json +0 -1
  173. package/src/gen/schemas/includeEnum.json +0 -1
  174. package/src/gen/schemas/incompleteDetails.json +0 -1
  175. package/src/gen/schemas/inputFileContent.json +0 -1
  176. package/src/gen/schemas/inputFileContentParam.json +0 -1
  177. package/src/gen/schemas/inputImageContent.json +0 -1
  178. package/src/gen/schemas/inputImageContentParamAutoParam.json +0 -1
  179. package/src/gen/schemas/inputTextContent.json +0 -1
  180. package/src/gen/schemas/inputTextContentParam.json +0 -1
  181. package/src/gen/schemas/inputTokensDetails.json +0 -1
  182. package/src/gen/schemas/inputVideoContent.json +0 -1
  183. package/src/gen/schemas/itemField.json +0 -1
  184. package/src/gen/schemas/itemParam.json +0 -1
  185. package/src/gen/schemas/itemReferenceParam.json +0 -1
  186. package/src/gen/schemas/jsonObjectResponseFormat.json +0 -1
  187. package/src/gen/schemas/jsonSchemaResponseFormat.json +0 -1
  188. package/src/gen/schemas/jsonSchemaResponseFormatParam.json +0 -1
  189. package/src/gen/schemas/logProb.json +0 -1
  190. package/src/gen/schemas/message.json +0 -1
  191. package/src/gen/schemas/messageRole.json +0 -1
  192. package/src/gen/schemas/messageStatus.json +0 -1
  193. package/src/gen/schemas/metadataParam.json +0 -1
  194. package/src/gen/schemas/outputTextContent.json +0 -1
  195. package/src/gen/schemas/outputTextContentParam.json +0 -1
  196. package/src/gen/schemas/outputTokensDetails.json +0 -1
  197. package/src/gen/schemas/reasoning.json +0 -1
  198. package/src/gen/schemas/reasoningBody.json +0 -1
  199. package/src/gen/schemas/reasoningEffortEnum.json +0 -1
  200. package/src/gen/schemas/reasoningItemParam.json +0 -1
  201. package/src/gen/schemas/reasoningParam.json +0 -1
  202. package/src/gen/schemas/reasoningSummaryContentParam.json +0 -1
  203. package/src/gen/schemas/reasoningSummaryEnum.json +0 -1
  204. package/src/gen/schemas/reasoningTextContent.json +0 -1
  205. package/src/gen/schemas/refusalContent.json +0 -1
  206. package/src/gen/schemas/refusalContentParam.json +0 -1
  207. package/src/gen/schemas/responseCompletedStreamingEvent.json +0 -1
  208. package/src/gen/schemas/responseContentPartAddedStreamingEvent.json +0 -1
  209. package/src/gen/schemas/responseContentPartDoneStreamingEvent.json +0 -1
  210. package/src/gen/schemas/responseCreatedStreamingEvent.json +0 -1
  211. package/src/gen/schemas/responseFailedStreamingEvent.json +0 -1
  212. package/src/gen/schemas/responseFunctionCallArgumentsDeltaStreamingEvent.json +0 -1
  213. package/src/gen/schemas/responseFunctionCallArgumentsDoneStreamingEvent.json +0 -1
  214. package/src/gen/schemas/responseInProgressStreamingEvent.json +0 -1
  215. package/src/gen/schemas/responseIncompleteStreamingEvent.json +0 -1
  216. package/src/gen/schemas/responseOutputItemAddedStreamingEvent.json +0 -1
  217. package/src/gen/schemas/responseOutputItemDoneStreamingEvent.json +0 -1
  218. package/src/gen/schemas/responseOutputTextAnnotationAddedStreamingEvent.json +0 -1
  219. package/src/gen/schemas/responseOutputTextDeltaStreamingEvent.json +0 -1
  220. package/src/gen/schemas/responseOutputTextDoneStreamingEvent.json +0 -1
  221. package/src/gen/schemas/responseQueuedStreamingEvent.json +0 -1
  222. package/src/gen/schemas/responseReasoningDeltaStreamingEvent.json +0 -1
  223. package/src/gen/schemas/responseReasoningDoneStreamingEvent.json +0 -1
  224. package/src/gen/schemas/responseReasoningSummaryDeltaStreamingEvent.json +0 -1
  225. package/src/gen/schemas/responseReasoningSummaryDoneStreamingEvent.json +0 -1
  226. package/src/gen/schemas/responseReasoningSummaryPartAddedStreamingEvent.json +0 -1
  227. package/src/gen/schemas/responseReasoningSummaryPartDoneStreamingEvent.json +0 -1
  228. package/src/gen/schemas/responseRefusalDeltaStreamingEvent.json +0 -1
  229. package/src/gen/schemas/responseRefusalDoneStreamingEvent.json +0 -1
  230. package/src/gen/schemas/responseResource.json +0 -1
  231. package/src/gen/schemas/responsesToolParam.json +0 -1
  232. package/src/gen/schemas/serviceTierEnum.json +0 -1
  233. package/src/gen/schemas/specificFunctionParam.json +0 -1
  234. package/src/gen/schemas/specificToolChoiceParam.json +0 -1
  235. package/src/gen/schemas/streamOptionsParam.json +0 -1
  236. package/src/gen/schemas/summaryTextContent.json +0 -1
  237. package/src/gen/schemas/systemMessageItemParam.json +0 -1
  238. package/src/gen/schemas/textContent.json +0 -1
  239. package/src/gen/schemas/textField.json +0 -1
  240. package/src/gen/schemas/textFormatParam.json +0 -1
  241. package/src/gen/schemas/textParam.json +0 -1
  242. package/src/gen/schemas/textResponseFormat.json +0 -1
  243. package/src/gen/schemas/tool.json +0 -1
  244. package/src/gen/schemas/toolChoiceParam.json +0 -1
  245. package/src/gen/schemas/toolChoiceValueEnum.json +0 -1
  246. package/src/gen/schemas/topLogProb.json +0 -1
  247. package/src/gen/schemas/truncationEnum.json +0 -1
  248. package/src/gen/schemas/urlCitationBody.json +0 -1
  249. package/src/gen/schemas/urlCitationParam.json +0 -1
  250. package/src/gen/schemas/usage.json +0 -1
  251. package/src/gen/schemas/userMessageItemParam.json +0 -1
  252. package/src/gen/schemas/verbosityEnum.json +0 -1
  253. package/src/gen/types.ts +0 -2613
  254. package/src/gen/zod/allowedToolChoiceSchema.ts +0 -14
  255. package/src/gen/zod/allowedToolsParamSchema.ts +0 -14
  256. package/src/gen/zod/annotationSchema.ts +0 -14
  257. package/src/gen/zod/assistantMessageItemParamSchema.ts +0 -20
  258. package/src/gen/zod/createResponseBodySchema.ts +0 -45
  259. package/src/gen/zod/createresponseSchema.ts +0 -17
  260. package/src/gen/zod/detailEnumSchema.ts +0 -8
  261. package/src/gen/zod/developerMessageItemParamSchema.ts +0 -17
  262. package/src/gen/zod/emptyModelParamSchema.ts +0 -10
  263. package/src/gen/zod/errorPayloadSchema.ts +0 -19
  264. package/src/gen/zod/errorSchema.ts +0 -14
  265. package/src/gen/zod/errorStreamingEventSchema.ts +0 -16
  266. package/src/gen/zod/functionCallItemParamSchema.ts +0 -16
  267. package/src/gen/zod/functionCallItemStatusSchema.ts +0 -8
  268. package/src/gen/zod/functionCallOutputItemParamSchema.ts +0 -30
  269. package/src/gen/zod/functionCallOutputSchema.ts +0 -27
  270. package/src/gen/zod/functionCallOutputStatusEnumSchema.ts +0 -11
  271. package/src/gen/zod/functionCallSchema.ts +0 -19
  272. package/src/gen/zod/functionCallStatusSchema.ts +0 -8
  273. package/src/gen/zod/functionToolChoiceSchema.ts +0 -11
  274. package/src/gen/zod/functionToolParamSchema.ts +0 -15
  275. package/src/gen/zod/functionToolSchema.ts +0 -19
  276. package/src/gen/zod/imageDetailSchema.ts +0 -8
  277. package/src/gen/zod/includeEnumSchema.ts +0 -8
  278. package/src/gen/zod/incompleteDetailsSchema.ts +0 -13
  279. package/src/gen/zod/index.ts +0 -103
  280. package/src/gen/zod/inputFileContentParamSchema.ts +0 -16
  281. package/src/gen/zod/inputFileContentSchema.ts +0 -15
  282. package/src/gen/zod/inputImageContentParamAutoParamSchema.ts +0 -16
  283. package/src/gen/zod/inputImageContentSchema.ts +0 -16
  284. package/src/gen/zod/inputTextContentParamSchema.ts +0 -14
  285. package/src/gen/zod/inputTextContentSchema.ts +0 -14
  286. package/src/gen/zod/inputTokensDetailsSchema.ts +0 -13
  287. package/src/gen/zod/inputVideoContentSchema.ts +0 -14
  288. package/src/gen/zod/itemFieldSchema.ts +0 -23
  289. package/src/gen/zod/itemParamSchema.ts +0 -23
  290. package/src/gen/zod/itemReferenceParamSchema.ts +0 -14
  291. package/src/gen/zod/jsonObjectResponseFormatSchema.ts +0 -10
  292. package/src/gen/zod/jsonSchemaResponseFormatParamSchema.ts +0 -16
  293. package/src/gen/zod/jsonSchemaResponseFormatSchema.ts +0 -14
  294. package/src/gen/zod/logProbSchema.ts +0 -17
  295. package/src/gen/zod/messageRoleSchema.ts +0 -8
  296. package/src/gen/zod/messageSchema.ts +0 -46
  297. package/src/gen/zod/messageStatusSchema.ts +0 -8
  298. package/src/gen/zod/metadataParamSchema.ts +0 -13
  299. package/src/gen/zod/outputTextContentParamSchema.ts +0 -13
  300. package/src/gen/zod/outputTextContentSchema.ts +0 -18
  301. package/src/gen/zod/outputTokensDetailsSchema.ts +0 -13
  302. package/src/gen/zod/reasoningBodySchema.ts +0 -57
  303. package/src/gen/zod/reasoningEffortEnumSchema.ts +0 -8
  304. package/src/gen/zod/reasoningItemParamSchema.ts +0 -15
  305. package/src/gen/zod/reasoningParamSchema.ts +0 -16
  306. package/src/gen/zod/reasoningSchema.ts +0 -16
  307. package/src/gen/zod/reasoningSummaryContentParamSchema.ts +0 -11
  308. package/src/gen/zod/reasoningSummaryEnumSchema.ts +0 -8
  309. package/src/gen/zod/reasoningTextContentSchema.ts +0 -14
  310. package/src/gen/zod/refusalContentParamSchema.ts +0 -11
  311. package/src/gen/zod/refusalContentSchema.ts +0 -14
  312. package/src/gen/zod/responseCompletedStreamingEventSchema.ts +0 -16
  313. package/src/gen/zod/responseContentPartAddedStreamingEventSchema.ts +0 -42
  314. package/src/gen/zod/responseContentPartDoneStreamingEventSchema.ts +0 -42
  315. package/src/gen/zod/responseCreatedStreamingEventSchema.ts +0 -16
  316. package/src/gen/zod/responseFailedStreamingEventSchema.ts +0 -16
  317. package/src/gen/zod/responseFunctionCallArgumentsDeltaStreamingEventSchema.ts +0 -18
  318. package/src/gen/zod/responseFunctionCallArgumentsDoneStreamingEventSchema.ts +0 -17
  319. package/src/gen/zod/responseInProgressStreamingEventSchema.ts +0 -16
  320. package/src/gen/zod/responseIncompleteStreamingEventSchema.ts +0 -16
  321. package/src/gen/zod/responseOutputItemAddedStreamingEventSchema.ts +0 -17
  322. package/src/gen/zod/responseOutputItemDoneStreamingEventSchema.ts +0 -17
  323. package/src/gen/zod/responseOutputTextAnnotationAddedStreamingEventSchema.ts +0 -20
  324. package/src/gen/zod/responseOutputTextDeltaStreamingEventSchema.ts +0 -21
  325. package/src/gen/zod/responseOutputTextDoneStreamingEventSchema.ts +0 -20
  326. package/src/gen/zod/responseQueuedStreamingEventSchema.ts +0 -16
  327. package/src/gen/zod/responseReasoningDeltaStreamingEventSchema.ts +0 -19
  328. package/src/gen/zod/responseReasoningDoneStreamingEventSchema.ts +0 -18
  329. package/src/gen/zod/responseReasoningSummaryDeltaStreamingEventSchema.ts +0 -19
  330. package/src/gen/zod/responseReasoningSummaryDoneStreamingEventSchema.ts +0 -18
  331. package/src/gen/zod/responseReasoningSummaryPartAddedStreamingEventSchema.ts +0 -42
  332. package/src/gen/zod/responseReasoningSummaryPartDoneStreamingEventSchema.ts +0 -42
  333. package/src/gen/zod/responseRefusalDeltaStreamingEventSchema.ts +0 -18
  334. package/src/gen/zod/responseRefusalDoneStreamingEventSchema.ts +0 -18
  335. package/src/gen/zod/responseResourceSchema.ts +0 -54
  336. package/src/gen/zod/responsesToolParamSchema.ts +0 -11
  337. package/src/gen/zod/serviceTierEnumSchema.ts +0 -8
  338. package/src/gen/zod/specificFunctionParamSchema.ts +0 -11
  339. package/src/gen/zod/specificToolChoiceParamSchema.ts +0 -9
  340. package/src/gen/zod/streamOptionsParamSchema.ts +0 -13
  341. package/src/gen/zod/summaryTextContentSchema.ts +0 -14
  342. package/src/gen/zod/systemMessageItemParamSchema.ts +0 -17
  343. package/src/gen/zod/textContentSchema.ts +0 -14
  344. package/src/gen/zod/textFieldSchema.ts +0 -15
  345. package/src/gen/zod/textFormatParamSchema.ts +0 -10
  346. package/src/gen/zod/textParamSchema.ts +0 -13
  347. package/src/gen/zod/textResponseFormatSchema.ts +0 -10
  348. package/src/gen/zod/toolChoiceParamSchema.ts +0 -14
  349. package/src/gen/zod/toolChoiceValueEnumSchema.ts +0 -8
  350. package/src/gen/zod/toolSchema.ts +0 -14
  351. package/src/gen/zod/topLogProbSchema.ts +0 -15
  352. package/src/gen/zod/truncationEnumSchema.ts +0 -8
  353. package/src/gen/zod/urlCitationBodySchema.ts +0 -17
  354. package/src/gen/zod/urlCitationParamSchema.ts +0 -14
  355. package/src/gen/zod/usageSchema.ts +0 -19
  356. package/src/gen/zod/userMessageItemParamSchema.ts +0 -23
  357. package/src/gen/zod/verbosityEnumSchema.ts +0 -8
  358. package/src/index.ts +0 -3
  359. package/tsconfig.json +0 -21
@@ -1 +0,0 @@
1
- {"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"FunctionCallStatus"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["function"],"description":"The type of the function tool. Always `function`.","default":"function"},"name":{"type":"string","description":"The name of the function to call."},"description":{"anyOf":[{"type":"string","description":"A description of the function. Used by the model to determine whether or not to call the function."},{"type":"null"}]},"parameters":{"anyOf":[{"additionalProperties":{},"type":"object","description":"A JSON schema object describing the parameters of the function."},{"type":"null"}]},"strict":{"anyOf":[{"type":"boolean","description":"Whether to enforce strict parameter validation. Default `true`."},{"type":"null"}]}},"type":"object","required":["type","name","description","parameters","strict"],"title":"Function","description":"Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).","x-readme-ref-name":"FunctionTool"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["function"],"default":"function"},"name":{"type":"string"}},"type":"object","required":["type"],"x-readme-ref-name":"FunctionToolChoice"}
@@ -1 +0,0 @@
1
- {"properties":{"name":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_-]+$"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"parameters":{"anyOf":[{"properties":{},"type":"object","required":[],"x-readme-ref-name":"EmptyModelParam"},{"type":"null"}]},"strict":{"type":"boolean"},"type":{"type":"string","enum":["function"],"default":"function"}},"type":"object","required":["name","type"],"x-readme-ref-name":"FunctionToolParam"}
@@ -1 +0,0 @@
1
- {"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"}
@@ -1 +0,0 @@
1
- {"type":"string","enum":["reasoning.encrypted_content","message.output_text.logprobs"],"description":"","x-enumDescriptions":{"message.output_text.logprobs":"includes sampled logprobs in assistant messages.","reasoning.encrypted_content":"includes encrypted reasoning content so that it may be rehydrated on a subsequent request."},"x-readme-ref-name":"IncludeEnum"}
@@ -1 +0,0 @@
1
- {"properties":{"reason":{"type":"string","description":"The reason the response could not be completed."}},"type":"object","required":["reason"],"title":"Incomplete details","description":"Details about why the response was incomplete.","x-readme-ref-name":"IncompleteDetails"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"anyOf":[{"type":"string","description":"The name of the file to be sent to the model."},{"type":"null"}]},"file_data":{"anyOf":[{"type":"string","maxLength":33554432,"description":"The base64-encoded data of the file to be sent to the model."},{"type":"null"}]},"file_url":{"anyOf":[{"type":"string","description":"The URL of the file to be sent to the model."},{"type":"null"}]}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContentParam"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","maxLength":20971520,"description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"anyOf":[{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]},{"type":"null"}]}},"type":"object","required":["type"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision)","x-readme-ref-name":"InputImageContentParamAutoParam"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","maxLength":10485760,"description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-unionDisplay":"section","x-unionTitle":"Content Type","x-readme-ref-name":"InputTextContentParam"}
@@ -1 +0,0 @@
1
- {"properties":{"cached_tokens":{"type":"integer","description":"The number of input tokens that were served from cache."}},"type":"object","required":["cached_tokens"],"title":"Input tokens details","description":"A breakdown of input token usage that was recorded.","x-readme-ref-name":"InputTokensDetails"}
@@ -1 +0,0 @@
1
- {"type":"object","description":"A content block representing a video input to the model.","properties":{"type":{"type":"string","enum":["input_video"],"description":"The type of the input content. Always `input_video`."},"video_url":{"type":"string","description":"A base64 or remote url that resolves to a video file."}},"required":["type","video_url"],"x-readme-ref-name":"InputVideoContent"}
@@ -1 +0,0 @@
1
- {"oneOf":[{"properties":{"type":{"type":"string","enum":["message"],"description":"The type of the message. Always set to `message`.","default":"message"},"id":{"type":"string","description":"The unique ID of the message."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"MessageStatus"},{"description":"The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]},"role":{"allOf":[{"type":"string","enum":["user","assistant","system","developer"],"x-enumDescriptions":{"assistant":"Model-generated content in the conversation.","developer":"Developer-supplied guidance that shapes the assistant’s behavior.","system":"System-level instructions that set global behavior.","user":"End‑user input in the conversation."},"x-readme-ref-name":"MessageRole"},{"description":"The role of the message. One of `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`, or `tool`."}]},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"},{"type":"object","description":"A content block representing a video input to the model.","properties":{"type":{"type":"string","enum":["input_video"],"description":"The type of the input content. Always `input_video`."},"video_url":{"type":"string","description":"A base64 or remote url that resolves to a video file."}},"required":["type","video_url"],"x-readme-ref-name":"InputVideoContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The content of the message"}},"type":"object","required":["type","id","status","role","content"],"title":"Message","description":"A message to or from the model.","x-readme-ref-name":"Message"},{"properties":{"type":{"type":"string","enum":["function_call"],"description":"The type of the item. Always `function_call`.","default":"function_call"},"id":{"type":"string","description":"The unique ID of the function call item."},"call_id":{"type":"string","description":"The unique ID of the function tool call that was generated."},"name":{"type":"string","description":"The name of the function that was called."},"arguments":{"type":"string","description":"The arguments JSON string that was generated."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"FunctionCallStatus"},{"description":"The status of the function call item that was recorded."}]}},"type":"object","required":["type","id","call_id","name","arguments","status"],"title":"Function call","description":"A function tool call that was generated by the model.","x-readme-ref-name":"FunctionCall"},{"properties":{"type":{"type":"string","enum":["function_call_output"],"description":"The type of the function tool call output. Always `function_call_output`.","default":"function_call_output"},"id":{"type":"string","description":"The unique ID of the function tool call output. Populated when this item is returned via API."},"call_id":{"type":"string","description":"The unique ID of the function tool call generated by the model."},"output":{"oneOf":[{"type":"string","description":"A JSON string of the output of the function tool call."},{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"An array of output contents (images, files, text) for the function tool call."}]},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"description":"Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used.","x-readme-ref-name":"FunctionCallOutputStatusEnum"},{"description":"The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]}},"type":"object","required":["type","id","call_id","output","status"],"title":"Function call output","description":"A function tool call output that was returned by the tool.","x-readme-ref-name":"FunctionCallOutput"},{"properties":{"type":{"type":"string","enum":["reasoning"],"description":"The type of the item. Always `reasoning`.","default":"reasoning"},"id":{"type":"string","description":"The unique ID of the reasoning item."},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning content that was generated."},"summary":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning summary content that was generated."},"encrypted_content":{"type":"string","description":"The encrypted reasoning content that was generated."}},"type":"object","required":["type","id","summary"],"title":"Reasoning item","description":"A reasoning item that was generated by the model.","x-readme-ref-name":"ReasoningBody"}],"description":"An item representing a message, tool call, tool output, reasoning, or other response element.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"ItemField"}
@@ -1 +0,0 @@
1
- {"oneOf":[{"properties":{"type":{"anyOf":[{"type":"string","enum":["item_reference"],"description":"The type of item to reference. Always `item_reference`.","default":"item_reference"},{"type":"null"}]},"id":{"type":"string","description":"The ID of the item to reference."}},"type":"object","required":["id"],"title":"Item reference","description":"An internal identifier for an item to reference.","x-readme-ref-name":"ItemReferenceParam"},{"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of this reasoning item.","example":"rs_123"},{"type":"null"}]},"type":{"type":"string","enum":["reasoning"],"description":"The item type. Always `reasoning`.","default":"reasoning"},"summary":{"items":{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The content type. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","maxLength":10485760,"description":"The reasoning summary text."}},"type":"object","required":["type","text"],"x-readme-ref-name":"ReasoningSummaryContentParam"},"type":"array","description":"Reasoning summary content associated with this item."},"content":{"anyOf":[{"type":"null"}]},"encrypted_content":{"anyOf":[{"type":"string","description":"An encrypted representation of the reasoning content."},{"type":"null"}]}},"type":"object","required":["type","summary"],"x-readme-ref-name":"ReasoningItemParam"},{"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of this message item.","example":"msg_123"},{"type":"null"}]},"type":{"type":"string","enum":["message"],"description":"The item type. Always `message`.","default":"message"},"role":{"type":"string","enum":["user"],"description":"The message role. Always `user`.","default":"user"},"content":{"oneOf":[{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","maxLength":10485760,"description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-unionDisplay":"section","x-unionTitle":"Content Type","x-readme-ref-name":"InputTextContentParam"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","maxLength":20971520,"description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"anyOf":[{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]},{"type":"null"}]}},"type":"object","required":["type"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision)","x-readme-ref-name":"InputImageContentParamAutoParam"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"anyOf":[{"type":"string","description":"The name of the file to be sent to the model."},{"type":"null"}]},"file_data":{"anyOf":[{"type":"string","maxLength":33554432,"description":"The base64-encoded data of the file to be sent to the model."},{"type":"null"}]},"file_url":{"anyOf":[{"type":"string","description":"The URL of the file to be sent to the model."},{"type":"null"}]}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContentParam"}],"description":"A piece of message content, such as text, an image, or a file.","discriminator":{"propertyName":"type"}},"type":"array"},{"type":"string","maxLength":10485760,"description":"The message content, as a single string."}],"description":"The message content, as an array of content parts."},"status":{"anyOf":[{"type":"string","description":"The status of the message item."},{"type":"null"}]}},"type":"object","required":["type","role","content"],"x-readme-ref-name":"UserMessageItemParam"},{"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of this message item.","example":"msg_123"},{"type":"null"}]},"type":{"type":"string","enum":["message"],"description":"The item type. Always `message`.","default":"message"},"role":{"type":"string","enum":["system"],"description":"The message role. Always `system`.","default":"system"},"content":{"oneOf":[{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","maxLength":10485760,"description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-unionDisplay":"section","x-unionTitle":"Content Type","x-readme-ref-name":"InputTextContentParam"}],"discriminator":{"propertyName":"type"}},"type":"array"},{"type":"string","maxLength":10485760,"description":"The message content, as a single string."}],"description":"The message content, as an array of content parts."},"status":{"anyOf":[{"type":"string","description":"The status of the message item."},{"type":"null"}]}},"type":"object","required":["type","role","content"],"x-readme-ref-name":"SystemMessageItemParam"},{"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of this message item.","example":"msg_123"},{"type":"null"}]},"type":{"type":"string","enum":["message"],"description":"The item type. Always `message`.","default":"message"},"role":{"type":"string","enum":["developer"],"description":"The message role. Always `developer`.","default":"developer"},"content":{"oneOf":[{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","maxLength":10485760,"description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-unionDisplay":"section","x-unionTitle":"Content Type","x-readme-ref-name":"InputTextContentParam"}],"discriminator":{"propertyName":"type"}},"type":"array"},{"type":"string","maxLength":10485760,"description":"The message content, as a single string."}],"description":"The message content, as an array of content parts."},"status":{"anyOf":[{"type":"string","description":"The status of the message item."},{"type":"null"}]}},"type":"object","required":["type","role","content"],"x-readme-ref-name":"DeveloperMessageItemParam"},{"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of this message item.","example":"msg_123"},{"type":"null"}]},"type":{"type":"string","enum":["message"],"description":"The item type. Always `message`.","default":"message"},"role":{"type":"string","enum":["assistant"],"description":"The role of the message author. Always `assistant`.","default":"assistant"},"content":{"oneOf":[{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The content type. Always `output_text`.","default":"output_text"},"text":{"type":"string","maxLength":10485760,"description":"The text content."},"annotations":{"oneOf":[{"items":{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The citation type. Always `url_citation`.","default":"url_citation"},"start_index":{"type":"integer","minimum":0,"description":"The index of the first character of the citation in the message."},"end_index":{"type":"integer","minimum":0,"description":"The index of the last character of the citation in the message."},"url":{"type":"string","description":"The URL of the cited resource."},"title":{"type":"string","description":"The title of the cited resource."}},"type":"object","required":["type","start_index","end_index","url","title"],"x-readme-ref-name":"UrlCitationParam"},"type":"array"}],"description":"Citations associated with the text content."}},"type":"object","required":["type","text"],"x-readme-ref-name":"OutputTextContentParam"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The content type. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","maxLength":10485760,"description":"The refusal text."}},"type":"object","required":["type","refusal"],"x-readme-ref-name":"RefusalContentParam"}],"description":"A piece of assistant message content, such as text or a refusal.","discriminator":{"propertyName":"type"}},"type":"array"},{"type":"string","maxLength":10485760,"description":"The message content, as a single string."}],"description":"The message content, as an array of content parts."},"status":{"anyOf":[{"type":"string","description":"The status of the message item."},{"type":"null"}]}},"type":"object","required":["type","role","content"],"x-readme-ref-name":"AssistantMessageItemParam"},{"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of this function tool call.","example":"fc_123"},{"type":"null"}]},"call_id":{"type":"string","maxLength":64,"minLength":1,"description":"The unique ID of the function tool call generated by the model."},"type":{"type":"string","enum":["function_call"],"description":"The item type. Always `function_call`.","default":"function_call"},"name":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_-]+$","description":"The name of the function to call."},"arguments":{"type":"string","description":"The function arguments as a JSON string."},"status":{"anyOf":[{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"FunctionCallStatus"},{"description":"The status of the function tool call."}]},{"type":"null"}]}},"type":"object","required":["call_id","type","name","arguments"],"x-readme-ref-name":"FunctionCallItemParam"},{"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of the function tool call output. Populated when this item is returned via API.","example":"fc_123"},{"type":"null"}]},"call_id":{"type":"string","maxLength":64,"minLength":1,"description":"The unique ID of the function tool call generated by the model."},"type":{"type":"string","enum":["function_call_output"],"description":"The type of the function tool call output. Always `function_call_output`.","default":"function_call_output"},"output":{"oneOf":[{"type":"string","maxLength":10485760,"description":"A JSON string of the output of the function tool call."},{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","maxLength":10485760,"description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-unionDisplay":"section","x-unionTitle":"Content Type","x-readme-ref-name":"InputTextContentParam"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","maxLength":20971520,"description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"anyOf":[{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]},{"type":"null"}]}},"type":"object","required":["type"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision)","x-readme-ref-name":"InputImageContentParamAutoParam"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"anyOf":[{"type":"string","description":"The name of the file to be sent to the model."},{"type":"null"}]},"file_data":{"anyOf":[{"type":"string","maxLength":33554432,"description":"The base64-encoded data of the file to be sent to the model."},{"type":"null"}]},"file_url":{"anyOf":[{"type":"string","description":"The URL of the file to be sent to the model."},{"type":"null"}]}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContentParam"},{"type":"object","description":"A content block representing a video input to the model.","properties":{"type":{"type":"string","enum":["input_video"],"description":"The type of the input content. Always `input_video`."},"video_url":{"type":"string","description":"A base64 or remote url that resolves to a video file."}},"required":["type","video_url"],"x-readme-ref-name":"InputVideoContent"}],"description":"A piece of message content, such as text, an image, or a file.","discriminator":{"propertyName":"type"}},"type":"array","description":"An array of content outputs (text, image, file) for the function tool call."}],"description":"Text, image, or file output of the function tool call."},"status":{"anyOf":[{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"FunctionCallStatus"},{"description":"The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]},{"type":"null"}]}},"type":"object","required":["call_id","type","output"],"title":"Function tool call output","description":"The output of a function tool call.","x-readme-ref-name":"FunctionCallOutputItemParam"}],"discriminator":{"propertyName":"type"},"x-unionDisplay":"section","x-unionTitle":"Input Item Types","x-readme-ref-name":"ItemParam"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"anyOf":[{"type":"string","enum":["item_reference"],"description":"The type of item to reference. Always `item_reference`.","default":"item_reference"},{"type":"null"}]},"id":{"type":"string","description":"The ID of the item to reference."}},"type":"object","required":["id"],"title":"Item reference","description":"An internal identifier for an item to reference.","x-readme-ref-name":"ItemReferenceParam"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["json_object"],"default":"json_object"}},"type":"object","required":["type"],"x-readme-ref-name":"JsonObjectResponseFormat"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["json_schema"],"default":"json_schema"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"schema":{"anyOf":[{"type":"null"}]},"strict":{"type":"boolean"}},"type":"object","required":["type","name","description","schema","strict"],"x-readme-ref-name":"JsonSchemaResponseFormat"}
@@ -1 +0,0 @@
1
- {"type":"object","properties":{"type":{"type":"string","description":"The type of response format being defined. Always `json_schema`.","enum":["json_schema"]},"description":{"type":"string","description":"A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n"},"name":{"type":"string","description":"The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n"},"schema":{"type":"object","title":"JSON schema","description":"The schema for the response format, described as a JSON Schema object.\n","additionalProperties":true},"strict":{"anyOf":[{"type":"boolean","default":false,"description":"Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`.\n"},{"type":"null"}]}},"x-readme-ref-name":"JsonSchemaResponseFormatParam"}
@@ -1 +0,0 @@
1
- {"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["message"],"description":"The type of the message. Always set to `message`.","default":"message"},"id":{"type":"string","description":"The unique ID of the message."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"MessageStatus"},{"description":"The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]},"role":{"allOf":[{"type":"string","enum":["user","assistant","system","developer"],"x-enumDescriptions":{"assistant":"Model-generated content in the conversation.","developer":"Developer-supplied guidance that shapes the assistant’s behavior.","system":"System-level instructions that set global behavior.","user":"End‑user input in the conversation."},"x-readme-ref-name":"MessageRole"},{"description":"The role of the message. One of `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`, or `tool`."}]},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"},{"type":"object","description":"A content block representing a video input to the model.","properties":{"type":{"type":"string","enum":["input_video"],"description":"The type of the input content. Always `input_video`."},"video_url":{"type":"string","description":"A base64 or remote url that resolves to a video file."}},"required":["type","video_url"],"x-readme-ref-name":"InputVideoContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The content of the message"}},"type":"object","required":["type","id","status","role","content"],"title":"Message","description":"A message to or from the model.","x-readme-ref-name":"Message"}
@@ -1 +0,0 @@
1
- {"type":"string","enum":["user","assistant","system","developer"],"x-enumDescriptions":{"assistant":"Model-generated content in the conversation.","developer":"Developer-supplied guidance that shapes the assistant’s behavior.","system":"System-level instructions that set global behavior.","user":"End‑user input in the conversation."},"x-readme-ref-name":"MessageRole"}
@@ -1 +0,0 @@
1
- {"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"MessageStatus"}
@@ -1 +0,0 @@
1
- {"additionalProperties":{"type":"string","maxLength":512},"type":"object","maxProperties":16,"description":"Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.","x-readme-ref-name":"MetadataParam"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["output_text"],"description":"The content type. Always `output_text`.","default":"output_text"},"text":{"type":"string","maxLength":10485760,"description":"The text content."},"annotations":{"oneOf":[{"items":{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The citation type. Always `url_citation`.","default":"url_citation"},"start_index":{"type":"integer","minimum":0,"description":"The index of the first character of the citation in the message."},"end_index":{"type":"integer","minimum":0,"description":"The index of the last character of the citation in the message."},"url":{"type":"string","description":"The URL of the cited resource."},"title":{"type":"string","description":"The title of the cited resource."}},"type":"object","required":["type","start_index","end_index","url","title"],"x-readme-ref-name":"UrlCitationParam"},"type":"array"}],"description":"Citations associated with the text content."}},"type":"object","required":["type","text"],"x-readme-ref-name":"OutputTextContentParam"}
@@ -1 +0,0 @@
1
- {"properties":{"reasoning_tokens":{"type":"integer","description":"The number of output tokens that were attributed to reasoning."}},"type":"object","required":["reasoning_tokens"],"title":"Output tokens details","description":"A breakdown of output token usage that was recorded.","x-readme-ref-name":"OutputTokensDetails"}
@@ -1 +0,0 @@
1
- {"properties":{"effort":{"anyOf":[{"oneOf":[{"type":"string","enum":["none","low","medium","high","xhigh"],"x-enumDescriptions":{"high":"Use a higher reasoning effort to improve answer quality.","medium":"Use a balanced reasoning effort.","low":"Use a lower reasoning effort for faster responses.","minimal":"Use the lowest non-zero reasoning effort.","none":"Restrict the model from performing any reasoning before emitting a final answer.","xhigh":"Use the maximum reasoning effort available."},"x-readme-ref-name":"ReasoningEffortEnum"}],"description":"The reasoning effort that was requested for the model, if specified."},{"type":"null"}]},"summary":{"anyOf":[{"allOf":[{"type":"string","enum":["concise","detailed","auto"],"x-enumDescriptions":{"auto":"Allow the model to decide when to summarize.","concise":"Emit concise summaries of reasoning content.","detailed":"Emit details summaries of reasoning content."},"x-readme-ref-name":"ReasoningSummaryEnum"},{"description":"A model-generated summary of its reasoning that was produced, if available."}]},{"type":"null"}]}},"type":"object","required":["effort","summary"],"title":"Reasoning","description":"Reasoning configuration and metadata that were used for the response.","x-readme-ref-name":"Reasoning"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["reasoning"],"description":"The type of the item. Always `reasoning`.","default":"reasoning"},"id":{"type":"string","description":"The unique ID of the reasoning item."},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning content that was generated."},"summary":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning summary content that was generated."},"encrypted_content":{"type":"string","description":"The encrypted reasoning content that was generated."}},"type":"object","required":["type","id","summary"],"title":"Reasoning item","description":"A reasoning item that was generated by the model.","x-readme-ref-name":"ReasoningBody"}
@@ -1 +0,0 @@
1
- {"type":"string","enum":["none","low","medium","high","xhigh"],"x-enumDescriptions":{"high":"Use a higher reasoning effort to improve answer quality.","medium":"Use a balanced reasoning effort.","low":"Use a lower reasoning effort for faster responses.","minimal":"Use the lowest non-zero reasoning effort.","none":"Restrict the model from performing any reasoning before emitting a final answer.","xhigh":"Use the maximum reasoning effort available."},"x-readme-ref-name":"ReasoningEffortEnum"}
@@ -1 +0,0 @@
1
- {"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of this reasoning item.","example":"rs_123"},{"type":"null"}]},"type":{"type":"string","enum":["reasoning"],"description":"The item type. Always `reasoning`.","default":"reasoning"},"summary":{"items":{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The content type. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","maxLength":10485760,"description":"The reasoning summary text."}},"type":"object","required":["type","text"],"x-readme-ref-name":"ReasoningSummaryContentParam"},"type":"array","description":"Reasoning summary content associated with this item."},"content":{"anyOf":[{"type":"null"}]},"encrypted_content":{"anyOf":[{"type":"string","description":"An encrypted representation of the reasoning content."},{"type":"null"}]}},"type":"object","required":["type","summary"],"x-readme-ref-name":"ReasoningItemParam"}
@@ -1 +0,0 @@
1
- {"properties":{"effort":{"anyOf":[{"oneOf":[{"type":"string","enum":["none","low","medium","high","xhigh"],"x-enumDescriptions":{"high":"Use a higher reasoning effort to improve answer quality.","medium":"Use a balanced reasoning effort.","low":"Use a lower reasoning effort for faster responses.","minimal":"Use the lowest non-zero reasoning effort.","none":"Restrict the model from performing any reasoning before emitting a final answer.","xhigh":"Use the maximum reasoning effort available."},"x-readme-ref-name":"ReasoningEffortEnum"}],"description":"Controls the level of reasoning effort the model should apply. Higher effort may increase latency and cost."},{"type":"null"}]},"summary":{"anyOf":[{"allOf":[{"type":"string","enum":["concise","detailed","auto"],"x-enumDescriptions":{"auto":"Allow the model to decide when to summarize.","concise":"Emit concise summaries of reasoning content.","detailed":"Emit details summaries of reasoning content."},"x-readme-ref-name":"ReasoningSummaryEnum"},{"description":"Controls whether the response includes a reasoning summary."}]},{"type":"null"}]}},"type":"object","required":[],"description":"**gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning).","x-readme-ref-name":"ReasoningParam"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The content type. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","maxLength":10485760,"description":"The reasoning summary text."}},"type":"object","required":["type","text"],"x-readme-ref-name":"ReasoningSummaryContentParam"}
@@ -1 +0,0 @@
1
- {"type":"string","enum":["concise","detailed","auto"],"x-enumDescriptions":{"auto":"Allow the model to decide when to summarize.","concise":"Emit concise summaries of reasoning content.","detailed":"Emit details summaries of reasoning content."},"x-readme-ref-name":"ReasoningSummaryEnum"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["refusal"],"description":"The content type. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","maxLength":10485760,"description":"The refusal text."}},"type":"object","required":["type","refusal"],"x-readme-ref-name":"RefusalContentParam"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["response.completed"],"description":"The type of the event, always `response.completed`.","default":"response.completed"},"sequence_number":{"type":"integer","description":"The sequence number of the event that was emitted."},"response":{"allOf":[{"properties":{"id":{"type":"string","description":"The unique ID of the response that was created."},"object":{"type":"string","enum":["response"],"description":"The object type, which was always `response`.","default":"response"},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the response was created."},"completed_at":{"anyOf":[{"type":"integer","description":"The Unix timestamp (in seconds) for when the response was completed, if it was completed."},{"type":"null"}]},"status":{"type":"string","description":"The status that was set for the response."},"incomplete_details":{"anyOf":[{"allOf":[{"properties":{"reason":{"type":"string","description":"The reason the response could not be completed."}},"type":"object","required":["reason"],"title":"Incomplete details","description":"Details about why the response was incomplete.","x-readme-ref-name":"IncompleteDetails"},{"description":"Details about why the response was incomplete, if applicable."}]},{"type":"null"}]},"model":{"type":"string","description":"The model that generated this response."},"previous_response_id":{"anyOf":[{"type":"string","description":"The ID of the previous response in the chain that was referenced, if any."},{"type":"null"}]},"instructions":{"anyOf":[{"oneOf":[{"type":"string"}],"description":"Additional instructions that were used to guide the model for this response."},{"type":"null"}]},"output":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["message"],"description":"The type of the message. Always set to `message`.","default":"message"},"id":{"type":"string","description":"The unique ID of the message."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"MessageStatus"},{"description":"The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]},"role":{"allOf":[{"type":"string","enum":["user","assistant","system","developer"],"x-enumDescriptions":{"assistant":"Model-generated content in the conversation.","developer":"Developer-supplied guidance that shapes the assistant’s behavior.","system":"System-level instructions that set global behavior.","user":"End‑user input in the conversation."},"x-readme-ref-name":"MessageRole"},{"description":"The role of the message. One of `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`, or `tool`."}]},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"},{"type":"object","description":"A content block representing a video input to the model.","properties":{"type":{"type":"string","enum":["input_video"],"description":"The type of the input content. Always `input_video`."},"video_url":{"type":"string","description":"A base64 or remote url that resolves to a video file."}},"required":["type","video_url"],"x-readme-ref-name":"InputVideoContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The content of the message"}},"type":"object","required":["type","id","status","role","content"],"title":"Message","description":"A message to or from the model.","x-readme-ref-name":"Message"},{"properties":{"type":{"type":"string","enum":["function_call"],"description":"The type of the item. Always `function_call`.","default":"function_call"},"id":{"type":"string","description":"The unique ID of the function call item."},"call_id":{"type":"string","description":"The unique ID of the function tool call that was generated."},"name":{"type":"string","description":"The name of the function that was called."},"arguments":{"type":"string","description":"The arguments JSON string that was generated."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"FunctionCallStatus"},{"description":"The status of the function call item that was recorded."}]}},"type":"object","required":["type","id","call_id","name","arguments","status"],"title":"Function call","description":"A function tool call that was generated by the model.","x-readme-ref-name":"FunctionCall"},{"properties":{"type":{"type":"string","enum":["function_call_output"],"description":"The type of the function tool call output. Always `function_call_output`.","default":"function_call_output"},"id":{"type":"string","description":"The unique ID of the function tool call output. Populated when this item is returned via API."},"call_id":{"type":"string","description":"The unique ID of the function tool call generated by the model."},"output":{"oneOf":[{"type":"string","description":"A JSON string of the output of the function tool call."},{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"An array of output contents (images, files, text) for the function tool call."}]},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"description":"Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used.","x-readme-ref-name":"FunctionCallOutputStatusEnum"},{"description":"The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]}},"type":"object","required":["type","id","call_id","output","status"],"title":"Function call output","description":"A function tool call output that was returned by the tool.","x-readme-ref-name":"FunctionCallOutput"},{"properties":{"type":{"type":"string","enum":["reasoning"],"description":"The type of the item. Always `reasoning`.","default":"reasoning"},"id":{"type":"string","description":"The unique ID of the reasoning item."},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning content that was generated."},"summary":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning summary content that was generated."},"encrypted_content":{"type":"string","description":"The encrypted reasoning content that was generated."}},"type":"object","required":["type","id","summary"],"title":"Reasoning item","description":"A reasoning item that was generated by the model.","x-readme-ref-name":"ReasoningBody"}],"description":"An item representing a message, tool call, tool output, reasoning, or other response element.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"ItemField"},"type":"array","description":"The output items that were generated by the model."},"error":{"anyOf":[{"allOf":[{"properties":{"code":{"type":"string","description":"A machine-readable error code that was returned."},"message":{"type":"string","description":"A human-readable description of the error that was returned."}},"type":"object","required":["code","message"],"title":"Error","description":"An error that occurred while generating the response.","x-readme-ref-name":"Error"},{"description":"The error that occurred, if the response failed."}]},{"type":"null"}]},"tools":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["function"],"description":"The type of the function tool. Always `function`.","default":"function"},"name":{"type":"string","description":"The name of the function to call."},"description":{"anyOf":[{"type":"string","description":"A description of the function. Used by the model to determine whether or not to call the function."},{"type":"null"}]},"parameters":{"anyOf":[{"additionalProperties":{},"type":"object","description":"A JSON schema object describing the parameters of the function."},{"type":"null"}]},"strict":{"anyOf":[{"type":"boolean","description":"Whether to enforce strict parameter validation. Default `true`."},{"type":"null"}]}},"type":"object","required":["type","name","description","parameters","strict"],"title":"Function","description":"Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).","x-readme-ref-name":"FunctionTool"}],"description":"A tool that can be used to generate a response.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Tool"},"type":"array","description":"The tools that were available to the model during response generation."},"tool_choice":{"oneOf":[{"properties":{"type":{"type":"string","enum":["function"],"default":"function"},"name":{"type":"string"}},"type":"object","required":["type"],"x-readme-ref-name":"FunctionToolChoice"},{"type":"string","enum":["none","auto","required"],"x-enumDescriptions":{"auto":"Let the model choose the tools from among the provided set.","none":"Restrict the model from calling any tools.","required":"Require the model to call a tool."},"x-readme-ref-name":"ToolChoiceValueEnum"},{"properties":{"type":{"type":"string","enum":["allowed_tools"],"default":"allowed_tools"},"tools":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["function"],"default":"function"},"name":{"type":"string"}},"type":"object","required":["type"],"x-readme-ref-name":"FunctionToolChoice"}]},"type":"array"},"mode":{"type":"string","enum":["none","auto","required"],"x-enumDescriptions":{"auto":"Let the model choose the tools from among the provided set.","none":"Restrict the model from calling any tools.","required":"Require the model to call a tool."},"x-readme-ref-name":"ToolChoiceValueEnum"}},"type":"object","required":["type","tools","mode"],"x-readme-ref-name":"AllowedToolChoice"}]},"truncation":{"allOf":[{"type":"string","enum":["auto","disabled"],"x-enumDescriptions":{"auto":"Let the service decide how to truncate.","disabled":"Disable service truncation. Context over the model's context limit will result in a 400 error."},"x-readme-ref-name":"TruncationEnum"},{"description":"How the input was truncated by the service when it exceeded the model context window."}]},"parallel_tool_calls":{"type":"boolean","description":"Whether the model was allowed to call multiple tools in parallel."},"text":{"allOf":[{"properties":{"format":{"oneOf":[{"properties":{"type":{"type":"string","enum":["text"],"default":"text"}},"type":"object","required":["type"],"x-readme-ref-name":"TextResponseFormat"},{"properties":{"type":{"type":"string","enum":["json_object"],"default":"json_object"}},"type":"object","required":["type"],"x-readme-ref-name":"JsonObjectResponseFormat"},{"properties":{"type":{"type":"string","enum":["json_schema"],"default":"json_schema"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"schema":{"anyOf":[{"type":"null"}]},"strict":{"type":"boolean"}},"type":"object","required":["type","name","description","schema","strict"],"x-readme-ref-name":"JsonSchemaResponseFormat"}]},"verbosity":{"type":"string","enum":["low","medium","high"],"x-enumDescriptions":{"high":"Instruct the model to emit more verbose final responses.","low":"Instruct the model to emit less verbose final responses.","medium":"Use the model's default verbosity setting."},"x-readme-ref-name":"VerbosityEnum"}},"type":"object","required":["format"],"x-readme-ref-name":"TextField"},{"description":"Configuration options for text output that were used."}]},"top_p":{"type":"number","description":"The nucleus sampling parameter that was used for this response."},"presence_penalty":{"type":"number","description":"The presence penalty that was used to penalize new tokens based on whether they appear in the text so far."},"frequency_penalty":{"type":"number","description":"The frequency penalty that was used to penalize new tokens based on their frequency in the text so far."},"top_logprobs":{"type":"integer","description":"The number of most likely tokens that were returned at each position, along with their log probabilities."},"temperature":{"type":"number","description":"The sampling temperature that was used for this response."},"reasoning":{"anyOf":[{"allOf":[{"properties":{"effort":{"anyOf":[{"oneOf":[{"type":"string","enum":["none","low","medium","high","xhigh"],"x-enumDescriptions":{"high":"Use a higher reasoning effort to improve answer quality.","medium":"Use a balanced reasoning effort.","low":"Use a lower reasoning effort for faster responses.","minimal":"Use the lowest non-zero reasoning effort.","none":"Restrict the model from performing any reasoning before emitting a final answer.","xhigh":"Use the maximum reasoning effort available."},"x-readme-ref-name":"ReasoningEffortEnum"}],"description":"The reasoning effort that was requested for the model, if specified."},{"type":"null"}]},"summary":{"anyOf":[{"allOf":[{"type":"string","enum":["concise","detailed","auto"],"x-enumDescriptions":{"auto":"Allow the model to decide when to summarize.","concise":"Emit concise summaries of reasoning content.","detailed":"Emit details summaries of reasoning content."},"x-readme-ref-name":"ReasoningSummaryEnum"},{"description":"A model-generated summary of its reasoning that was produced, if available."}]},{"type":"null"}]}},"type":"object","required":["effort","summary"],"title":"Reasoning","description":"Reasoning configuration and metadata that were used for the response.","x-readme-ref-name":"Reasoning"},{"description":"Reasoning configuration and outputs that were produced for this response."}]},{"type":"null"}]},"usage":{"anyOf":[{"allOf":[{"properties":{"input_tokens":{"type":"integer","description":"The number of input tokens that were used to generate the response."},"output_tokens":{"type":"integer","description":"The number of output tokens that were generated by the model."},"total_tokens":{"type":"integer","description":"The total number of tokens that were used."},"input_tokens_details":{"allOf":[{"properties":{"cached_tokens":{"type":"integer","description":"The number of input tokens that were served from cache."}},"type":"object","required":["cached_tokens"],"title":"Input tokens details","description":"A breakdown of input token usage that was recorded.","x-readme-ref-name":"InputTokensDetails"},{"description":"A breakdown of input token usage that was recorded."}]},"output_tokens_details":{"allOf":[{"properties":{"reasoning_tokens":{"type":"integer","description":"The number of output tokens that were attributed to reasoning."}},"type":"object","required":["reasoning_tokens"],"title":"Output tokens details","description":"A breakdown of output token usage that was recorded.","x-readme-ref-name":"OutputTokensDetails"},{"description":"A breakdown of output token usage that was recorded."}]}},"type":"object","required":["input_tokens","output_tokens","total_tokens","input_tokens_details","output_tokens_details"],"title":"Usage","description":"Token usage statistics that were recorded for the response.","x-readme-ref-name":"Usage"},{"description":"Token usage statistics that were recorded for the response, if available."}]},{"type":"null"}]},"max_output_tokens":{"anyOf":[{"type":"integer","description":"The maximum number of tokens the model was allowed to generate for this response."},{"type":"null"}]},"max_tool_calls":{"anyOf":[{"type":"integer","description":"The maximum number of tool calls the model was allowed to make while generating the response."},{"type":"null"}]},"store":{"type":"boolean","description":"Whether this response was stored so it can be retrieved later."},"background":{"type":"boolean","description":"Whether this request was run in the background."},"service_tier":{"type":"string","description":"The service tier that was used for this response."},"metadata":{"description":"Developer-defined metadata that was associated with the response."},"safety_identifier":{"anyOf":[{"type":"string","description":"A stable identifier that was used for safety monitoring and abuse detection."},{"type":"null"}]},"prompt_cache_key":{"anyOf":[{"type":"string","description":"A key that was used to read from or write to the prompt cache."},{"type":"null"}]}},"type":"object","required":["id","object","created_at","completed_at","status","incomplete_details","model","previous_response_id","instructions","output","error","tools","tool_choice","truncation","parallel_tool_calls","text","top_p","presence_penalty","frequency_penalty","top_logprobs","temperature","reasoning","usage","max_output_tokens","max_tool_calls","store","background","service_tier","metadata","safety_identifier","prompt_cache_key"],"title":"The response object","description":"The complete response object that was returned by the Responses API.","example":{"id":"resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41","object":"response","created_at":1741476777,"status":"completed","completed_at":1741476778,"model":"gpt-4o-2024-08-06","output":[{"type":"message","id":"msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41","status":"completed","role":"assistant","content":[{"type":"output_text","text":"The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.","annotations":[]}]}],"parallel_tool_calls":true,"reasoning":{},"store":true,"background":false,"temperature":1,"presence_penalty":0,"frequency_penalty":0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1,"truncation":"disabled","usage":{"input_tokens":328,"input_tokens_details":{"cached_tokens":0},"output_tokens":52,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":380},"metadata":{}},"x-readme-ref-name":"ResponseResource"},{"description":"The response snapshot that was emitted with the event."}]}},"type":"object","required":["type","sequence_number","response"],"title":"Response completed event","description":"A streaming event that indicated the response was completed.","x-readme-ref-name":"ResponseCompletedStreamingEvent"}
@@ -1 +0,0 @@
1
- {"properties":{"type":{"type":"string","enum":["response.content_part.added"],"description":"The type of the event, always `response.content_part.added`.","default":"response.content_part.added"},"sequence_number":{"type":"integer","description":"The sequence number of the event that was emitted."},"item_id":{"type":"string","description":"The ID of the item that was updated."},"output_index":{"type":"integer","description":"The index of the output item that was updated."},"content_index":{"type":"integer","description":"The index of the content part that was added."},"part":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}}},"type":"object","required":["type","sequence_number","item_id","output_index","content_index","part"],"title":"Response content part added event","description":"A streaming event that indicated a content part was added.","x-readme-ref-name":"ResponseContentPartAddedStreamingEvent"}