tekimax-ts 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (327) hide show
  1. package/.dockerignore +5 -0
  2. package/Dockerfile +25 -0
  3. package/README.md +146 -0
  4. package/dist/gen/index.js +378 -0
  5. package/dist/gen/types.js +284 -0
  6. package/dist/gen/zod/allowedToolChoiceSchema.js +15 -0
  7. package/dist/gen/zod/allowedToolsParamSchema.js +15 -0
  8. package/dist/gen/zod/annotationSchema.js +15 -0
  9. package/dist/gen/zod/assistantMessageItemParamSchema.js +21 -0
  10. package/dist/gen/zod/createResponseBodySchema.js +46 -0
  11. package/dist/gen/zod/createresponseSchema.js +16 -0
  12. package/dist/gen/zod/detailEnumSchema.js +9 -0
  13. package/dist/gen/zod/developerMessageItemParamSchema.js +18 -0
  14. package/dist/gen/zod/emptyModelParamSchema.js +9 -0
  15. package/dist/gen/zod/errorPayloadSchema.js +18 -0
  16. package/dist/gen/zod/errorSchema.js +15 -0
  17. package/dist/gen/zod/errorStreamingEventSchema.js +17 -0
  18. package/dist/gen/zod/functionCallItemParamSchema.js +17 -0
  19. package/dist/gen/zod/functionCallItemStatusSchema.js +9 -0
  20. package/dist/gen/zod/functionCallOutputItemParamSchema.js +31 -0
  21. package/dist/gen/zod/functionCallOutputSchema.js +28 -0
  22. package/dist/gen/zod/functionCallOutputStatusEnumSchema.js +12 -0
  23. package/dist/gen/zod/functionCallSchema.js +20 -0
  24. package/dist/gen/zod/functionCallStatusSchema.js +9 -0
  25. package/dist/gen/zod/functionToolChoiceSchema.js +12 -0
  26. package/dist/gen/zod/functionToolParamSchema.js +16 -0
  27. package/dist/gen/zod/functionToolSchema.js +18 -0
  28. package/dist/gen/zod/imageDetailSchema.js +9 -0
  29. package/dist/gen/zod/includeEnumSchema.js +9 -0
  30. package/dist/gen/zod/incompleteDetailsSchema.js +14 -0
  31. package/dist/gen/zod/index.js +213 -0
  32. package/dist/gen/zod/inputFileContentParamSchema.js +17 -0
  33. package/dist/gen/zod/inputFileContentSchema.js +16 -0
  34. package/dist/gen/zod/inputImageContentParamAutoParamSchema.js +17 -0
  35. package/dist/gen/zod/inputImageContentSchema.js +17 -0
  36. package/dist/gen/zod/inputTextContentParamSchema.js +15 -0
  37. package/dist/gen/zod/inputTextContentSchema.js +15 -0
  38. package/dist/gen/zod/inputTokensDetailsSchema.js +14 -0
  39. package/dist/gen/zod/inputVideoContentSchema.js +15 -0
  40. package/dist/gen/zod/itemFieldSchema.js +24 -0
  41. package/dist/gen/zod/itemParamSchema.js +24 -0
  42. package/dist/gen/zod/itemReferenceParamSchema.js +15 -0
  43. package/dist/gen/zod/jsonObjectResponseFormatSchema.js +11 -0
  44. package/dist/gen/zod/jsonSchemaResponseFormatParamSchema.js +15 -0
  45. package/dist/gen/zod/jsonSchemaResponseFormatSchema.js +15 -0
  46. package/dist/gen/zod/logProbSchema.js +18 -0
  47. package/dist/gen/zod/messageRoleSchema.js +9 -0
  48. package/dist/gen/zod/messageSchema.js +47 -0
  49. package/dist/gen/zod/messageStatusSchema.js +9 -0
  50. package/dist/gen/zod/metadataParamSchema.js +12 -0
  51. package/dist/gen/zod/outputTextContentParamSchema.js +14 -0
  52. package/dist/gen/zod/outputTextContentSchema.js +19 -0
  53. package/dist/gen/zod/outputTokensDetailsSchema.js +14 -0
  54. package/dist/gen/zod/reasoningBodySchema.js +58 -0
  55. package/dist/gen/zod/reasoningEffortEnumSchema.js +9 -0
  56. package/dist/gen/zod/reasoningItemParamSchema.js +16 -0
  57. package/dist/gen/zod/reasoningParamSchema.js +17 -0
  58. package/dist/gen/zod/reasoningSchema.js +17 -0
  59. package/dist/gen/zod/reasoningSummaryContentParamSchema.js +12 -0
  60. package/dist/gen/zod/reasoningSummaryEnumSchema.js +9 -0
  61. package/dist/gen/zod/reasoningTextContentSchema.js +15 -0
  62. package/dist/gen/zod/refusalContentParamSchema.js +12 -0
  63. package/dist/gen/zod/refusalContentSchema.js +15 -0
  64. package/dist/gen/zod/responseCompletedStreamingEventSchema.js +17 -0
  65. package/dist/gen/zod/responseContentPartAddedStreamingEventSchema.js +43 -0
  66. package/dist/gen/zod/responseContentPartDoneStreamingEventSchema.js +43 -0
  67. package/dist/gen/zod/responseCreatedStreamingEventSchema.js +17 -0
  68. package/dist/gen/zod/responseFailedStreamingEventSchema.js +17 -0
  69. package/dist/gen/zod/responseFunctionCallArgumentsDeltaStreamingEventSchema.js +19 -0
  70. package/dist/gen/zod/responseFunctionCallArgumentsDoneStreamingEventSchema.js +18 -0
  71. package/dist/gen/zod/responseInProgressStreamingEventSchema.js +17 -0
  72. package/dist/gen/zod/responseIncompleteStreamingEventSchema.js +17 -0
  73. package/dist/gen/zod/responseOutputItemAddedStreamingEventSchema.js +18 -0
  74. package/dist/gen/zod/responseOutputItemDoneStreamingEventSchema.js +18 -0
  75. package/dist/gen/zod/responseOutputTextAnnotationAddedStreamingEventSchema.js +21 -0
  76. package/dist/gen/zod/responseOutputTextDeltaStreamingEventSchema.js +22 -0
  77. package/dist/gen/zod/responseOutputTextDoneStreamingEventSchema.js +21 -0
  78. package/dist/gen/zod/responseQueuedStreamingEventSchema.js +17 -0
  79. package/dist/gen/zod/responseReasoningDeltaStreamingEventSchema.js +20 -0
  80. package/dist/gen/zod/responseReasoningDoneStreamingEventSchema.js +19 -0
  81. package/dist/gen/zod/responseReasoningSummaryDeltaStreamingEventSchema.js +20 -0
  82. package/dist/gen/zod/responseReasoningSummaryDoneStreamingEventSchema.js +19 -0
  83. package/dist/gen/zod/responseReasoningSummaryPartAddedStreamingEventSchema.js +43 -0
  84. package/dist/gen/zod/responseReasoningSummaryPartDoneStreamingEventSchema.js +43 -0
  85. package/dist/gen/zod/responseRefusalDeltaStreamingEventSchema.js +19 -0
  86. package/dist/gen/zod/responseRefusalDoneStreamingEventSchema.js +19 -0
  87. package/dist/gen/zod/responseResourceSchema.js +55 -0
  88. package/dist/gen/zod/responsesToolParamSchema.js +12 -0
  89. package/dist/gen/zod/serviceTierEnumSchema.js +9 -0
  90. package/dist/gen/zod/specificFunctionParamSchema.js +12 -0
  91. package/dist/gen/zod/specificToolChoiceParamSchema.js +10 -0
  92. package/dist/gen/zod/streamOptionsParamSchema.js +14 -0
  93. package/dist/gen/zod/summaryTextContentSchema.js +15 -0
  94. package/dist/gen/zod/systemMessageItemParamSchema.js +18 -0
  95. package/dist/gen/zod/textContentSchema.js +15 -0
  96. package/dist/gen/zod/textFieldSchema.js +16 -0
  97. package/dist/gen/zod/textFormatParamSchema.js +11 -0
  98. package/dist/gen/zod/textParamSchema.js +14 -0
  99. package/dist/gen/zod/textResponseFormatSchema.js +11 -0
  100. package/dist/gen/zod/toolChoiceParamSchema.js +15 -0
  101. package/dist/gen/zod/toolChoiceValueEnumSchema.js +9 -0
  102. package/dist/gen/zod/toolSchema.js +15 -0
  103. package/dist/gen/zod/topLogProbSchema.js +16 -0
  104. package/dist/gen/zod/truncationEnumSchema.js +9 -0
  105. package/dist/gen/zod/urlCitationBodySchema.js +18 -0
  106. package/dist/gen/zod/urlCitationParamSchema.js +15 -0
  107. package/dist/gen/zod/usageSchema.js +20 -0
  108. package/dist/gen/zod/userMessageItemParamSchema.js +24 -0
  109. package/dist/gen/zod/verbosityEnumSchema.js +9 -0
  110. package/dist/index.d.mts +31636 -0
  111. package/dist/index.d.ts +31636 -0
  112. package/dist/index.js +1688 -0
  113. package/dist/index.mjs +1475 -0
  114. package/kubb.config.js +30 -0
  115. package/kubb.config.ts +29 -0
  116. package/package.json +48 -0
  117. package/public/logos/tekimax-logo-ScreenRGB-2.png +0 -0
  118. package/spec/openapi.json +3876 -0
  119. package/src/gen/index.ts +186 -0
  120. package/src/gen/schemas/allowedToolChoice.json +1 -0
  121. package/src/gen/schemas/allowedToolsParam.json +1 -0
  122. package/src/gen/schemas/annotation.json +1 -0
  123. package/src/gen/schemas/assistantMessageItemParam.json +1 -0
  124. package/src/gen/schemas/createResponseBody.json +1 -0
  125. package/src/gen/schemas/detailEnum.json +1 -0
  126. package/src/gen/schemas/developerMessageItemParam.json +1 -0
  127. package/src/gen/schemas/emptyModelParam.json +1 -0
  128. package/src/gen/schemas/error.json +1 -0
  129. package/src/gen/schemas/errorPayload.json +1 -0
  130. package/src/gen/schemas/errorStreamingEvent.json +1 -0
  131. package/src/gen/schemas/functionCall.json +1 -0
  132. package/src/gen/schemas/functionCallItemParam.json +1 -0
  133. package/src/gen/schemas/functionCallItemStatus.json +1 -0
  134. package/src/gen/schemas/functionCallOutput.json +1 -0
  135. package/src/gen/schemas/functionCallOutputItemParam.json +1 -0
  136. package/src/gen/schemas/functionCallOutputStatusEnum.json +1 -0
  137. package/src/gen/schemas/functionCallStatus.json +1 -0
  138. package/src/gen/schemas/functionTool.json +1 -0
  139. package/src/gen/schemas/functionToolChoice.json +1 -0
  140. package/src/gen/schemas/functionToolParam.json +1 -0
  141. package/src/gen/schemas/imageDetail.json +1 -0
  142. package/src/gen/schemas/includeEnum.json +1 -0
  143. package/src/gen/schemas/incompleteDetails.json +1 -0
  144. package/src/gen/schemas/inputFileContent.json +1 -0
  145. package/src/gen/schemas/inputFileContentParam.json +1 -0
  146. package/src/gen/schemas/inputImageContent.json +1 -0
  147. package/src/gen/schemas/inputImageContentParamAutoParam.json +1 -0
  148. package/src/gen/schemas/inputTextContent.json +1 -0
  149. package/src/gen/schemas/inputTextContentParam.json +1 -0
  150. package/src/gen/schemas/inputTokensDetails.json +1 -0
  151. package/src/gen/schemas/inputVideoContent.json +1 -0
  152. package/src/gen/schemas/itemField.json +1 -0
  153. package/src/gen/schemas/itemParam.json +1 -0
  154. package/src/gen/schemas/itemReferenceParam.json +1 -0
  155. package/src/gen/schemas/jsonObjectResponseFormat.json +1 -0
  156. package/src/gen/schemas/jsonSchemaResponseFormat.json +1 -0
  157. package/src/gen/schemas/jsonSchemaResponseFormatParam.json +1 -0
  158. package/src/gen/schemas/logProb.json +1 -0
  159. package/src/gen/schemas/message.json +1 -0
  160. package/src/gen/schemas/messageRole.json +1 -0
  161. package/src/gen/schemas/messageStatus.json +1 -0
  162. package/src/gen/schemas/metadataParam.json +1 -0
  163. package/src/gen/schemas/outputTextContent.json +1 -0
  164. package/src/gen/schemas/outputTextContentParam.json +1 -0
  165. package/src/gen/schemas/outputTokensDetails.json +1 -0
  166. package/src/gen/schemas/reasoning.json +1 -0
  167. package/src/gen/schemas/reasoningBody.json +1 -0
  168. package/src/gen/schemas/reasoningEffortEnum.json +1 -0
  169. package/src/gen/schemas/reasoningItemParam.json +1 -0
  170. package/src/gen/schemas/reasoningParam.json +1 -0
  171. package/src/gen/schemas/reasoningSummaryContentParam.json +1 -0
  172. package/src/gen/schemas/reasoningSummaryEnum.json +1 -0
  173. package/src/gen/schemas/reasoningTextContent.json +1 -0
  174. package/src/gen/schemas/refusalContent.json +1 -0
  175. package/src/gen/schemas/refusalContentParam.json +1 -0
  176. package/src/gen/schemas/responseCompletedStreamingEvent.json +1 -0
  177. package/src/gen/schemas/responseContentPartAddedStreamingEvent.json +1 -0
  178. package/src/gen/schemas/responseContentPartDoneStreamingEvent.json +1 -0
  179. package/src/gen/schemas/responseCreatedStreamingEvent.json +1 -0
  180. package/src/gen/schemas/responseFailedStreamingEvent.json +1 -0
  181. package/src/gen/schemas/responseFunctionCallArgumentsDeltaStreamingEvent.json +1 -0
  182. package/src/gen/schemas/responseFunctionCallArgumentsDoneStreamingEvent.json +1 -0
  183. package/src/gen/schemas/responseInProgressStreamingEvent.json +1 -0
  184. package/src/gen/schemas/responseIncompleteStreamingEvent.json +1 -0
  185. package/src/gen/schemas/responseOutputItemAddedStreamingEvent.json +1 -0
  186. package/src/gen/schemas/responseOutputItemDoneStreamingEvent.json +1 -0
  187. package/src/gen/schemas/responseOutputTextAnnotationAddedStreamingEvent.json +1 -0
  188. package/src/gen/schemas/responseOutputTextDeltaStreamingEvent.json +1 -0
  189. package/src/gen/schemas/responseOutputTextDoneStreamingEvent.json +1 -0
  190. package/src/gen/schemas/responseQueuedStreamingEvent.json +1 -0
  191. package/src/gen/schemas/responseReasoningDeltaStreamingEvent.json +1 -0
  192. package/src/gen/schemas/responseReasoningDoneStreamingEvent.json +1 -0
  193. package/src/gen/schemas/responseReasoningSummaryDeltaStreamingEvent.json +1 -0
  194. package/src/gen/schemas/responseReasoningSummaryDoneStreamingEvent.json +1 -0
  195. package/src/gen/schemas/responseReasoningSummaryPartAddedStreamingEvent.json +1 -0
  196. package/src/gen/schemas/responseReasoningSummaryPartDoneStreamingEvent.json +1 -0
  197. package/src/gen/schemas/responseRefusalDeltaStreamingEvent.json +1 -0
  198. package/src/gen/schemas/responseRefusalDoneStreamingEvent.json +1 -0
  199. package/src/gen/schemas/responseResource.json +1 -0
  200. package/src/gen/schemas/responsesToolParam.json +1 -0
  201. package/src/gen/schemas/serviceTierEnum.json +1 -0
  202. package/src/gen/schemas/specificFunctionParam.json +1 -0
  203. package/src/gen/schemas/specificToolChoiceParam.json +1 -0
  204. package/src/gen/schemas/streamOptionsParam.json +1 -0
  205. package/src/gen/schemas/summaryTextContent.json +1 -0
  206. package/src/gen/schemas/systemMessageItemParam.json +1 -0
  207. package/src/gen/schemas/textContent.json +1 -0
  208. package/src/gen/schemas/textField.json +1 -0
  209. package/src/gen/schemas/textFormatParam.json +1 -0
  210. package/src/gen/schemas/textParam.json +1 -0
  211. package/src/gen/schemas/textResponseFormat.json +1 -0
  212. package/src/gen/schemas/tool.json +1 -0
  213. package/src/gen/schemas/toolChoiceParam.json +1 -0
  214. package/src/gen/schemas/toolChoiceValueEnum.json +1 -0
  215. package/src/gen/schemas/topLogProb.json +1 -0
  216. package/src/gen/schemas/truncationEnum.json +1 -0
  217. package/src/gen/schemas/urlCitationBody.json +1 -0
  218. package/src/gen/schemas/urlCitationParam.json +1 -0
  219. package/src/gen/schemas/usage.json +1 -0
  220. package/src/gen/schemas/userMessageItemParam.json +1 -0
  221. package/src/gen/schemas/verbosityEnum.json +1 -0
  222. package/src/gen/types.ts +2613 -0
  223. package/src/gen/zod/allowedToolChoiceSchema.ts +14 -0
  224. package/src/gen/zod/allowedToolsParamSchema.ts +14 -0
  225. package/src/gen/zod/annotationSchema.ts +14 -0
  226. package/src/gen/zod/assistantMessageItemParamSchema.ts +20 -0
  227. package/src/gen/zod/createResponseBodySchema.ts +45 -0
  228. package/src/gen/zod/createresponseSchema.ts +17 -0
  229. package/src/gen/zod/detailEnumSchema.ts +8 -0
  230. package/src/gen/zod/developerMessageItemParamSchema.ts +17 -0
  231. package/src/gen/zod/emptyModelParamSchema.ts +10 -0
  232. package/src/gen/zod/errorPayloadSchema.ts +19 -0
  233. package/src/gen/zod/errorSchema.ts +14 -0
  234. package/src/gen/zod/errorStreamingEventSchema.ts +16 -0
  235. package/src/gen/zod/functionCallItemParamSchema.ts +16 -0
  236. package/src/gen/zod/functionCallItemStatusSchema.ts +8 -0
  237. package/src/gen/zod/functionCallOutputItemParamSchema.ts +30 -0
  238. package/src/gen/zod/functionCallOutputSchema.ts +27 -0
  239. package/src/gen/zod/functionCallOutputStatusEnumSchema.ts +11 -0
  240. package/src/gen/zod/functionCallSchema.ts +19 -0
  241. package/src/gen/zod/functionCallStatusSchema.ts +8 -0
  242. package/src/gen/zod/functionToolChoiceSchema.ts +11 -0
  243. package/src/gen/zod/functionToolParamSchema.ts +15 -0
  244. package/src/gen/zod/functionToolSchema.ts +19 -0
  245. package/src/gen/zod/imageDetailSchema.ts +8 -0
  246. package/src/gen/zod/includeEnumSchema.ts +8 -0
  247. package/src/gen/zod/incompleteDetailsSchema.ts +13 -0
  248. package/src/gen/zod/index.ts +103 -0
  249. package/src/gen/zod/inputFileContentParamSchema.ts +16 -0
  250. package/src/gen/zod/inputFileContentSchema.ts +15 -0
  251. package/src/gen/zod/inputImageContentParamAutoParamSchema.ts +16 -0
  252. package/src/gen/zod/inputImageContentSchema.ts +16 -0
  253. package/src/gen/zod/inputTextContentParamSchema.ts +14 -0
  254. package/src/gen/zod/inputTextContentSchema.ts +14 -0
  255. package/src/gen/zod/inputTokensDetailsSchema.ts +13 -0
  256. package/src/gen/zod/inputVideoContentSchema.ts +14 -0
  257. package/src/gen/zod/itemFieldSchema.ts +23 -0
  258. package/src/gen/zod/itemParamSchema.ts +23 -0
  259. package/src/gen/zod/itemReferenceParamSchema.ts +14 -0
  260. package/src/gen/zod/jsonObjectResponseFormatSchema.ts +10 -0
  261. package/src/gen/zod/jsonSchemaResponseFormatParamSchema.ts +16 -0
  262. package/src/gen/zod/jsonSchemaResponseFormatSchema.ts +14 -0
  263. package/src/gen/zod/logProbSchema.ts +17 -0
  264. package/src/gen/zod/messageRoleSchema.ts +8 -0
  265. package/src/gen/zod/messageSchema.ts +46 -0
  266. package/src/gen/zod/messageStatusSchema.ts +8 -0
  267. package/src/gen/zod/metadataParamSchema.ts +13 -0
  268. package/src/gen/zod/outputTextContentParamSchema.ts +13 -0
  269. package/src/gen/zod/outputTextContentSchema.ts +18 -0
  270. package/src/gen/zod/outputTokensDetailsSchema.ts +13 -0
  271. package/src/gen/zod/reasoningBodySchema.ts +57 -0
  272. package/src/gen/zod/reasoningEffortEnumSchema.ts +8 -0
  273. package/src/gen/zod/reasoningItemParamSchema.ts +15 -0
  274. package/src/gen/zod/reasoningParamSchema.ts +16 -0
  275. package/src/gen/zod/reasoningSchema.ts +16 -0
  276. package/src/gen/zod/reasoningSummaryContentParamSchema.ts +11 -0
  277. package/src/gen/zod/reasoningSummaryEnumSchema.ts +8 -0
  278. package/src/gen/zod/reasoningTextContentSchema.ts +14 -0
  279. package/src/gen/zod/refusalContentParamSchema.ts +11 -0
  280. package/src/gen/zod/refusalContentSchema.ts +14 -0
  281. package/src/gen/zod/responseCompletedStreamingEventSchema.ts +16 -0
  282. package/src/gen/zod/responseContentPartAddedStreamingEventSchema.ts +42 -0
  283. package/src/gen/zod/responseContentPartDoneStreamingEventSchema.ts +42 -0
  284. package/src/gen/zod/responseCreatedStreamingEventSchema.ts +16 -0
  285. package/src/gen/zod/responseFailedStreamingEventSchema.ts +16 -0
  286. package/src/gen/zod/responseFunctionCallArgumentsDeltaStreamingEventSchema.ts +18 -0
  287. package/src/gen/zod/responseFunctionCallArgumentsDoneStreamingEventSchema.ts +17 -0
  288. package/src/gen/zod/responseInProgressStreamingEventSchema.ts +16 -0
  289. package/src/gen/zod/responseIncompleteStreamingEventSchema.ts +16 -0
  290. package/src/gen/zod/responseOutputItemAddedStreamingEventSchema.ts +17 -0
  291. package/src/gen/zod/responseOutputItemDoneStreamingEventSchema.ts +17 -0
  292. package/src/gen/zod/responseOutputTextAnnotationAddedStreamingEventSchema.ts +20 -0
  293. package/src/gen/zod/responseOutputTextDeltaStreamingEventSchema.ts +21 -0
  294. package/src/gen/zod/responseOutputTextDoneStreamingEventSchema.ts +20 -0
  295. package/src/gen/zod/responseQueuedStreamingEventSchema.ts +16 -0
  296. package/src/gen/zod/responseReasoningDeltaStreamingEventSchema.ts +19 -0
  297. package/src/gen/zod/responseReasoningDoneStreamingEventSchema.ts +18 -0
  298. package/src/gen/zod/responseReasoningSummaryDeltaStreamingEventSchema.ts +19 -0
  299. package/src/gen/zod/responseReasoningSummaryDoneStreamingEventSchema.ts +18 -0
  300. package/src/gen/zod/responseReasoningSummaryPartAddedStreamingEventSchema.ts +42 -0
  301. package/src/gen/zod/responseReasoningSummaryPartDoneStreamingEventSchema.ts +42 -0
  302. package/src/gen/zod/responseRefusalDeltaStreamingEventSchema.ts +18 -0
  303. package/src/gen/zod/responseRefusalDoneStreamingEventSchema.ts +18 -0
  304. package/src/gen/zod/responseResourceSchema.ts +54 -0
  305. package/src/gen/zod/responsesToolParamSchema.ts +11 -0
  306. package/src/gen/zod/serviceTierEnumSchema.ts +8 -0
  307. package/src/gen/zod/specificFunctionParamSchema.ts +11 -0
  308. package/src/gen/zod/specificToolChoiceParamSchema.ts +9 -0
  309. package/src/gen/zod/streamOptionsParamSchema.ts +13 -0
  310. package/src/gen/zod/summaryTextContentSchema.ts +14 -0
  311. package/src/gen/zod/systemMessageItemParamSchema.ts +17 -0
  312. package/src/gen/zod/textContentSchema.ts +14 -0
  313. package/src/gen/zod/textFieldSchema.ts +15 -0
  314. package/src/gen/zod/textFormatParamSchema.ts +10 -0
  315. package/src/gen/zod/textParamSchema.ts +13 -0
  316. package/src/gen/zod/textResponseFormatSchema.ts +10 -0
  317. package/src/gen/zod/toolChoiceParamSchema.ts +14 -0
  318. package/src/gen/zod/toolChoiceValueEnumSchema.ts +8 -0
  319. package/src/gen/zod/toolSchema.ts +14 -0
  320. package/src/gen/zod/topLogProbSchema.ts +15 -0
  321. package/src/gen/zod/truncationEnumSchema.ts +8 -0
  322. package/src/gen/zod/urlCitationBodySchema.ts +17 -0
  323. package/src/gen/zod/urlCitationParamSchema.ts +14 -0
  324. package/src/gen/zod/usageSchema.ts +19 -0
  325. package/src/gen/zod/userMessageItemParamSchema.ts +23 -0
  326. package/src/gen/zod/verbosityEnumSchema.ts +8 -0
  327. package/tsconfig.json +21 -0
@@ -0,0 +1,3876 @@
1
+ {
2
+ "openapi": "3.1.0",
3
+ "info": {
4
+ "title": "OpenAI API",
5
+ "version": "2.3.0"
6
+ },
7
+ "servers": [
8
+ {
9
+ "url": "https://api.openai.com/v1"
10
+ }
11
+ ],
12
+ "components": {
13
+ "securitySchemes": {
14
+ "ApiKeyAuth": {
15
+ "type": "http",
16
+ "scheme": "bearer",
17
+ "in": "header"
18
+ }
19
+ },
20
+ "schemas": {
21
+ "ItemReferenceParam": {
22
+ "properties": {
23
+ "type": {
24
+ "anyOf": [
25
+ {
26
+ "type": "string",
27
+ "enum": ["item_reference"],
28
+ "description": "The type of item to reference. Always `item_reference`.",
29
+ "default": "item_reference"
30
+ },
31
+ {
32
+ "type": "null"
33
+ }
34
+ ]
35
+ },
36
+ "id": {
37
+ "type": "string",
38
+ "description": "The ID of the item to reference."
39
+ }
40
+ },
41
+ "type": "object",
42
+ "required": ["id"],
43
+ "title": "Item reference",
44
+ "description": "An internal identifier for an item to reference."
45
+ },
46
+ "ReasoningSummaryContentParam": {
47
+ "properties": {
48
+ "type": {
49
+ "type": "string",
50
+ "enum": ["summary_text"],
51
+ "description": "The content type. Always `summary_text`.",
52
+ "default": "summary_text"
53
+ },
54
+ "text": {
55
+ "type": "string",
56
+ "maxLength": 10485760,
57
+ "description": "The reasoning summary text."
58
+ }
59
+ },
60
+ "type": "object",
61
+ "required": ["type", "text"]
62
+ },
63
+ "ReasoningItemParam": {
64
+ "properties": {
65
+ "id": {
66
+ "anyOf": [
67
+ {
68
+ "type": "string",
69
+ "description": "The unique ID of this reasoning item.",
70
+ "example": "rs_123"
71
+ },
72
+ {
73
+ "type": "null"
74
+ }
75
+ ]
76
+ },
77
+ "type": {
78
+ "type": "string",
79
+ "enum": ["reasoning"],
80
+ "description": "The item type. Always `reasoning`.",
81
+ "default": "reasoning"
82
+ },
83
+ "summary": {
84
+ "items": {
85
+ "$ref": "#/components/schemas/ReasoningSummaryContentParam"
86
+ },
87
+ "type": "array",
88
+ "description": "Reasoning summary content associated with this item."
89
+ },
90
+ "content": {
91
+ "anyOf": [
92
+ {
93
+ "type": "null"
94
+ }
95
+ ]
96
+ },
97
+ "encrypted_content": {
98
+ "anyOf": [
99
+ {
100
+ "type": "string",
101
+ "description": "An encrypted representation of the reasoning content."
102
+ },
103
+ {
104
+ "type": "null"
105
+ }
106
+ ]
107
+ }
108
+ },
109
+ "type": "object",
110
+ "required": ["type", "summary"]
111
+ },
112
+ "InputTextContentParam": {
113
+ "properties": {
114
+ "type": {
115
+ "type": "string",
116
+ "enum": ["input_text"],
117
+ "description": "The type of the input item. Always `input_text`.",
118
+ "default": "input_text"
119
+ },
120
+ "text": {
121
+ "type": "string",
122
+ "maxLength": 10485760,
123
+ "description": "The text input to the model."
124
+ }
125
+ },
126
+ "type": "object",
127
+ "required": ["type", "text"],
128
+ "title": "Input text",
129
+ "description": "A text input to the model.",
130
+ "x-unionDisplay": "section",
131
+ "x-unionTitle": "Content Type"
132
+ },
133
+ "DetailEnum": {
134
+ "type": "string",
135
+ "enum": ["low", "high", "auto"],
136
+ "x-enumDescriptions": {
137
+ "auto": "Choose the detail level automatically.",
138
+ "high": "Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.",
139
+ "low": "Restricts the model to a lower-resolution version of the image."
140
+ }
141
+ },
142
+ "InputImageContentParamAutoParam": {
143
+ "properties": {
144
+ "type": {
145
+ "type": "string",
146
+ "enum": ["input_image"],
147
+ "description": "The type of the input item. Always `input_image`.",
148
+ "default": "input_image"
149
+ },
150
+ "image_url": {
151
+ "anyOf": [
152
+ {
153
+ "type": "string",
154
+ "maxLength": 20971520,
155
+ "description": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."
156
+ },
157
+ {
158
+ "type": "null"
159
+ }
160
+ ]
161
+ },
162
+ "detail": {
163
+ "anyOf": [
164
+ {
165
+ "allOf": [
166
+ {
167
+ "$ref": "#/components/schemas/ImageDetail"
168
+ },
169
+ {
170
+ "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."
171
+ }
172
+ ]
173
+ },
174
+ {
175
+ "type": "null"
176
+ }
177
+ ]
178
+ }
179
+ },
180
+ "type": "object",
181
+ "required": ["type"],
182
+ "title": "Input image",
183
+ "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision)"
184
+ },
185
+ "InputFileContentParam": {
186
+ "properties": {
187
+ "type": {
188
+ "type": "string",
189
+ "enum": ["input_file"],
190
+ "description": "The type of the input item. Always `input_file`.",
191
+ "default": "input_file"
192
+ },
193
+ "filename": {
194
+ "anyOf": [
195
+ {
196
+ "type": "string",
197
+ "description": "The name of the file to be sent to the model."
198
+ },
199
+ {
200
+ "type": "null"
201
+ }
202
+ ]
203
+ },
204
+ "file_data": {
205
+ "anyOf": [
206
+ {
207
+ "type": "string",
208
+ "maxLength": 33554432,
209
+ "description": "The base64-encoded data of the file to be sent to the model."
210
+ },
211
+ {
212
+ "type": "null"
213
+ }
214
+ ]
215
+ },
216
+ "file_url": {
217
+ "anyOf": [
218
+ {
219
+ "type": "string",
220
+ "description": "The URL of the file to be sent to the model."
221
+ },
222
+ {
223
+ "type": "null"
224
+ }
225
+ ]
226
+ }
227
+ },
228
+ "type": "object",
229
+ "required": ["type"],
230
+ "title": "Input file",
231
+ "description": "A file input to the model."
232
+ },
233
+ "UserMessageItemParam": {
234
+ "properties": {
235
+ "id": {
236
+ "anyOf": [
237
+ {
238
+ "type": "string",
239
+ "description": "The unique ID of this message item.",
240
+ "example": "msg_123"
241
+ },
242
+ {
243
+ "type": "null"
244
+ }
245
+ ]
246
+ },
247
+ "type": {
248
+ "type": "string",
249
+ "enum": ["message"],
250
+ "description": "The item type. Always `message`.",
251
+ "default": "message"
252
+ },
253
+ "role": {
254
+ "type": "string",
255
+ "enum": ["user"],
256
+ "description": "The message role. Always `user`.",
257
+ "default": "user"
258
+ },
259
+ "content": {
260
+ "oneOf": [
261
+ {
262
+ "items": {
263
+ "oneOf": [
264
+ {
265
+ "$ref": "#/components/schemas/InputTextContentParam"
266
+ },
267
+ {
268
+ "$ref": "#/components/schemas/InputImageContentParamAutoParam"
269
+ },
270
+ {
271
+ "$ref": "#/components/schemas/InputFileContentParam"
272
+ }
273
+ ],
274
+ "description": "A piece of message content, such as text, an image, or a file.",
275
+ "discriminator": {
276
+ "propertyName": "type"
277
+ }
278
+ },
279
+ "type": "array"
280
+ },
281
+ {
282
+ "type": "string",
283
+ "maxLength": 10485760,
284
+ "description": "The message content, as a single string."
285
+ }
286
+ ],
287
+ "description": "The message content, as an array of content parts."
288
+ },
289
+ "status": {
290
+ "anyOf": [
291
+ {
292
+ "type": "string",
293
+ "description": "The status of the message item."
294
+ },
295
+ {
296
+ "type": "null"
297
+ }
298
+ ]
299
+ }
300
+ },
301
+ "type": "object",
302
+ "required": ["type", "role", "content"]
303
+ },
304
+ "SystemMessageItemParam": {
305
+ "properties": {
306
+ "id": {
307
+ "anyOf": [
308
+ {
309
+ "type": "string",
310
+ "description": "The unique ID of this message item.",
311
+ "example": "msg_123"
312
+ },
313
+ {
314
+ "type": "null"
315
+ }
316
+ ]
317
+ },
318
+ "type": {
319
+ "type": "string",
320
+ "enum": ["message"],
321
+ "description": "The item type. Always `message`.",
322
+ "default": "message"
323
+ },
324
+ "role": {
325
+ "type": "string",
326
+ "enum": ["system"],
327
+ "description": "The message role. Always `system`.",
328
+ "default": "system"
329
+ },
330
+ "content": {
331
+ "oneOf": [
332
+ {
333
+ "items": {
334
+ "oneOf": [
335
+ {
336
+ "$ref": "#/components/schemas/InputTextContentParam"
337
+ }
338
+ ],
339
+ "discriminator": {
340
+ "propertyName": "type"
341
+ }
342
+ },
343
+ "type": "array"
344
+ },
345
+ {
346
+ "type": "string",
347
+ "maxLength": 10485760,
348
+ "description": "The message content, as a single string."
349
+ }
350
+ ],
351
+ "description": "The message content, as an array of content parts."
352
+ },
353
+ "status": {
354
+ "anyOf": [
355
+ {
356
+ "type": "string",
357
+ "description": "The status of the message item."
358
+ },
359
+ {
360
+ "type": "null"
361
+ }
362
+ ]
363
+ }
364
+ },
365
+ "type": "object",
366
+ "required": ["type", "role", "content"]
367
+ },
368
+ "DeveloperMessageItemParam": {
369
+ "properties": {
370
+ "id": {
371
+ "anyOf": [
372
+ {
373
+ "type": "string",
374
+ "description": "The unique ID of this message item.",
375
+ "example": "msg_123"
376
+ },
377
+ {
378
+ "type": "null"
379
+ }
380
+ ]
381
+ },
382
+ "type": {
383
+ "type": "string",
384
+ "enum": ["message"],
385
+ "description": "The item type. Always `message`.",
386
+ "default": "message"
387
+ },
388
+ "role": {
389
+ "type": "string",
390
+ "enum": ["developer"],
391
+ "description": "The message role. Always `developer`.",
392
+ "default": "developer"
393
+ },
394
+ "content": {
395
+ "oneOf": [
396
+ {
397
+ "items": {
398
+ "oneOf": [
399
+ {
400
+ "$ref": "#/components/schemas/InputTextContentParam"
401
+ }
402
+ ],
403
+ "discriminator": {
404
+ "propertyName": "type"
405
+ }
406
+ },
407
+ "type": "array"
408
+ },
409
+ {
410
+ "type": "string",
411
+ "maxLength": 10485760,
412
+ "description": "The message content, as a single string."
413
+ }
414
+ ],
415
+ "description": "The message content, as an array of content parts."
416
+ },
417
+ "status": {
418
+ "anyOf": [
419
+ {
420
+ "type": "string",
421
+ "description": "The status of the message item."
422
+ },
423
+ {
424
+ "type": "null"
425
+ }
426
+ ]
427
+ }
428
+ },
429
+ "type": "object",
430
+ "required": ["type", "role", "content"]
431
+ },
432
+ "UrlCitationParam": {
433
+ "properties": {
434
+ "type": {
435
+ "type": "string",
436
+ "enum": ["url_citation"],
437
+ "description": "The citation type. Always `url_citation`.",
438
+ "default": "url_citation"
439
+ },
440
+ "start_index": {
441
+ "type": "integer",
442
+ "minimum": 0,
443
+ "description": "The index of the first character of the citation in the message."
444
+ },
445
+ "end_index": {
446
+ "type": "integer",
447
+ "minimum": 0,
448
+ "description": "The index of the last character of the citation in the message."
449
+ },
450
+ "url": {
451
+ "type": "string",
452
+ "description": "The URL of the cited resource."
453
+ },
454
+ "title": {
455
+ "type": "string",
456
+ "description": "The title of the cited resource."
457
+ }
458
+ },
459
+ "type": "object",
460
+ "required": ["type", "start_index", "end_index", "url", "title"]
461
+ },
462
+ "OutputTextContentParam": {
463
+ "properties": {
464
+ "type": {
465
+ "type": "string",
466
+ "enum": ["output_text"],
467
+ "description": "The content type. Always `output_text`.",
468
+ "default": "output_text"
469
+ },
470
+ "text": {
471
+ "type": "string",
472
+ "maxLength": 10485760,
473
+ "description": "The text content."
474
+ },
475
+ "annotations": {
476
+ "oneOf": [
477
+ {
478
+ "items": {
479
+ "$ref": "#/components/schemas/UrlCitationParam"
480
+ },
481
+ "type": "array"
482
+ }
483
+ ],
484
+ "description": "Citations associated with the text content."
485
+ }
486
+ },
487
+ "type": "object",
488
+ "required": ["type", "text"]
489
+ },
490
+ "RefusalContentParam": {
491
+ "properties": {
492
+ "type": {
493
+ "type": "string",
494
+ "enum": ["refusal"],
495
+ "description": "The content type. Always `refusal`.",
496
+ "default": "refusal"
497
+ },
498
+ "refusal": {
499
+ "type": "string",
500
+ "maxLength": 10485760,
501
+ "description": "The refusal text."
502
+ }
503
+ },
504
+ "type": "object",
505
+ "required": ["type", "refusal"]
506
+ },
507
+ "AssistantMessageItemParam": {
508
+ "properties": {
509
+ "id": {
510
+ "anyOf": [
511
+ {
512
+ "type": "string",
513
+ "description": "The unique ID of this message item.",
514
+ "example": "msg_123"
515
+ },
516
+ {
517
+ "type": "null"
518
+ }
519
+ ]
520
+ },
521
+ "type": {
522
+ "type": "string",
523
+ "enum": ["message"],
524
+ "description": "The item type. Always `message`.",
525
+ "default": "message"
526
+ },
527
+ "role": {
528
+ "type": "string",
529
+ "enum": ["assistant"],
530
+ "description": "The role of the message author. Always `assistant`.",
531
+ "default": "assistant"
532
+ },
533
+ "content": {
534
+ "oneOf": [
535
+ {
536
+ "items": {
537
+ "oneOf": [
538
+ {
539
+ "$ref": "#/components/schemas/OutputTextContentParam"
540
+ },
541
+ {
542
+ "$ref": "#/components/schemas/RefusalContentParam"
543
+ }
544
+ ],
545
+ "description": "A piece of assistant message content, such as text or a refusal.",
546
+ "discriminator": {
547
+ "propertyName": "type"
548
+ }
549
+ },
550
+ "type": "array"
551
+ },
552
+ {
553
+ "type": "string",
554
+ "maxLength": 10485760,
555
+ "description": "The message content, as a single string."
556
+ }
557
+ ],
558
+ "description": "The message content, as an array of content parts."
559
+ },
560
+ "status": {
561
+ "anyOf": [
562
+ {
563
+ "type": "string",
564
+ "description": "The status of the message item."
565
+ },
566
+ {
567
+ "type": "null"
568
+ }
569
+ ]
570
+ }
571
+ },
572
+ "type": "object",
573
+ "required": ["type", "role", "content"]
574
+ },
575
+ "FunctionCallItemStatus": {
576
+ "type": "string",
577
+ "enum": ["in_progress", "completed", "incomplete"]
578
+ },
579
+ "FunctionCallItemParam": {
580
+ "properties": {
581
+ "id": {
582
+ "anyOf": [
583
+ {
584
+ "type": "string",
585
+ "description": "The unique ID of this function tool call.",
586
+ "example": "fc_123"
587
+ },
588
+ {
589
+ "type": "null"
590
+ }
591
+ ]
592
+ },
593
+ "call_id": {
594
+ "type": "string",
595
+ "maxLength": 64,
596
+ "minLength": 1,
597
+ "description": "The unique ID of the function tool call generated by the model."
598
+ },
599
+ "type": {
600
+ "type": "string",
601
+ "enum": ["function_call"],
602
+ "description": "The item type. Always `function_call`.",
603
+ "default": "function_call"
604
+ },
605
+ "name": {
606
+ "type": "string",
607
+ "maxLength": 64,
608
+ "minLength": 1,
609
+ "pattern": "^[a-zA-Z0-9_-]+$",
610
+ "description": "The name of the function to call."
611
+ },
612
+ "arguments": {
613
+ "type": "string",
614
+ "description": "The function arguments as a JSON string."
615
+ },
616
+ "status": {
617
+ "anyOf": [
618
+ {
619
+ "allOf": [
620
+ {
621
+ "$ref": "#/components/schemas/FunctionCallStatus"
622
+ },
623
+ {
624
+ "description": "The status of the function tool call."
625
+ }
626
+ ]
627
+ },
628
+ {
629
+ "type": "null"
630
+ }
631
+ ]
632
+ }
633
+ },
634
+ "type": "object",
635
+ "required": ["call_id", "type", "name", "arguments"]
636
+ },
637
+ "FunctionCallOutputItemParam": {
638
+ "properties": {
639
+ "id": {
640
+ "anyOf": [
641
+ {
642
+ "type": "string",
643
+ "description": "The unique ID of the function tool call output. Populated when this item is returned via API.",
644
+ "example": "fc_123"
645
+ },
646
+ {
647
+ "type": "null"
648
+ }
649
+ ]
650
+ },
651
+ "call_id": {
652
+ "type": "string",
653
+ "maxLength": 64,
654
+ "minLength": 1,
655
+ "description": "The unique ID of the function tool call generated by the model."
656
+ },
657
+ "type": {
658
+ "type": "string",
659
+ "enum": ["function_call_output"],
660
+ "description": "The type of the function tool call output. Always `function_call_output`.",
661
+ "default": "function_call_output"
662
+ },
663
+ "output": {
664
+ "oneOf": [
665
+ {
666
+ "type": "string",
667
+ "maxLength": 10485760,
668
+ "description": "A JSON string of the output of the function tool call."
669
+ },
670
+ {
671
+ "items": {
672
+ "oneOf": [
673
+ {
674
+ "$ref": "#/components/schemas/InputTextContentParam"
675
+ },
676
+ {
677
+ "$ref": "#/components/schemas/InputImageContentParamAutoParam"
678
+ },
679
+ {
680
+ "$ref": "#/components/schemas/InputFileContentParam"
681
+ },
682
+ {
683
+ "$ref": "#/components/schemas/InputVideoContent"
684
+ }
685
+ ],
686
+ "description": "A piece of message content, such as text, an image, or a file.",
687
+ "discriminator": {
688
+ "propertyName": "type"
689
+ }
690
+ },
691
+ "type": "array",
692
+ "description": "An array of content outputs (text, image, file) for the function tool call."
693
+ }
694
+ ],
695
+ "description": "Text, image, or file output of the function tool call."
696
+ },
697
+ "status": {
698
+ "anyOf": [
699
+ {
700
+ "allOf": [
701
+ {
702
+ "$ref": "#/components/schemas/FunctionCallStatus"
703
+ },
704
+ {
705
+ "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."
706
+ }
707
+ ]
708
+ },
709
+ {
710
+ "type": "null"
711
+ }
712
+ ]
713
+ }
714
+ },
715
+ "type": "object",
716
+ "required": ["call_id", "type", "output"],
717
+ "title": "Function tool call output",
718
+ "description": "The output of a function tool call."
719
+ },
720
+ "ItemParam": {
721
+ "oneOf": [
722
+ {
723
+ "$ref": "#/components/schemas/ItemReferenceParam"
724
+ },
725
+ {
726
+ "$ref": "#/components/schemas/ReasoningItemParam"
727
+ },
728
+ {
729
+ "$ref": "#/components/schemas/UserMessageItemParam"
730
+ },
731
+ {
732
+ "$ref": "#/components/schemas/SystemMessageItemParam"
733
+ },
734
+ {
735
+ "$ref": "#/components/schemas/DeveloperMessageItemParam"
736
+ },
737
+ {
738
+ "$ref": "#/components/schemas/AssistantMessageItemParam"
739
+ },
740
+ {
741
+ "$ref": "#/components/schemas/FunctionCallItemParam"
742
+ },
743
+ {
744
+ "$ref": "#/components/schemas/FunctionCallOutputItemParam"
745
+ }
746
+ ],
747
+ "discriminator": {
748
+ "propertyName": "type"
749
+ },
750
+ "x-unionDisplay": "section",
751
+ "x-unionTitle": "Input Item Types"
752
+ },
753
+ "IncludeEnum": {
754
+ "type": "string",
755
+ "enum": ["reasoning.encrypted_content", "message.output_text.logprobs"],
756
+ "description": "",
757
+ "x-enumDescriptions": {
758
+ "message.output_text.logprobs": "includes sampled logprobs in assistant messages.",
759
+ "reasoning.encrypted_content": "includes encrypted reasoning content so that it may be rehydrated on a subsequent request."
760
+ }
761
+ },
762
+ "EmptyModelParam": {
763
+ "properties": {},
764
+ "type": "object",
765
+ "required": []
766
+ },
767
+ "FunctionToolParam": {
768
+ "properties": {
769
+ "name": {
770
+ "type": "string",
771
+ "maxLength": 64,
772
+ "minLength": 1,
773
+ "pattern": "^[a-zA-Z0-9_-]+$"
774
+ },
775
+ "description": {
776
+ "anyOf": [
777
+ {
778
+ "type": "string"
779
+ },
780
+ {
781
+ "type": "null"
782
+ }
783
+ ]
784
+ },
785
+ "parameters": {
786
+ "anyOf": [
787
+ {
788
+ "$ref": "#/components/schemas/EmptyModelParam"
789
+ },
790
+ {
791
+ "type": "null"
792
+ }
793
+ ]
794
+ },
795
+ "strict": {
796
+ "type": "boolean"
797
+ },
798
+ "type": {
799
+ "type": "string",
800
+ "enum": ["function"],
801
+ "default": "function"
802
+ }
803
+ },
804
+ "type": "object",
805
+ "required": ["name", "type"]
806
+ },
807
+ "ResponsesToolParam": {
808
+ "oneOf": [
809
+ {
810
+ "$ref": "#/components/schemas/FunctionToolParam"
811
+ }
812
+ ],
813
+ "discriminator": {
814
+ "propertyName": "type"
815
+ },
816
+ "x-unionDisplay": "section",
817
+ "x-unionTitle": "Tool Types"
818
+ },
819
+ "SpecificFunctionParam": {
820
+ "properties": {
821
+ "type": {
822
+ "type": "string",
823
+ "enum": ["function"],
824
+ "description": "The tool to call. Always `function`.",
825
+ "default": "function"
826
+ },
827
+ "name": {
828
+ "type": "string",
829
+ "description": "The name of the function tool to call."
830
+ }
831
+ },
832
+ "type": "object",
833
+ "required": ["type", "name"]
834
+ },
835
+ "SpecificToolChoiceParam": {
836
+ "oneOf": [
837
+ {
838
+ "$ref": "#/components/schemas/SpecificFunctionParam"
839
+ }
840
+ ]
841
+ },
842
+ "ToolChoiceValueEnum": {
843
+ "type": "string",
844
+ "enum": ["none", "auto", "required"],
845
+ "x-enumDescriptions": {
846
+ "auto": "Let the model choose the tools from among the provided set.",
847
+ "none": "Restrict the model from calling any tools.",
848
+ "required": "Require the model to call a tool."
849
+ }
850
+ },
851
+ "AllowedToolsParam": {
852
+ "properties": {
853
+ "type": {
854
+ "type": "string",
855
+ "enum": ["allowed_tools"],
856
+ "description": "The tool choice type. Always `allowed_tools`.",
857
+ "default": "allowed_tools"
858
+ },
859
+ "tools": {
860
+ "items": {
861
+ "$ref": "#/components/schemas/SpecificToolChoiceParam"
862
+ },
863
+ "type": "array",
864
+ "maxItems": 128,
865
+ "minItems": 1,
866
+ "description": "The list of tools that are permitted for this request."
867
+ },
868
+ "mode": {
869
+ "allOf": [
870
+ {
871
+ "$ref": "#/components/schemas/ToolChoiceValueEnum"
872
+ },
873
+ {
874
+ "description": "How to select a tool from the allowed set."
875
+ }
876
+ ]
877
+ }
878
+ },
879
+ "type": "object",
880
+ "required": ["type", "tools"]
881
+ },
882
+ "ToolChoiceParam": {
883
+ "oneOf": [
884
+ {
885
+ "$ref": "#/components/schemas/SpecificToolChoiceParam"
886
+ },
887
+ {
888
+ "$ref": "#/components/schemas/ToolChoiceValueEnum"
889
+ },
890
+ {
891
+ "$ref": "#/components/schemas/AllowedToolsParam"
892
+ }
893
+ ],
894
+ "description": "Controls which tool the model should use, if any."
895
+ },
896
+ "MetadataParam": {
897
+ "additionalProperties": {
898
+ "type": "string",
899
+ "maxLength": 512
900
+ },
901
+ "type": "object",
902
+ "maxProperties": 16,
903
+ "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."
904
+ },
905
+ "VerbosityEnum": {
906
+ "type": "string",
907
+ "enum": ["low", "medium", "high"],
908
+ "x-enumDescriptions": {
909
+ "high": "Instruct the model to emit more verbose final responses.",
910
+ "low": "Instruct the model to emit less verbose final responses.",
911
+ "medium": "Use the model's default verbosity setting."
912
+ }
913
+ },
914
+ "TextParam": {
915
+ "properties": {
916
+ "format": {
917
+ "description": "The format configuration for text output.",
918
+ "oneOf": [
919
+ {
920
+ "$ref": "#/components/schemas/TextFormatParam"
921
+ },
922
+ {
923
+ "type": "null"
924
+ }
925
+ ]
926
+ },
927
+ "verbosity": {
928
+ "allOf": [
929
+ {
930
+ "$ref": "#/components/schemas/VerbosityEnum"
931
+ },
932
+ {
933
+ "description": "Controls the level of detail in generated text output."
934
+ }
935
+ ]
936
+ }
937
+ },
938
+ "type": "object",
939
+ "required": []
940
+ },
941
+ "StreamOptionsParam": {
942
+ "properties": {
943
+ "include_obfuscation": {
944
+ "type": "boolean",
945
+ "description": "Whether to obfuscate sensitive information in streamed output. Defaults to `true`."
946
+ }
947
+ },
948
+ "type": "object",
949
+ "required": [],
950
+ "description": "Options that control streamed response behavior."
951
+ },
952
+ "ReasoningEffortEnum": {
953
+ "type": "string",
954
+ "enum": ["none", "low", "medium", "high", "xhigh"],
955
+ "x-enumDescriptions": {
956
+ "high": "Use a higher reasoning effort to improve answer quality.",
957
+ "medium": "Use a balanced reasoning effort.",
958
+ "low": "Use a lower reasoning effort for faster responses.",
959
+ "minimal": "Use the lowest non-zero reasoning effort.",
960
+ "none": "Restrict the model from performing any reasoning before emitting a final answer.",
961
+ "xhigh": "Use the maximum reasoning effort available."
962
+ }
963
+ },
964
+ "ReasoningSummaryEnum": {
965
+ "type": "string",
966
+ "enum": ["concise", "detailed", "auto"],
967
+ "x-enumDescriptions": {
968
+ "auto": "Allow the model to decide when to summarize.",
969
+ "concise": "Emit concise summaries of reasoning content.",
970
+ "detailed": "Emit details summaries of reasoning content."
971
+ }
972
+ },
973
+ "ReasoningParam": {
974
+ "properties": {
975
+ "effort": {
976
+ "anyOf": [
977
+ {
978
+ "oneOf": [
979
+ {
980
+ "$ref": "#/components/schemas/ReasoningEffortEnum"
981
+ }
982
+ ],
983
+ "description": "Controls the level of reasoning effort the model should apply. Higher effort may increase latency and cost."
984
+ },
985
+ {
986
+ "type": "null"
987
+ }
988
+ ]
989
+ },
990
+ "summary": {
991
+ "anyOf": [
992
+ {
993
+ "allOf": [
994
+ {
995
+ "$ref": "#/components/schemas/ReasoningSummaryEnum"
996
+ },
997
+ {
998
+ "description": "Controls whether the response includes a reasoning summary."
999
+ }
1000
+ ]
1001
+ },
1002
+ {
1003
+ "type": "null"
1004
+ }
1005
+ ]
1006
+ }
1007
+ },
1008
+ "type": "object",
1009
+ "required": [],
1010
+ "description": "**gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning)."
1011
+ },
1012
+ "TruncationEnum": {
1013
+ "type": "string",
1014
+ "enum": ["auto", "disabled"],
1015
+ "x-enumDescriptions": {
1016
+ "auto": "Let the service decide how to truncate.",
1017
+ "disabled": "Disable service truncation. Context over the model's context limit will result in a 400 error."
1018
+ }
1019
+ },
1020
+ "ServiceTierEnum": {
1021
+ "type": "string",
1022
+ "enum": ["auto", "default", "flex", "priority"],
1023
+ "x-enumDescriptions": {
1024
+ "auto": "Choose a service tier automatically based on current account state.",
1025
+ "default": "Choose the default service tier.",
1026
+ "flex": "Choose the flex service tier.",
1027
+ "priority": "Choose the priority service tier."
1028
+ }
1029
+ },
1030
+ "CreateResponseBody": {
1031
+ "properties": {
1032
+ "model": {
1033
+ "anyOf": [
1034
+ {
1035
+ "type": "string",
1036
+ "description": "The model to use for this request, e.g. 'gpt-5.2'."
1037
+ },
1038
+ {
1039
+ "type": "null"
1040
+ }
1041
+ ]
1042
+ },
1043
+ "input": {
1044
+ "anyOf": [
1045
+ {
1046
+ "oneOf": [
1047
+ {
1048
+ "type": "string",
1049
+ "maxLength": 10485760
1050
+ },
1051
+ {
1052
+ "items": {
1053
+ "$ref": "#/components/schemas/ItemParam"
1054
+ },
1055
+ "type": "array"
1056
+ }
1057
+ ],
1058
+ "description": "Context to provide to the model for the scope of this request. May either be a string or an array of input items. If a string is provided, it is interpreted as a user message."
1059
+ },
1060
+ {
1061
+ "type": "null"
1062
+ }
1063
+ ]
1064
+ },
1065
+ "previous_response_id": {
1066
+ "anyOf": [
1067
+ {
1068
+ "type": "string",
1069
+ "description": "The ID of the response to use as the prior turn for this request.",
1070
+ "example": "resp_123"
1071
+ },
1072
+ {
1073
+ "type": "null"
1074
+ }
1075
+ ]
1076
+ },
1077
+ "include": {
1078
+ "items": {
1079
+ "$ref": "#/components/schemas/IncludeEnum"
1080
+ },
1081
+ "type": "array"
1082
+ },
1083
+ "tools": {
1084
+ "anyOf": [
1085
+ {
1086
+ "items": {
1087
+ "$ref": "#/components/schemas/ResponsesToolParam"
1088
+ },
1089
+ "type": "array",
1090
+ "description": "A list of tools that the model may call while generating the response."
1091
+ },
1092
+ {
1093
+ "type": "null"
1094
+ }
1095
+ ]
1096
+ },
1097
+ "tool_choice": {
1098
+ "anyOf": [
1099
+ {
1100
+ "allOf": [
1101
+ {
1102
+ "$ref": "#/components/schemas/ToolChoiceParam"
1103
+ },
1104
+ {
1105
+ "description": "Controls which tool the model should use, if any."
1106
+ }
1107
+ ]
1108
+ },
1109
+ {
1110
+ "type": "null"
1111
+ }
1112
+ ],
1113
+ "x-unionTitle": "ToolChoiceParam"
1114
+ },
1115
+ "metadata": {
1116
+ "anyOf": [
1117
+ {
1118
+ "allOf": [
1119
+ {
1120
+ "$ref": "#/components/schemas/MetadataParam"
1121
+ },
1122
+ {
1123
+ "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."
1124
+ }
1125
+ ]
1126
+ },
1127
+ {
1128
+ "type": "null"
1129
+ }
1130
+ ]
1131
+ },
1132
+ "text": {
1133
+ "anyOf": [
1134
+ {
1135
+ "allOf": [
1136
+ {
1137
+ "$ref": "#/components/schemas/TextParam"
1138
+ },
1139
+ {
1140
+ "description": "Configuration options for text output."
1141
+ }
1142
+ ]
1143
+ },
1144
+ {
1145
+ "type": "null"
1146
+ }
1147
+ ]
1148
+ },
1149
+ "temperature": {
1150
+ "anyOf": [
1151
+ {
1152
+ "type": "number",
1153
+ "description": "Sampling temperature to use, between 0 and 2. Higher values make the output more random."
1154
+ },
1155
+ {
1156
+ "type": "null"
1157
+ }
1158
+ ]
1159
+ },
1160
+ "top_p": {
1161
+ "anyOf": [
1162
+ {
1163
+ "type": "number",
1164
+ "description": "Nucleus sampling parameter, between 0 and 1. The model considers only the tokens with the top cumulative probability."
1165
+ },
1166
+ {
1167
+ "type": "null"
1168
+ }
1169
+ ]
1170
+ },
1171
+ "presence_penalty": {
1172
+ "anyOf": [
1173
+ {
1174
+ "type": "number",
1175
+ "description": "Penalizes new tokens based on whether they appear in the text so far."
1176
+ },
1177
+ {
1178
+ "type": "null"
1179
+ }
1180
+ ]
1181
+ },
1182
+ "frequency_penalty": {
1183
+ "anyOf": [
1184
+ {
1185
+ "type": "number",
1186
+ "description": "Penalizes new tokens based on their frequency in the text so far."
1187
+ },
1188
+ {
1189
+ "type": "null"
1190
+ }
1191
+ ]
1192
+ },
1193
+ "parallel_tool_calls": {
1194
+ "anyOf": [
1195
+ {
1196
+ "type": "boolean",
1197
+ "description": "Whether the model may call multiple tools in parallel."
1198
+ },
1199
+ {
1200
+ "type": "null"
1201
+ }
1202
+ ]
1203
+ },
1204
+ "stream": {
1205
+ "type": "boolean",
1206
+ "description": "Whether to stream response events as server-sent events."
1207
+ },
1208
+ "stream_options": {
1209
+ "anyOf": [
1210
+ {
1211
+ "allOf": [
1212
+ {
1213
+ "$ref": "#/components/schemas/StreamOptionsParam"
1214
+ },
1215
+ {
1216
+ "description": "Options that control streamed response behavior."
1217
+ }
1218
+ ]
1219
+ },
1220
+ {
1221
+ "type": "null"
1222
+ }
1223
+ ]
1224
+ },
1225
+ "background": {
1226
+ "type": "boolean",
1227
+ "description": "Whether to run the request in the background and return immediately."
1228
+ },
1229
+ "max_output_tokens": {
1230
+ "anyOf": [
1231
+ {
1232
+ "type": "integer",
1233
+ "minimum": 16,
1234
+ "description": "The maximum number of tokens the model may generate for this response."
1235
+ },
1236
+ {
1237
+ "type": "null"
1238
+ }
1239
+ ]
1240
+ },
1241
+ "max_tool_calls": {
1242
+ "anyOf": [
1243
+ {
1244
+ "type": "integer",
1245
+ "minimum": 1,
1246
+ "description": "The maximum number of tool calls the model may make while generating the response."
1247
+ },
1248
+ {
1249
+ "type": "null"
1250
+ }
1251
+ ]
1252
+ },
1253
+ "reasoning": {
1254
+ "anyOf": [
1255
+ {
1256
+ "allOf": [
1257
+ {
1258
+ "$ref": "#/components/schemas/ReasoningParam"
1259
+ },
1260
+ {
1261
+ "description": "Configuration options for reasoning behavior."
1262
+ }
1263
+ ]
1264
+ },
1265
+ {
1266
+ "type": "null"
1267
+ }
1268
+ ]
1269
+ },
1270
+ "safety_identifier": {
1271
+ "anyOf": [
1272
+ {
1273
+ "type": "string",
1274
+ "maxLength": 64,
1275
+ "description": "A stable identifier used for safety monitoring and abuse detection."
1276
+ },
1277
+ {
1278
+ "type": "null"
1279
+ }
1280
+ ]
1281
+ },
1282
+ "prompt_cache_key": {
1283
+ "anyOf": [
1284
+ {
1285
+ "type": "string",
1286
+ "maxLength": 64,
1287
+ "description": "A key to use when reading from or writing to the prompt cache."
1288
+ },
1289
+ {
1290
+ "type": "null"
1291
+ }
1292
+ ]
1293
+ },
1294
+ "truncation": {
1295
+ "allOf": [
1296
+ {
1297
+ "$ref": "#/components/schemas/TruncationEnum"
1298
+ },
1299
+ {
1300
+ "description": "Controls how the service truncates the input when it exceeds the model context window."
1301
+ }
1302
+ ]
1303
+ },
1304
+ "instructions": {
1305
+ "anyOf": [
1306
+ {
1307
+ "type": "string",
1308
+ "description": "Additional instructions to guide the model for this request."
1309
+ },
1310
+ {
1311
+ "type": "null"
1312
+ }
1313
+ ]
1314
+ },
1315
+ "store": {
1316
+ "type": "boolean",
1317
+ "description": "Whether to store the response so it can be retrieved later."
1318
+ },
1319
+ "service_tier": {
1320
+ "allOf": [
1321
+ {
1322
+ "$ref": "#/components/schemas/ServiceTierEnum"
1323
+ },
1324
+ {
1325
+ "description": "The service tier to use for this request."
1326
+ }
1327
+ ]
1328
+ },
1329
+ "top_logprobs": {
1330
+ "anyOf": [
1331
+ {
1332
+ "type": "integer",
1333
+ "maximum": 20,
1334
+ "minimum": 0,
1335
+ "description": "The number of most likely tokens to return at each position, along with their log probabilities."
1336
+ },
1337
+ {
1338
+ "type": "null"
1339
+ }
1340
+ ]
1341
+ }
1342
+ },
1343
+ "type": "object",
1344
+ "required": []
1345
+ },
1346
+ "IncompleteDetails": {
1347
+ "properties": {
1348
+ "reason": {
1349
+ "type": "string",
1350
+ "description": "The reason the response could not be completed."
1351
+ }
1352
+ },
1353
+ "type": "object",
1354
+ "required": ["reason"],
1355
+ "title": "Incomplete details",
1356
+ "description": "Details about why the response was incomplete."
1357
+ },
1358
+ "MessageRole": {
1359
+ "type": "string",
1360
+ "enum": ["user", "assistant", "system", "developer"],
1361
+ "x-enumDescriptions": {
1362
+ "assistant": "Model-generated content in the conversation.",
1363
+ "developer": "Developer-supplied guidance that shapes the assistant\u2019s behavior.",
1364
+ "system": "System-level instructions that set global behavior.",
1365
+ "user": "End\u2011user input in the conversation."
1366
+ }
1367
+ },
1368
+ "InputTextContent": {
1369
+ "properties": {
1370
+ "type": {
1371
+ "type": "string",
1372
+ "enum": ["input_text"],
1373
+ "description": "The type of the input item. Always `input_text`.",
1374
+ "default": "input_text"
1375
+ },
1376
+ "text": {
1377
+ "type": "string",
1378
+ "description": "The text input to the model."
1379
+ }
1380
+ },
1381
+ "type": "object",
1382
+ "required": ["type", "text"],
1383
+ "title": "Input text",
1384
+ "description": "A text input to the model."
1385
+ },
1386
+ "UrlCitationBody": {
1387
+ "properties": {
1388
+ "type": {
1389
+ "type": "string",
1390
+ "enum": ["url_citation"],
1391
+ "description": "The type of the URL citation. Always `url_citation`.",
1392
+ "default": "url_citation"
1393
+ },
1394
+ "url": {
1395
+ "type": "string",
1396
+ "description": "The URL of the web resource."
1397
+ },
1398
+ "start_index": {
1399
+ "type": "integer",
1400
+ "description": "The index of the first character of the URL citation in the message."
1401
+ },
1402
+ "end_index": {
1403
+ "type": "integer",
1404
+ "description": "The index of the last character of the URL citation in the message."
1405
+ },
1406
+ "title": {
1407
+ "type": "string",
1408
+ "description": "The title of the web resource."
1409
+ }
1410
+ },
1411
+ "type": "object",
1412
+ "required": ["type", "url", "start_index", "end_index", "title"],
1413
+ "title": "URL citation",
1414
+ "description": "A citation for a web resource used to generate a model response."
1415
+ },
1416
+ "Annotation": {
1417
+ "oneOf": [
1418
+ {
1419
+ "$ref": "#/components/schemas/UrlCitationBody"
1420
+ }
1421
+ ],
1422
+ "description": "An annotation that applies to a span of output text.",
1423
+ "discriminator": {
1424
+ "propertyName": "type"
1425
+ }
1426
+ },
1427
+ "TopLogProb": {
1428
+ "properties": {
1429
+ "token": {
1430
+ "type": "string"
1431
+ },
1432
+ "logprob": {
1433
+ "type": "number"
1434
+ },
1435
+ "bytes": {
1436
+ "items": {
1437
+ "type": "integer"
1438
+ },
1439
+ "type": "array"
1440
+ }
1441
+ },
1442
+ "type": "object",
1443
+ "required": ["token", "logprob", "bytes"],
1444
+ "title": "Top log probability",
1445
+ "description": "The top log probability of a token."
1446
+ },
1447
+ "LogProb": {
1448
+ "properties": {
1449
+ "token": {
1450
+ "type": "string"
1451
+ },
1452
+ "logprob": {
1453
+ "type": "number"
1454
+ },
1455
+ "bytes": {
1456
+ "items": {
1457
+ "type": "integer"
1458
+ },
1459
+ "type": "array"
1460
+ },
1461
+ "top_logprobs": {
1462
+ "items": {
1463
+ "$ref": "#/components/schemas/TopLogProb"
1464
+ },
1465
+ "type": "array"
1466
+ }
1467
+ },
1468
+ "type": "object",
1469
+ "required": ["token", "logprob", "bytes", "top_logprobs"],
1470
+ "title": "Log probability",
1471
+ "description": "The log probability of a token."
1472
+ },
1473
+ "OutputTextContent": {
1474
+ "properties": {
1475
+ "type": {
1476
+ "type": "string",
1477
+ "enum": ["output_text"],
1478
+ "description": "The type of the output text. Always `output_text`.",
1479
+ "default": "output_text"
1480
+ },
1481
+ "text": {
1482
+ "type": "string",
1483
+ "description": "The text output from the model."
1484
+ },
1485
+ "annotations": {
1486
+ "items": {
1487
+ "$ref": "#/components/schemas/Annotation"
1488
+ },
1489
+ "type": "array",
1490
+ "description": "The annotations of the text output."
1491
+ },
1492
+ "logprobs": {
1493
+ "items": {
1494
+ "$ref": "#/components/schemas/LogProb"
1495
+ },
1496
+ "type": "array"
1497
+ }
1498
+ },
1499
+ "type": "object",
1500
+ "required": ["type", "text", "annotations", "logprobs"],
1501
+ "title": "Output text",
1502
+ "description": "A text output from the model."
1503
+ },
1504
+ "TextContent": {
1505
+ "properties": {
1506
+ "type": {
1507
+ "type": "string",
1508
+ "enum": ["text"],
1509
+ "default": "text"
1510
+ },
1511
+ "text": {
1512
+ "type": "string"
1513
+ }
1514
+ },
1515
+ "type": "object",
1516
+ "required": ["type", "text"],
1517
+ "title": "Text Content",
1518
+ "description": "A text content."
1519
+ },
1520
+ "SummaryTextContent": {
1521
+ "properties": {
1522
+ "type": {
1523
+ "type": "string",
1524
+ "enum": ["summary_text"],
1525
+ "description": "The type of the object. Always `summary_text`.",
1526
+ "default": "summary_text"
1527
+ },
1528
+ "text": {
1529
+ "type": "string",
1530
+ "description": "A summary of the reasoning output from the model so far."
1531
+ }
1532
+ },
1533
+ "type": "object",
1534
+ "required": ["type", "text"],
1535
+ "title": "Summary text",
1536
+ "description": "A summary text from the model."
1537
+ },
1538
+ "ReasoningTextContent": {
1539
+ "properties": {
1540
+ "type": {
1541
+ "type": "string",
1542
+ "enum": ["reasoning_text"],
1543
+ "description": "The type of the reasoning text. Always `reasoning_text`.",
1544
+ "default": "reasoning_text"
1545
+ },
1546
+ "text": {
1547
+ "type": "string",
1548
+ "description": "The reasoning text from the model."
1549
+ }
1550
+ },
1551
+ "type": "object",
1552
+ "required": ["type", "text"],
1553
+ "title": "Reasoning text",
1554
+ "description": "Reasoning text from the model."
1555
+ },
1556
+ "RefusalContent": {
1557
+ "properties": {
1558
+ "type": {
1559
+ "type": "string",
1560
+ "enum": ["refusal"],
1561
+ "description": "The type of the refusal. Always `refusal`.",
1562
+ "default": "refusal"
1563
+ },
1564
+ "refusal": {
1565
+ "type": "string",
1566
+ "description": "The refusal explanation from the model."
1567
+ }
1568
+ },
1569
+ "type": "object",
1570
+ "required": ["type", "refusal"],
1571
+ "title": "Refusal",
1572
+ "description": "A refusal from the model."
1573
+ },
1574
+ "ImageDetail": {
1575
+ "type": "string",
1576
+ "enum": ["low", "high", "auto"],
1577
+ "x-enumDescriptions": {
1578
+ "auto": "Choose the detail level automatically.",
1579
+ "high": "Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.",
1580
+ "low": "Restricts the model to a lower-resolution version of the image."
1581
+ }
1582
+ },
1583
+ "InputImageContent": {
1584
+ "properties": {
1585
+ "type": {
1586
+ "type": "string",
1587
+ "enum": ["input_image"],
1588
+ "description": "The type of the input item. Always `input_image`.",
1589
+ "default": "input_image"
1590
+ },
1591
+ "image_url": {
1592
+ "anyOf": [
1593
+ {
1594
+ "type": "string",
1595
+ "description": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."
1596
+ },
1597
+ {
1598
+ "type": "null"
1599
+ }
1600
+ ]
1601
+ },
1602
+ "detail": {
1603
+ "allOf": [
1604
+ {
1605
+ "$ref": "#/components/schemas/ImageDetail"
1606
+ },
1607
+ {
1608
+ "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."
1609
+ }
1610
+ ]
1611
+ }
1612
+ },
1613
+ "type": "object",
1614
+ "required": ["type", "image_url", "detail"],
1615
+ "title": "Input image",
1616
+ "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision)."
1617
+ },
1618
+ "InputFileContent": {
1619
+ "properties": {
1620
+ "type": {
1621
+ "type": "string",
1622
+ "enum": ["input_file"],
1623
+ "description": "The type of the input item. Always `input_file`.",
1624
+ "default": "input_file"
1625
+ },
1626
+ "filename": {
1627
+ "type": "string",
1628
+ "description": "The name of the file to be sent to the model."
1629
+ },
1630
+ "file_url": {
1631
+ "type": "string",
1632
+ "description": "The URL of the file to be sent to the model."
1633
+ }
1634
+ },
1635
+ "type": "object",
1636
+ "required": ["type"],
1637
+ "title": "Input file",
1638
+ "description": "A file input to the model."
1639
+ },
1640
+ "MessageStatus": {
1641
+ "type": "string",
1642
+ "enum": ["in_progress", "completed", "incomplete"],
1643
+ "x-enumDescriptions": {
1644
+ "completed": "Model has finished sampling this item.",
1645
+ "in_progress": "Model is currently sampling this item.",
1646
+ "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."
1647
+ }
1648
+ },
1649
+ "Message": {
1650
+ "properties": {
1651
+ "type": {
1652
+ "type": "string",
1653
+ "enum": ["message"],
1654
+ "description": "The type of the message. Always set to `message`.",
1655
+ "default": "message"
1656
+ },
1657
+ "id": {
1658
+ "type": "string",
1659
+ "description": "The unique ID of the message."
1660
+ },
1661
+ "status": {
1662
+ "allOf": [
1663
+ {
1664
+ "$ref": "#/components/schemas/MessageStatus"
1665
+ },
1666
+ {
1667
+ "description": "The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."
1668
+ }
1669
+ ]
1670
+ },
1671
+ "role": {
1672
+ "allOf": [
1673
+ {
1674
+ "$ref": "#/components/schemas/MessageRole"
1675
+ },
1676
+ {
1677
+ "description": "The role of the message. One of `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`, or `tool`."
1678
+ }
1679
+ ]
1680
+ },
1681
+ "content": {
1682
+ "items": {
1683
+ "oneOf": [
1684
+ {
1685
+ "$ref": "#/components/schemas/InputTextContent"
1686
+ },
1687
+ {
1688
+ "$ref": "#/components/schemas/OutputTextContent"
1689
+ },
1690
+ {
1691
+ "$ref": "#/components/schemas/TextContent"
1692
+ },
1693
+ {
1694
+ "$ref": "#/components/schemas/SummaryTextContent"
1695
+ },
1696
+ {
1697
+ "$ref": "#/components/schemas/ReasoningTextContent"
1698
+ },
1699
+ {
1700
+ "$ref": "#/components/schemas/RefusalContent"
1701
+ },
1702
+ {
1703
+ "$ref": "#/components/schemas/InputImageContent"
1704
+ },
1705
+ {
1706
+ "$ref": "#/components/schemas/InputFileContent"
1707
+ },
1708
+ {
1709
+ "$ref": "#/components/schemas/InputVideoContent"
1710
+ }
1711
+ ],
1712
+ "description": "A content part that makes up an input or output item.",
1713
+ "discriminator": {
1714
+ "propertyName": "type"
1715
+ }
1716
+ },
1717
+ "type": "array",
1718
+ "description": "The content of the message"
1719
+ }
1720
+ },
1721
+ "type": "object",
1722
+ "required": ["type", "id", "status", "role", "content"],
1723
+ "title": "Message",
1724
+ "description": "A message to or from the model."
1725
+ },
1726
+ "FunctionCallStatus": {
1727
+ "type": "string",
1728
+ "enum": ["in_progress", "completed", "incomplete"],
1729
+ "x-enumDescriptions": {
1730
+ "completed": "Model has finished sampling this item.",
1731
+ "in_progress": "Model is currently sampling this item.",
1732
+ "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."
1733
+ }
1734
+ },
1735
+ "FunctionCall": {
1736
+ "properties": {
1737
+ "type": {
1738
+ "type": "string",
1739
+ "enum": ["function_call"],
1740
+ "description": "The type of the item. Always `function_call`.",
1741
+ "default": "function_call"
1742
+ },
1743
+ "id": {
1744
+ "type": "string",
1745
+ "description": "The unique ID of the function call item."
1746
+ },
1747
+ "call_id": {
1748
+ "type": "string",
1749
+ "description": "The unique ID of the function tool call that was generated."
1750
+ },
1751
+ "name": {
1752
+ "type": "string",
1753
+ "description": "The name of the function that was called."
1754
+ },
1755
+ "arguments": {
1756
+ "type": "string",
1757
+ "description": "The arguments JSON string that was generated."
1758
+ },
1759
+ "status": {
1760
+ "allOf": [
1761
+ {
1762
+ "$ref": "#/components/schemas/FunctionCallStatus"
1763
+ },
1764
+ {
1765
+ "description": "The status of the function call item that was recorded."
1766
+ }
1767
+ ]
1768
+ }
1769
+ },
1770
+ "type": "object",
1771
+ "required": ["type", "id", "call_id", "name", "arguments", "status"],
1772
+ "title": "Function call",
1773
+ "description": "A function tool call that was generated by the model."
1774
+ },
1775
+ "FunctionCallOutputStatusEnum": {
1776
+ "type": "string",
1777
+ "enum": ["in_progress", "completed", "incomplete"],
1778
+ "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."
1779
+ },
1780
+ "FunctionCallOutput": {
1781
+ "properties": {
1782
+ "type": {
1783
+ "type": "string",
1784
+ "enum": ["function_call_output"],
1785
+ "description": "The type of the function tool call output. Always `function_call_output`.",
1786
+ "default": "function_call_output"
1787
+ },
1788
+ "id": {
1789
+ "type": "string",
1790
+ "description": "The unique ID of the function tool call output. Populated when this item is returned via API."
1791
+ },
1792
+ "call_id": {
1793
+ "type": "string",
1794
+ "description": "The unique ID of the function tool call generated by the model."
1795
+ },
1796
+ "output": {
1797
+ "oneOf": [
1798
+ {
1799
+ "type": "string",
1800
+ "description": "A JSON string of the output of the function tool call."
1801
+ },
1802
+ {
1803
+ "items": {
1804
+ "oneOf": [
1805
+ {
1806
+ "$ref": "#/components/schemas/InputTextContent"
1807
+ },
1808
+ {
1809
+ "$ref": "#/components/schemas/InputImageContent"
1810
+ },
1811
+ {
1812
+ "$ref": "#/components/schemas/InputFileContent"
1813
+ }
1814
+ ],
1815
+ "description": "A content part that makes up an input or output item.",
1816
+ "discriminator": {
1817
+ "propertyName": "type"
1818
+ }
1819
+ },
1820
+ "type": "array",
1821
+ "description": "An array of output contents (images, files, text) for the function tool call."
1822
+ }
1823
+ ]
1824
+ },
1825
+ "status": {
1826
+ "allOf": [
1827
+ {
1828
+ "$ref": "#/components/schemas/FunctionCallOutputStatusEnum"
1829
+ },
1830
+ {
1831
+ "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."
1832
+ }
1833
+ ]
1834
+ }
1835
+ },
1836
+ "type": "object",
1837
+ "required": ["type", "id", "call_id", "output", "status"],
1838
+ "title": "Function call output",
1839
+ "description": "A function tool call output that was returned by the tool."
1840
+ },
1841
+ "ReasoningBody": {
1842
+ "properties": {
1843
+ "type": {
1844
+ "type": "string",
1845
+ "enum": ["reasoning"],
1846
+ "description": "The type of the item. Always `reasoning`.",
1847
+ "default": "reasoning"
1848
+ },
1849
+ "id": {
1850
+ "type": "string",
1851
+ "description": "The unique ID of the reasoning item."
1852
+ },
1853
+ "content": {
1854
+ "items": {
1855
+ "oneOf": [
1856
+ {
1857
+ "$ref": "#/components/schemas/InputTextContent"
1858
+ },
1859
+ {
1860
+ "$ref": "#/components/schemas/OutputTextContent"
1861
+ },
1862
+ {
1863
+ "$ref": "#/components/schemas/TextContent"
1864
+ },
1865
+ {
1866
+ "$ref": "#/components/schemas/SummaryTextContent"
1867
+ },
1868
+ {
1869
+ "$ref": "#/components/schemas/ReasoningTextContent"
1870
+ },
1871
+ {
1872
+ "$ref": "#/components/schemas/RefusalContent"
1873
+ },
1874
+ {
1875
+ "$ref": "#/components/schemas/InputImageContent"
1876
+ },
1877
+ {
1878
+ "$ref": "#/components/schemas/InputFileContent"
1879
+ }
1880
+ ],
1881
+ "description": "A content part that makes up an input or output item.",
1882
+ "discriminator": {
1883
+ "propertyName": "type"
1884
+ }
1885
+ },
1886
+ "type": "array",
1887
+ "description": "The reasoning content that was generated."
1888
+ },
1889
+ "summary": {
1890
+ "items": {
1891
+ "oneOf": [
1892
+ {
1893
+ "$ref": "#/components/schemas/InputTextContent"
1894
+ },
1895
+ {
1896
+ "$ref": "#/components/schemas/OutputTextContent"
1897
+ },
1898
+ {
1899
+ "$ref": "#/components/schemas/TextContent"
1900
+ },
1901
+ {
1902
+ "$ref": "#/components/schemas/SummaryTextContent"
1903
+ },
1904
+ {
1905
+ "$ref": "#/components/schemas/ReasoningTextContent"
1906
+ },
1907
+ {
1908
+ "$ref": "#/components/schemas/RefusalContent"
1909
+ },
1910
+ {
1911
+ "$ref": "#/components/schemas/InputImageContent"
1912
+ },
1913
+ {
1914
+ "$ref": "#/components/schemas/InputFileContent"
1915
+ }
1916
+ ],
1917
+ "description": "A content part that makes up an input or output item.",
1918
+ "discriminator": {
1919
+ "propertyName": "type"
1920
+ }
1921
+ },
1922
+ "type": "array",
1923
+ "description": "The reasoning summary content that was generated."
1924
+ },
1925
+ "encrypted_content": {
1926
+ "type": "string",
1927
+ "description": "The encrypted reasoning content that was generated."
1928
+ }
1929
+ },
1930
+ "type": "object",
1931
+ "required": ["type", "id", "summary"],
1932
+ "title": "Reasoning item",
1933
+ "description": "A reasoning item that was generated by the model."
1934
+ },
1935
+ "ItemField": {
1936
+ "oneOf": [
1937
+ {
1938
+ "$ref": "#/components/schemas/Message"
1939
+ },
1940
+ {
1941
+ "$ref": "#/components/schemas/FunctionCall"
1942
+ },
1943
+ {
1944
+ "$ref": "#/components/schemas/FunctionCallOutput"
1945
+ },
1946
+ {
1947
+ "$ref": "#/components/schemas/ReasoningBody"
1948
+ }
1949
+ ],
1950
+ "description": "An item representing a message, tool call, tool output, reasoning, or other response element.",
1951
+ "discriminator": {
1952
+ "propertyName": "type"
1953
+ }
1954
+ },
1955
+ "Error": {
1956
+ "properties": {
1957
+ "code": {
1958
+ "type": "string",
1959
+ "description": "A machine-readable error code that was returned."
1960
+ },
1961
+ "message": {
1962
+ "type": "string",
1963
+ "description": "A human-readable description of the error that was returned."
1964
+ }
1965
+ },
1966
+ "type": "object",
1967
+ "required": ["code", "message"],
1968
+ "title": "Error",
1969
+ "description": "An error that occurred while generating the response."
1970
+ },
1971
+ "FunctionTool": {
1972
+ "properties": {
1973
+ "type": {
1974
+ "type": "string",
1975
+ "enum": ["function"],
1976
+ "description": "The type of the function tool. Always `function`.",
1977
+ "default": "function"
1978
+ },
1979
+ "name": {
1980
+ "type": "string",
1981
+ "description": "The name of the function to call."
1982
+ },
1983
+ "description": {
1984
+ "anyOf": [
1985
+ {
1986
+ "type": "string",
1987
+ "description": "A description of the function. Used by the model to determine whether or not to call the function."
1988
+ },
1989
+ {
1990
+ "type": "null"
1991
+ }
1992
+ ]
1993
+ },
1994
+ "parameters": {
1995
+ "anyOf": [
1996
+ {
1997
+ "additionalProperties": {},
1998
+ "type": "object",
1999
+ "description": "A JSON schema object describing the parameters of the function."
2000
+ },
2001
+ {
2002
+ "type": "null"
2003
+ }
2004
+ ]
2005
+ },
2006
+ "strict": {
2007
+ "anyOf": [
2008
+ {
2009
+ "type": "boolean",
2010
+ "description": "Whether to enforce strict parameter validation. Default `true`."
2011
+ },
2012
+ {
2013
+ "type": "null"
2014
+ }
2015
+ ]
2016
+ }
2017
+ },
2018
+ "type": "object",
2019
+ "required": ["type", "name", "description", "parameters", "strict"],
2020
+ "title": "Function",
2021
+ "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)."
2022
+ },
2023
+ "Tool": {
2024
+ "oneOf": [
2025
+ {
2026
+ "$ref": "#/components/schemas/FunctionTool"
2027
+ }
2028
+ ],
2029
+ "description": "A tool that can be used to generate a response.",
2030
+ "discriminator": {
2031
+ "propertyName": "type"
2032
+ }
2033
+ },
2034
+ "FunctionToolChoice": {
2035
+ "properties": {
2036
+ "type": {
2037
+ "type": "string",
2038
+ "enum": ["function"],
2039
+ "default": "function"
2040
+ },
2041
+ "name": {
2042
+ "type": "string"
2043
+ }
2044
+ },
2045
+ "type": "object",
2046
+ "required": ["type"]
2047
+ },
2048
+ "AllowedToolChoice": {
2049
+ "properties": {
2050
+ "type": {
2051
+ "type": "string",
2052
+ "enum": ["allowed_tools"],
2053
+ "default": "allowed_tools"
2054
+ },
2055
+ "tools": {
2056
+ "items": {
2057
+ "oneOf": [
2058
+ {
2059
+ "$ref": "#/components/schemas/FunctionToolChoice"
2060
+ }
2061
+ ]
2062
+ },
2063
+ "type": "array"
2064
+ },
2065
+ "mode": {
2066
+ "$ref": "#/components/schemas/ToolChoiceValueEnum"
2067
+ }
2068
+ },
2069
+ "type": "object",
2070
+ "required": ["type", "tools", "mode"]
2071
+ },
2072
+ "TextResponseFormat": {
2073
+ "properties": {
2074
+ "type": {
2075
+ "type": "string",
2076
+ "enum": ["text"],
2077
+ "default": "text"
2078
+ }
2079
+ },
2080
+ "type": "object",
2081
+ "required": ["type"]
2082
+ },
2083
+ "JsonObjectResponseFormat": {
2084
+ "properties": {
2085
+ "type": {
2086
+ "type": "string",
2087
+ "enum": ["json_object"],
2088
+ "default": "json_object"
2089
+ }
2090
+ },
2091
+ "type": "object",
2092
+ "required": ["type"]
2093
+ },
2094
+ "JsonSchemaResponseFormat": {
2095
+ "properties": {
2096
+ "type": {
2097
+ "type": "string",
2098
+ "enum": ["json_schema"],
2099
+ "default": "json_schema"
2100
+ },
2101
+ "name": {
2102
+ "type": "string"
2103
+ },
2104
+ "description": {
2105
+ "anyOf": [
2106
+ {
2107
+ "type": "string"
2108
+ },
2109
+ {
2110
+ "type": "null"
2111
+ }
2112
+ ]
2113
+ },
2114
+ "schema": {
2115
+ "anyOf": [
2116
+ {
2117
+ "type": "null"
2118
+ }
2119
+ ]
2120
+ },
2121
+ "strict": {
2122
+ "type": "boolean"
2123
+ }
2124
+ },
2125
+ "type": "object",
2126
+ "required": ["type", "name", "description", "schema", "strict"]
2127
+ },
2128
+ "TextField": {
2129
+ "properties": {
2130
+ "format": {
2131
+ "oneOf": [
2132
+ {
2133
+ "$ref": "#/components/schemas/TextResponseFormat"
2134
+ },
2135
+ {
2136
+ "$ref": "#/components/schemas/JsonObjectResponseFormat"
2137
+ },
2138
+ {
2139
+ "$ref": "#/components/schemas/JsonSchemaResponseFormat"
2140
+ }
2141
+ ]
2142
+ },
2143
+ "verbosity": {
2144
+ "$ref": "#/components/schemas/VerbosityEnum"
2145
+ }
2146
+ },
2147
+ "type": "object",
2148
+ "required": ["format"]
2149
+ },
2150
+ "Reasoning": {
2151
+ "properties": {
2152
+ "effort": {
2153
+ "anyOf": [
2154
+ {
2155
+ "oneOf": [
2156
+ {
2157
+ "$ref": "#/components/schemas/ReasoningEffortEnum"
2158
+ }
2159
+ ],
2160
+ "description": "The reasoning effort that was requested for the model, if specified."
2161
+ },
2162
+ {
2163
+ "type": "null"
2164
+ }
2165
+ ]
2166
+ },
2167
+ "summary": {
2168
+ "anyOf": [
2169
+ {
2170
+ "allOf": [
2171
+ {
2172
+ "$ref": "#/components/schemas/ReasoningSummaryEnum"
2173
+ },
2174
+ {
2175
+ "description": "A model-generated summary of its reasoning that was produced, if available."
2176
+ }
2177
+ ]
2178
+ },
2179
+ {
2180
+ "type": "null"
2181
+ }
2182
+ ]
2183
+ }
2184
+ },
2185
+ "type": "object",
2186
+ "required": ["effort", "summary"],
2187
+ "title": "Reasoning",
2188
+ "description": "Reasoning configuration and metadata that were used for the response."
2189
+ },
2190
+ "InputTokensDetails": {
2191
+ "properties": {
2192
+ "cached_tokens": {
2193
+ "type": "integer",
2194
+ "description": "The number of input tokens that were served from cache."
2195
+ }
2196
+ },
2197
+ "type": "object",
2198
+ "required": ["cached_tokens"],
2199
+ "title": "Input tokens details",
2200
+ "description": "A breakdown of input token usage that was recorded."
2201
+ },
2202
+ "OutputTokensDetails": {
2203
+ "properties": {
2204
+ "reasoning_tokens": {
2205
+ "type": "integer",
2206
+ "description": "The number of output tokens that were attributed to reasoning."
2207
+ }
2208
+ },
2209
+ "type": "object",
2210
+ "required": ["reasoning_tokens"],
2211
+ "title": "Output tokens details",
2212
+ "description": "A breakdown of output token usage that was recorded."
2213
+ },
2214
+ "Usage": {
2215
+ "properties": {
2216
+ "input_tokens": {
2217
+ "type": "integer",
2218
+ "description": "The number of input tokens that were used to generate the response."
2219
+ },
2220
+ "output_tokens": {
2221
+ "type": "integer",
2222
+ "description": "The number of output tokens that were generated by the model."
2223
+ },
2224
+ "total_tokens": {
2225
+ "type": "integer",
2226
+ "description": "The total number of tokens that were used."
2227
+ },
2228
+ "input_tokens_details": {
2229
+ "allOf": [
2230
+ {
2231
+ "$ref": "#/components/schemas/InputTokensDetails"
2232
+ },
2233
+ {
2234
+ "description": "A breakdown of input token usage that was recorded."
2235
+ }
2236
+ ]
2237
+ },
2238
+ "output_tokens_details": {
2239
+ "allOf": [
2240
+ {
2241
+ "$ref": "#/components/schemas/OutputTokensDetails"
2242
+ },
2243
+ {
2244
+ "description": "A breakdown of output token usage that was recorded."
2245
+ }
2246
+ ]
2247
+ }
2248
+ },
2249
+ "type": "object",
2250
+ "required": [
2251
+ "input_tokens",
2252
+ "output_tokens",
2253
+ "total_tokens",
2254
+ "input_tokens_details",
2255
+ "output_tokens_details"
2256
+ ],
2257
+ "title": "Usage",
2258
+ "description": "Token usage statistics that were recorded for the response."
2259
+ },
2260
+ "ResponseResource": {
2261
+ "properties": {
2262
+ "id": {
2263
+ "type": "string",
2264
+ "description": "The unique ID of the response that was created."
2265
+ },
2266
+ "object": {
2267
+ "type": "string",
2268
+ "enum": ["response"],
2269
+ "description": "The object type, which was always `response`.",
2270
+ "default": "response"
2271
+ },
2272
+ "created_at": {
2273
+ "type": "integer",
2274
+ "description": "The Unix timestamp (in seconds) for when the response was created."
2275
+ },
2276
+ "completed_at": {
2277
+ "anyOf": [
2278
+ {
2279
+ "type": "integer",
2280
+ "description": "The Unix timestamp (in seconds) for when the response was completed, if it was completed."
2281
+ },
2282
+ {
2283
+ "type": "null"
2284
+ }
2285
+ ]
2286
+ },
2287
+ "status": {
2288
+ "type": "string",
2289
+ "description": "The status that was set for the response."
2290
+ },
2291
+ "incomplete_details": {
2292
+ "anyOf": [
2293
+ {
2294
+ "allOf": [
2295
+ {
2296
+ "$ref": "#/components/schemas/IncompleteDetails"
2297
+ },
2298
+ {
2299
+ "description": "Details about why the response was incomplete, if applicable."
2300
+ }
2301
+ ]
2302
+ },
2303
+ {
2304
+ "type": "null"
2305
+ }
2306
+ ]
2307
+ },
2308
+ "model": {
2309
+ "type": "string",
2310
+ "description": "The model that generated this response."
2311
+ },
2312
+ "previous_response_id": {
2313
+ "anyOf": [
2314
+ {
2315
+ "type": "string",
2316
+ "description": "The ID of the previous response in the chain that was referenced, if any."
2317
+ },
2318
+ {
2319
+ "type": "null"
2320
+ }
2321
+ ]
2322
+ },
2323
+ "instructions": {
2324
+ "anyOf": [
2325
+ {
2326
+ "oneOf": [
2327
+ {
2328
+ "type": "string"
2329
+ }
2330
+ ],
2331
+ "description": "Additional instructions that were used to guide the model for this response."
2332
+ },
2333
+ {
2334
+ "type": "null"
2335
+ }
2336
+ ]
2337
+ },
2338
+ "output": {
2339
+ "items": {
2340
+ "$ref": "#/components/schemas/ItemField"
2341
+ },
2342
+ "type": "array",
2343
+ "description": "The output items that were generated by the model."
2344
+ },
2345
+ "error": {
2346
+ "anyOf": [
2347
+ {
2348
+ "allOf": [
2349
+ {
2350
+ "$ref": "#/components/schemas/Error"
2351
+ },
2352
+ {
2353
+ "description": "The error that occurred, if the response failed."
2354
+ }
2355
+ ]
2356
+ },
2357
+ {
2358
+ "type": "null"
2359
+ }
2360
+ ]
2361
+ },
2362
+ "tools": {
2363
+ "items": {
2364
+ "$ref": "#/components/schemas/Tool"
2365
+ },
2366
+ "type": "array",
2367
+ "description": "The tools that were available to the model during response generation."
2368
+ },
2369
+ "tool_choice": {
2370
+ "oneOf": [
2371
+ {
2372
+ "$ref": "#/components/schemas/FunctionToolChoice"
2373
+ },
2374
+ {
2375
+ "$ref": "#/components/schemas/ToolChoiceValueEnum"
2376
+ },
2377
+ {
2378
+ "$ref": "#/components/schemas/AllowedToolChoice"
2379
+ }
2380
+ ]
2381
+ },
2382
+ "truncation": {
2383
+ "allOf": [
2384
+ {
2385
+ "$ref": "#/components/schemas/TruncationEnum"
2386
+ },
2387
+ {
2388
+ "description": "How the input was truncated by the service when it exceeded the model context window."
2389
+ }
2390
+ ]
2391
+ },
2392
+ "parallel_tool_calls": {
2393
+ "type": "boolean",
2394
+ "description": "Whether the model was allowed to call multiple tools in parallel."
2395
+ },
2396
+ "text": {
2397
+ "allOf": [
2398
+ {
2399
+ "$ref": "#/components/schemas/TextField"
2400
+ },
2401
+ {
2402
+ "description": "Configuration options for text output that were used."
2403
+ }
2404
+ ]
2405
+ },
2406
+ "top_p": {
2407
+ "type": "number",
2408
+ "description": "The nucleus sampling parameter that was used for this response."
2409
+ },
2410
+ "presence_penalty": {
2411
+ "type": "number",
2412
+ "description": "The presence penalty that was used to penalize new tokens based on whether they appear in the text so far."
2413
+ },
2414
+ "frequency_penalty": {
2415
+ "type": "number",
2416
+ "description": "The frequency penalty that was used to penalize new tokens based on their frequency in the text so far."
2417
+ },
2418
+ "top_logprobs": {
2419
+ "type": "integer",
2420
+ "description": "The number of most likely tokens that were returned at each position, along with their log probabilities."
2421
+ },
2422
+ "temperature": {
2423
+ "type": "number",
2424
+ "description": "The sampling temperature that was used for this response."
2425
+ },
2426
+ "reasoning": {
2427
+ "anyOf": [
2428
+ {
2429
+ "allOf": [
2430
+ {
2431
+ "$ref": "#/components/schemas/Reasoning"
2432
+ },
2433
+ {
2434
+ "description": "Reasoning configuration and outputs that were produced for this response."
2435
+ }
2436
+ ]
2437
+ },
2438
+ {
2439
+ "type": "null"
2440
+ }
2441
+ ]
2442
+ },
2443
+ "usage": {
2444
+ "anyOf": [
2445
+ {
2446
+ "allOf": [
2447
+ {
2448
+ "$ref": "#/components/schemas/Usage"
2449
+ },
2450
+ {
2451
+ "description": "Token usage statistics that were recorded for the response, if available."
2452
+ }
2453
+ ]
2454
+ },
2455
+ {
2456
+ "type": "null"
2457
+ }
2458
+ ]
2459
+ },
2460
+ "max_output_tokens": {
2461
+ "anyOf": [
2462
+ {
2463
+ "type": "integer",
2464
+ "description": "The maximum number of tokens the model was allowed to generate for this response."
2465
+ },
2466
+ {
2467
+ "type": "null"
2468
+ }
2469
+ ]
2470
+ },
2471
+ "max_tool_calls": {
2472
+ "anyOf": [
2473
+ {
2474
+ "type": "integer",
2475
+ "description": "The maximum number of tool calls the model was allowed to make while generating the response."
2476
+ },
2477
+ {
2478
+ "type": "null"
2479
+ }
2480
+ ]
2481
+ },
2482
+ "store": {
2483
+ "type": "boolean",
2484
+ "description": "Whether this response was stored so it can be retrieved later."
2485
+ },
2486
+ "background": {
2487
+ "type": "boolean",
2488
+ "description": "Whether this request was run in the background."
2489
+ },
2490
+ "service_tier": {
2491
+ "type": "string",
2492
+ "description": "The service tier that was used for this response."
2493
+ },
2494
+ "metadata": {
2495
+ "description": "Developer-defined metadata that was associated with the response."
2496
+ },
2497
+ "safety_identifier": {
2498
+ "anyOf": [
2499
+ {
2500
+ "type": "string",
2501
+ "description": "A stable identifier that was used for safety monitoring and abuse detection."
2502
+ },
2503
+ {
2504
+ "type": "null"
2505
+ }
2506
+ ]
2507
+ },
2508
+ "prompt_cache_key": {
2509
+ "anyOf": [
2510
+ {
2511
+ "type": "string",
2512
+ "description": "A key that was used to read from or write to the prompt cache."
2513
+ },
2514
+ {
2515
+ "type": "null"
2516
+ }
2517
+ ]
2518
+ }
2519
+ },
2520
+ "type": "object",
2521
+ "required": [
2522
+ "id",
2523
+ "object",
2524
+ "created_at",
2525
+ "completed_at",
2526
+ "status",
2527
+ "incomplete_details",
2528
+ "model",
2529
+ "previous_response_id",
2530
+ "instructions",
2531
+ "output",
2532
+ "error",
2533
+ "tools",
2534
+ "tool_choice",
2535
+ "truncation",
2536
+ "parallel_tool_calls",
2537
+ "text",
2538
+ "top_p",
2539
+ "presence_penalty",
2540
+ "frequency_penalty",
2541
+ "top_logprobs",
2542
+ "temperature",
2543
+ "reasoning",
2544
+ "usage",
2545
+ "max_output_tokens",
2546
+ "max_tool_calls",
2547
+ "store",
2548
+ "background",
2549
+ "service_tier",
2550
+ "metadata",
2551
+ "safety_identifier",
2552
+ "prompt_cache_key"
2553
+ ],
2554
+ "title": "The response object",
2555
+ "description": "The complete response object that was returned by the Responses API.",
2556
+ "example": {
2557
+ "id": "resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41",
2558
+ "object": "response",
2559
+ "created_at": 1741476777,
2560
+ "status": "completed",
2561
+ "completed_at": 1741476778,
2562
+ "model": "gpt-4o-2024-08-06",
2563
+ "output": [
2564
+ {
2565
+ "type": "message",
2566
+ "id": "msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41",
2567
+ "status": "completed",
2568
+ "role": "assistant",
2569
+ "content": [
2570
+ {
2571
+ "type": "output_text",
2572
+ "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.",
2573
+ "annotations": []
2574
+ }
2575
+ ]
2576
+ }
2577
+ ],
2578
+ "parallel_tool_calls": true,
2579
+ "reasoning": {},
2580
+ "store": true,
2581
+ "background": false,
2582
+ "temperature": 1,
2583
+ "presence_penalty": 0,
2584
+ "frequency_penalty": 0,
2585
+ "text": {
2586
+ "format": {
2587
+ "type": "text"
2588
+ }
2589
+ },
2590
+ "tool_choice": "auto",
2591
+ "tools": [],
2592
+ "top_p": 1,
2593
+ "truncation": "disabled",
2594
+ "usage": {
2595
+ "input_tokens": 328,
2596
+ "input_tokens_details": {
2597
+ "cached_tokens": 0
2598
+ },
2599
+ "output_tokens": 52,
2600
+ "output_tokens_details": {
2601
+ "reasoning_tokens": 0
2602
+ },
2603
+ "total_tokens": 380
2604
+ },
2605
+ "metadata": {}
2606
+ }
2607
+ },
2608
+ "ResponseCreatedStreamingEvent": {
2609
+ "properties": {
2610
+ "type": {
2611
+ "type": "string",
2612
+ "enum": ["response.created"],
2613
+ "description": "The type of the event, always `response.created`.",
2614
+ "default": "response.created"
2615
+ },
2616
+ "sequence_number": {
2617
+ "type": "integer",
2618
+ "description": "The sequence number of the event that was emitted."
2619
+ },
2620
+ "response": {
2621
+ "allOf": [
2622
+ {
2623
+ "$ref": "#/components/schemas/ResponseResource"
2624
+ },
2625
+ {
2626
+ "description": "The response snapshot that was emitted with the event."
2627
+ }
2628
+ ]
2629
+ }
2630
+ },
2631
+ "type": "object",
2632
+ "required": ["type", "sequence_number", "response"],
2633
+ "title": "Response created event",
2634
+ "description": "A streaming event that indicated the response was created."
2635
+ },
2636
+ "ResponseQueuedStreamingEvent": {
2637
+ "properties": {
2638
+ "type": {
2639
+ "type": "string",
2640
+ "enum": ["response.queued"],
2641
+ "description": "The type of the event, always `response.queued`.",
2642
+ "default": "response.queued"
2643
+ },
2644
+ "sequence_number": {
2645
+ "type": "integer",
2646
+ "description": "The sequence number of the event that was emitted."
2647
+ },
2648
+ "response": {
2649
+ "allOf": [
2650
+ {
2651
+ "$ref": "#/components/schemas/ResponseResource"
2652
+ },
2653
+ {
2654
+ "description": "The response snapshot that was emitted with the event."
2655
+ }
2656
+ ]
2657
+ }
2658
+ },
2659
+ "type": "object",
2660
+ "required": ["type", "sequence_number", "response"],
2661
+ "title": "Response queued event",
2662
+ "description": "A streaming event that indicated the response was queued."
2663
+ },
2664
+ "ResponseInProgressStreamingEvent": {
2665
+ "properties": {
2666
+ "type": {
2667
+ "type": "string",
2668
+ "enum": ["response.in_progress"],
2669
+ "description": "The type of the event, always `response.in_progress`.",
2670
+ "default": "response.in_progress"
2671
+ },
2672
+ "sequence_number": {
2673
+ "type": "integer",
2674
+ "description": "The sequence number of the event that was emitted."
2675
+ },
2676
+ "response": {
2677
+ "allOf": [
2678
+ {
2679
+ "$ref": "#/components/schemas/ResponseResource"
2680
+ },
2681
+ {
2682
+ "description": "The response snapshot that was emitted with the event."
2683
+ }
2684
+ ]
2685
+ }
2686
+ },
2687
+ "type": "object",
2688
+ "required": ["type", "sequence_number", "response"],
2689
+ "title": "Response in progress event",
2690
+ "description": "A streaming event that indicated the response was in progress."
2691
+ },
2692
+ "ResponseCompletedStreamingEvent": {
2693
+ "properties": {
2694
+ "type": {
2695
+ "type": "string",
2696
+ "enum": ["response.completed"],
2697
+ "description": "The type of the event, always `response.completed`.",
2698
+ "default": "response.completed"
2699
+ },
2700
+ "sequence_number": {
2701
+ "type": "integer",
2702
+ "description": "The sequence number of the event that was emitted."
2703
+ },
2704
+ "response": {
2705
+ "allOf": [
2706
+ {
2707
+ "$ref": "#/components/schemas/ResponseResource"
2708
+ },
2709
+ {
2710
+ "description": "The response snapshot that was emitted with the event."
2711
+ }
2712
+ ]
2713
+ }
2714
+ },
2715
+ "type": "object",
2716
+ "required": ["type", "sequence_number", "response"],
2717
+ "title": "Response completed event",
2718
+ "description": "A streaming event that indicated the response was completed."
2719
+ },
2720
+ "ResponseFailedStreamingEvent": {
2721
+ "properties": {
2722
+ "type": {
2723
+ "type": "string",
2724
+ "enum": ["response.failed"],
2725
+ "description": "The type of the event, always `response.failed`.",
2726
+ "default": "response.failed"
2727
+ },
2728
+ "sequence_number": {
2729
+ "type": "integer",
2730
+ "description": "The sequence number of the event that was emitted."
2731
+ },
2732
+ "response": {
2733
+ "allOf": [
2734
+ {
2735
+ "$ref": "#/components/schemas/ResponseResource"
2736
+ },
2737
+ {
2738
+ "description": "The response snapshot that was emitted with the event."
2739
+ }
2740
+ ]
2741
+ }
2742
+ },
2743
+ "type": "object",
2744
+ "required": ["type", "sequence_number", "response"],
2745
+ "title": "Response failed event",
2746
+ "description": "A streaming event that indicated the response had failed."
2747
+ },
2748
+ "ResponseIncompleteStreamingEvent": {
2749
+ "properties": {
2750
+ "type": {
2751
+ "type": "string",
2752
+ "enum": ["response.incomplete"],
2753
+ "description": "The type of the event, always `response.incomplete`.",
2754
+ "default": "response.incomplete"
2755
+ },
2756
+ "sequence_number": {
2757
+ "type": "integer",
2758
+ "description": "The sequence number of the event that was emitted."
2759
+ },
2760
+ "response": {
2761
+ "allOf": [
2762
+ {
2763
+ "$ref": "#/components/schemas/ResponseResource"
2764
+ },
2765
+ {
2766
+ "description": "The response snapshot that was emitted with the event."
2767
+ }
2768
+ ]
2769
+ }
2770
+ },
2771
+ "type": "object",
2772
+ "required": ["type", "sequence_number", "response"],
2773
+ "title": "Response incomplete event",
2774
+ "description": "A streaming event that indicated the response was incomplete."
2775
+ },
2776
+ "ResponseOutputItemAddedStreamingEvent": {
2777
+ "properties": {
2778
+ "type": {
2779
+ "type": "string",
2780
+ "enum": ["response.output_item.added"],
2781
+ "description": "The type of the event, always `response.output_item.added`.",
2782
+ "default": "response.output_item.added"
2783
+ },
2784
+ "sequence_number": {
2785
+ "type": "integer",
2786
+ "description": "The sequence number of the event that was emitted."
2787
+ },
2788
+ "output_index": {
2789
+ "type": "integer",
2790
+ "description": "The index of the output item that was added."
2791
+ },
2792
+ "item": {
2793
+ "anyOf": [
2794
+ {
2795
+ "allOf": [
2796
+ {
2797
+ "$ref": "#/components/schemas/ItemField"
2798
+ },
2799
+ {
2800
+ "description": "An item representing a message, tool call, tool output, reasoning, or other response element."
2801
+ }
2802
+ ]
2803
+ },
2804
+ {
2805
+ "type": "null"
2806
+ }
2807
+ ]
2808
+ }
2809
+ },
2810
+ "type": "object",
2811
+ "required": ["type", "sequence_number", "output_index", "item"],
2812
+ "title": "Response output item added event",
2813
+ "description": "A streaming event that indicated an output item was added to the response."
2814
+ },
2815
+ "ResponseOutputItemDoneStreamingEvent": {
2816
+ "properties": {
2817
+ "type": {
2818
+ "type": "string",
2819
+ "enum": ["response.output_item.done"],
2820
+ "description": "The type of the event, always `response.output_item.done`.",
2821
+ "default": "response.output_item.done"
2822
+ },
2823
+ "sequence_number": {
2824
+ "type": "integer",
2825
+ "description": "The sequence number of the event that was emitted."
2826
+ },
2827
+ "output_index": {
2828
+ "type": "integer",
2829
+ "description": "The index of the output item that was completed."
2830
+ },
2831
+ "item": {
2832
+ "anyOf": [
2833
+ {
2834
+ "allOf": [
2835
+ {
2836
+ "$ref": "#/components/schemas/ItemField"
2837
+ },
2838
+ {
2839
+ "description": "An item representing a message, tool call, tool output, reasoning, or other response element."
2840
+ }
2841
+ ]
2842
+ },
2843
+ {
2844
+ "type": "null"
2845
+ }
2846
+ ]
2847
+ }
2848
+ },
2849
+ "type": "object",
2850
+ "required": ["type", "sequence_number", "output_index", "item"],
2851
+ "title": "Response output item done event",
2852
+ "description": "A streaming event that indicated an output item was completed."
2853
+ },
2854
+ "ResponseReasoningSummaryPartAddedStreamingEvent": {
2855
+ "properties": {
2856
+ "type": {
2857
+ "type": "string",
2858
+ "enum": ["response.reasoning_summary_part.added"],
2859
+ "description": "The type of the event, always `response.reasoning_summary_part.added`.",
2860
+ "default": "response.reasoning_summary_part.added"
2861
+ },
2862
+ "sequence_number": {
2863
+ "type": "integer",
2864
+ "description": "The sequence number of the event that was emitted."
2865
+ },
2866
+ "item_id": {
2867
+ "type": "string",
2868
+ "description": "The ID of the item that was updated."
2869
+ },
2870
+ "output_index": {
2871
+ "type": "integer",
2872
+ "description": "The index of the output item that was updated."
2873
+ },
2874
+ "summary_index": {
2875
+ "type": "integer",
2876
+ "description": "The index of the summary part that was added."
2877
+ },
2878
+ "part": {
2879
+ "oneOf": [
2880
+ {
2881
+ "$ref": "#/components/schemas/InputTextContent"
2882
+ },
2883
+ {
2884
+ "$ref": "#/components/schemas/OutputTextContent"
2885
+ },
2886
+ {
2887
+ "$ref": "#/components/schemas/TextContent"
2888
+ },
2889
+ {
2890
+ "$ref": "#/components/schemas/SummaryTextContent"
2891
+ },
2892
+ {
2893
+ "$ref": "#/components/schemas/ReasoningTextContent"
2894
+ },
2895
+ {
2896
+ "$ref": "#/components/schemas/RefusalContent"
2897
+ },
2898
+ {
2899
+ "$ref": "#/components/schemas/InputImageContent"
2900
+ },
2901
+ {
2902
+ "$ref": "#/components/schemas/InputFileContent"
2903
+ }
2904
+ ],
2905
+ "description": "A content part that makes up an input or output item.",
2906
+ "discriminator": {
2907
+ "propertyName": "type"
2908
+ }
2909
+ }
2910
+ },
2911
+ "type": "object",
2912
+ "required": [
2913
+ "type",
2914
+ "sequence_number",
2915
+ "item_id",
2916
+ "output_index",
2917
+ "summary_index",
2918
+ "part"
2919
+ ],
2920
+ "title": "Response reasoning summary part added event",
2921
+ "description": "A streaming event that indicated a reasoning summary part was added."
2922
+ },
2923
+ "ResponseReasoningSummaryPartDoneStreamingEvent": {
2924
+ "properties": {
2925
+ "type": {
2926
+ "type": "string",
2927
+ "enum": ["response.reasoning_summary_part.done"],
2928
+ "description": "The type of the event, always `response.reasoning_summary_part.done`.",
2929
+ "default": "response.reasoning_summary_part.done"
2930
+ },
2931
+ "sequence_number": {
2932
+ "type": "integer",
2933
+ "description": "The sequence number of the event that was emitted."
2934
+ },
2935
+ "item_id": {
2936
+ "type": "string",
2937
+ "description": "The ID of the item that was updated."
2938
+ },
2939
+ "output_index": {
2940
+ "type": "integer",
2941
+ "description": "The index of the output item that was updated."
2942
+ },
2943
+ "summary_index": {
2944
+ "type": "integer",
2945
+ "description": "The index of the summary part that was completed."
2946
+ },
2947
+ "part": {
2948
+ "oneOf": [
2949
+ {
2950
+ "$ref": "#/components/schemas/InputTextContent"
2951
+ },
2952
+ {
2953
+ "$ref": "#/components/schemas/OutputTextContent"
2954
+ },
2955
+ {
2956
+ "$ref": "#/components/schemas/TextContent"
2957
+ },
2958
+ {
2959
+ "$ref": "#/components/schemas/SummaryTextContent"
2960
+ },
2961
+ {
2962
+ "$ref": "#/components/schemas/ReasoningTextContent"
2963
+ },
2964
+ {
2965
+ "$ref": "#/components/schemas/RefusalContent"
2966
+ },
2967
+ {
2968
+ "$ref": "#/components/schemas/InputImageContent"
2969
+ },
2970
+ {
2971
+ "$ref": "#/components/schemas/InputFileContent"
2972
+ }
2973
+ ],
2974
+ "description": "A content part that makes up an input or output item.",
2975
+ "discriminator": {
2976
+ "propertyName": "type"
2977
+ }
2978
+ }
2979
+ },
2980
+ "type": "object",
2981
+ "required": [
2982
+ "type",
2983
+ "sequence_number",
2984
+ "item_id",
2985
+ "output_index",
2986
+ "summary_index",
2987
+ "part"
2988
+ ],
2989
+ "title": "Response reasoning summary part done event",
2990
+ "description": "A streaming event that indicated a reasoning summary part was completed."
2991
+ },
2992
+ "ResponseContentPartAddedStreamingEvent": {
2993
+ "properties": {
2994
+ "type": {
2995
+ "type": "string",
2996
+ "enum": ["response.content_part.added"],
2997
+ "description": "The type of the event, always `response.content_part.added`.",
2998
+ "default": "response.content_part.added"
2999
+ },
3000
+ "sequence_number": {
3001
+ "type": "integer",
3002
+ "description": "The sequence number of the event that was emitted."
3003
+ },
3004
+ "item_id": {
3005
+ "type": "string",
3006
+ "description": "The ID of the item that was updated."
3007
+ },
3008
+ "output_index": {
3009
+ "type": "integer",
3010
+ "description": "The index of the output item that was updated."
3011
+ },
3012
+ "content_index": {
3013
+ "type": "integer",
3014
+ "description": "The index of the content part that was added."
3015
+ },
3016
+ "part": {
3017
+ "oneOf": [
3018
+ {
3019
+ "$ref": "#/components/schemas/InputTextContent"
3020
+ },
3021
+ {
3022
+ "$ref": "#/components/schemas/OutputTextContent"
3023
+ },
3024
+ {
3025
+ "$ref": "#/components/schemas/TextContent"
3026
+ },
3027
+ {
3028
+ "$ref": "#/components/schemas/SummaryTextContent"
3029
+ },
3030
+ {
3031
+ "$ref": "#/components/schemas/ReasoningTextContent"
3032
+ },
3033
+ {
3034
+ "$ref": "#/components/schemas/RefusalContent"
3035
+ },
3036
+ {
3037
+ "$ref": "#/components/schemas/InputImageContent"
3038
+ },
3039
+ {
3040
+ "$ref": "#/components/schemas/InputFileContent"
3041
+ }
3042
+ ],
3043
+ "description": "A content part that makes up an input or output item.",
3044
+ "discriminator": {
3045
+ "propertyName": "type"
3046
+ }
3047
+ }
3048
+ },
3049
+ "type": "object",
3050
+ "required": [
3051
+ "type",
3052
+ "sequence_number",
3053
+ "item_id",
3054
+ "output_index",
3055
+ "content_index",
3056
+ "part"
3057
+ ],
3058
+ "title": "Response content part added event",
3059
+ "description": "A streaming event that indicated a content part was added."
3060
+ },
3061
+ "ResponseContentPartDoneStreamingEvent": {
3062
+ "properties": {
3063
+ "type": {
3064
+ "type": "string",
3065
+ "enum": ["response.content_part.done"],
3066
+ "description": "The type of the event, always `response.content_part.done`.",
3067
+ "default": "response.content_part.done"
3068
+ },
3069
+ "sequence_number": {
3070
+ "type": "integer",
3071
+ "description": "The sequence number of the event that was emitted."
3072
+ },
3073
+ "item_id": {
3074
+ "type": "string",
3075
+ "description": "The ID of the item that was updated."
3076
+ },
3077
+ "output_index": {
3078
+ "type": "integer",
3079
+ "description": "The index of the output item that was updated."
3080
+ },
3081
+ "content_index": {
3082
+ "type": "integer",
3083
+ "description": "The index of the content part that was completed."
3084
+ },
3085
+ "part": {
3086
+ "oneOf": [
3087
+ {
3088
+ "$ref": "#/components/schemas/InputTextContent"
3089
+ },
3090
+ {
3091
+ "$ref": "#/components/schemas/OutputTextContent"
3092
+ },
3093
+ {
3094
+ "$ref": "#/components/schemas/TextContent"
3095
+ },
3096
+ {
3097
+ "$ref": "#/components/schemas/SummaryTextContent"
3098
+ },
3099
+ {
3100
+ "$ref": "#/components/schemas/ReasoningTextContent"
3101
+ },
3102
+ {
3103
+ "$ref": "#/components/schemas/RefusalContent"
3104
+ },
3105
+ {
3106
+ "$ref": "#/components/schemas/InputImageContent"
3107
+ },
3108
+ {
3109
+ "$ref": "#/components/schemas/InputFileContent"
3110
+ }
3111
+ ],
3112
+ "description": "A content part that makes up an input or output item.",
3113
+ "discriminator": {
3114
+ "propertyName": "type"
3115
+ }
3116
+ }
3117
+ },
3118
+ "type": "object",
3119
+ "required": [
3120
+ "type",
3121
+ "sequence_number",
3122
+ "item_id",
3123
+ "output_index",
3124
+ "content_index",
3125
+ "part"
3126
+ ],
3127
+ "title": "Response content part done event",
3128
+ "description": "A streaming event that indicated a content part was completed."
3129
+ },
3130
+ "ResponseOutputTextDeltaStreamingEvent": {
3131
+ "properties": {
3132
+ "type": {
3133
+ "type": "string",
3134
+ "enum": ["response.output_text.delta"],
3135
+ "description": "The type of the event, always `response.output_text.delta`.",
3136
+ "default": "response.output_text.delta"
3137
+ },
3138
+ "sequence_number": {
3139
+ "type": "integer",
3140
+ "description": "The sequence number of the event that was emitted."
3141
+ },
3142
+ "item_id": {
3143
+ "type": "string",
3144
+ "description": "The ID of the item that was updated."
3145
+ },
3146
+ "output_index": {
3147
+ "type": "integer",
3148
+ "description": "The index of the output item that was updated."
3149
+ },
3150
+ "content_index": {
3151
+ "type": "integer",
3152
+ "description": "The index of the content part that was updated."
3153
+ },
3154
+ "delta": {
3155
+ "type": "string",
3156
+ "description": "The text delta that was appended."
3157
+ },
3158
+ "logprobs": {
3159
+ "items": {
3160
+ "$ref": "#/components/schemas/LogProb"
3161
+ },
3162
+ "type": "array",
3163
+ "description": "The token log probabilities that were emitted with the delta, if any."
3164
+ },
3165
+ "obfuscation": {
3166
+ "type": "string",
3167
+ "description": "An obfuscation string that was added to pad the event payload."
3168
+ }
3169
+ },
3170
+ "type": "object",
3171
+ "required": [
3172
+ "type",
3173
+ "sequence_number",
3174
+ "item_id",
3175
+ "output_index",
3176
+ "content_index",
3177
+ "delta",
3178
+ "logprobs"
3179
+ ],
3180
+ "title": "Response output text delta event",
3181
+ "description": "A streaming event that indicated output text was incrementally added."
3182
+ },
3183
+ "ResponseOutputTextDoneStreamingEvent": {
3184
+ "properties": {
3185
+ "type": {
3186
+ "type": "string",
3187
+ "enum": ["response.output_text.done"],
3188
+ "description": "The type of the event, always `response.output_text.done`.",
3189
+ "default": "response.output_text.done"
3190
+ },
3191
+ "sequence_number": {
3192
+ "type": "integer",
3193
+ "description": "The sequence number of the event that was emitted."
3194
+ },
3195
+ "item_id": {
3196
+ "type": "string",
3197
+ "description": "The ID of the item that was updated."
3198
+ },
3199
+ "output_index": {
3200
+ "type": "integer",
3201
+ "description": "The index of the output item that was updated."
3202
+ },
3203
+ "content_index": {
3204
+ "type": "integer",
3205
+ "description": "The index of the content part that was completed."
3206
+ },
3207
+ "text": {
3208
+ "type": "string",
3209
+ "description": "The final text that was emitted."
3210
+ },
3211
+ "logprobs": {
3212
+ "items": {
3213
+ "$ref": "#/components/schemas/LogProb"
3214
+ },
3215
+ "type": "array",
3216
+ "description": "The token log probabilities that were emitted with the final text, if any."
3217
+ }
3218
+ },
3219
+ "type": "object",
3220
+ "required": [
3221
+ "type",
3222
+ "sequence_number",
3223
+ "item_id",
3224
+ "output_index",
3225
+ "content_index",
3226
+ "text",
3227
+ "logprobs"
3228
+ ],
3229
+ "title": "Response output text done event",
3230
+ "description": "A streaming event that indicated output text was completed."
3231
+ },
3232
+ "ResponseRefusalDeltaStreamingEvent": {
3233
+ "properties": {
3234
+ "type": {
3235
+ "type": "string",
3236
+ "enum": ["response.refusal.delta"],
3237
+ "description": "The type of the event, always `response.refusal.delta`.",
3238
+ "default": "response.refusal.delta"
3239
+ },
3240
+ "sequence_number": {
3241
+ "type": "integer",
3242
+ "description": "The sequence number of the event that was emitted."
3243
+ },
3244
+ "item_id": {
3245
+ "type": "string",
3246
+ "description": "The ID of the item that was updated."
3247
+ },
3248
+ "output_index": {
3249
+ "type": "integer",
3250
+ "description": "The index of the output item that was updated."
3251
+ },
3252
+ "content_index": {
3253
+ "type": "integer",
3254
+ "description": "The index of the refusal content that was updated."
3255
+ },
3256
+ "delta": {
3257
+ "type": "string",
3258
+ "description": "The refusal text delta that was appended."
3259
+ }
3260
+ },
3261
+ "type": "object",
3262
+ "required": [
3263
+ "type",
3264
+ "sequence_number",
3265
+ "item_id",
3266
+ "output_index",
3267
+ "content_index",
3268
+ "delta"
3269
+ ],
3270
+ "title": "Response refusal delta event",
3271
+ "description": "A streaming event that indicated refusal text was incrementally added."
3272
+ },
3273
+ "ResponseRefusalDoneStreamingEvent": {
3274
+ "properties": {
3275
+ "type": {
3276
+ "type": "string",
3277
+ "enum": ["response.refusal.done"],
3278
+ "description": "The type of the event, always `response.refusal.done`.",
3279
+ "default": "response.refusal.done"
3280
+ },
3281
+ "sequence_number": {
3282
+ "type": "integer",
3283
+ "description": "The sequence number of the event that was emitted."
3284
+ },
3285
+ "item_id": {
3286
+ "type": "string",
3287
+ "description": "The ID of the item that was updated."
3288
+ },
3289
+ "output_index": {
3290
+ "type": "integer",
3291
+ "description": "The index of the output item that was updated."
3292
+ },
3293
+ "content_index": {
3294
+ "type": "integer",
3295
+ "description": "The index of the refusal content that was completed."
3296
+ },
3297
+ "refusal": {
3298
+ "type": "string",
3299
+ "description": "The final refusal text that was emitted."
3300
+ }
3301
+ },
3302
+ "type": "object",
3303
+ "required": [
3304
+ "type",
3305
+ "sequence_number",
3306
+ "item_id",
3307
+ "output_index",
3308
+ "content_index",
3309
+ "refusal"
3310
+ ],
3311
+ "title": "Response refusal done event",
3312
+ "description": "A streaming event that indicated refusal text was completed."
3313
+ },
3314
+ "ResponseReasoningDeltaStreamingEvent": {
3315
+ "properties": {
3316
+ "type": {
3317
+ "type": "string",
3318
+ "enum": ["response.reasoning.delta"],
3319
+ "description": "The type of the event, always `response.reasoning.delta`.",
3320
+ "default": "response.reasoning.delta"
3321
+ },
3322
+ "sequence_number": {
3323
+ "type": "integer",
3324
+ "description": "The sequence number of the event that was emitted."
3325
+ },
3326
+ "item_id": {
3327
+ "type": "string",
3328
+ "description": "The ID of the item that was updated."
3329
+ },
3330
+ "output_index": {
3331
+ "type": "integer",
3332
+ "description": "The index of the output item that was updated."
3333
+ },
3334
+ "content_index": {
3335
+ "type": "integer",
3336
+ "description": "The index of the reasoning content that was updated."
3337
+ },
3338
+ "delta": {
3339
+ "type": "string",
3340
+ "description": "The reasoning text delta that was appended."
3341
+ },
3342
+ "obfuscation": {
3343
+ "type": "string",
3344
+ "description": "An obfuscation string that was added to pad the event payload."
3345
+ }
3346
+ },
3347
+ "type": "object",
3348
+ "required": [
3349
+ "type",
3350
+ "sequence_number",
3351
+ "item_id",
3352
+ "output_index",
3353
+ "content_index",
3354
+ "delta"
3355
+ ],
3356
+ "title": "Response reasoning delta event",
3357
+ "description": "A streaming event that indicated reasoning text was incrementally added."
3358
+ },
3359
+ "ResponseReasoningDoneStreamingEvent": {
3360
+ "properties": {
3361
+ "type": {
3362
+ "type": "string",
3363
+ "enum": ["response.reasoning.done"],
3364
+ "description": "The type of the event, always `response.reasoning.done`.",
3365
+ "default": "response.reasoning.done"
3366
+ },
3367
+ "sequence_number": {
3368
+ "type": "integer",
3369
+ "description": "The sequence number of the event that was emitted."
3370
+ },
3371
+ "item_id": {
3372
+ "type": "string",
3373
+ "description": "The ID of the item that was updated."
3374
+ },
3375
+ "output_index": {
3376
+ "type": "integer",
3377
+ "description": "The index of the output item that was updated."
3378
+ },
3379
+ "content_index": {
3380
+ "type": "integer",
3381
+ "description": "The index of the reasoning content that was completed."
3382
+ },
3383
+ "text": {
3384
+ "type": "string",
3385
+ "description": "The final reasoning text that was emitted."
3386
+ }
3387
+ },
3388
+ "type": "object",
3389
+ "required": [
3390
+ "type",
3391
+ "sequence_number",
3392
+ "item_id",
3393
+ "output_index",
3394
+ "content_index",
3395
+ "text"
3396
+ ],
3397
+ "title": "Response reasoning done event",
3398
+ "description": "A streaming event that indicated reasoning text was completed."
3399
+ },
3400
+ "ResponseReasoningSummaryDeltaStreamingEvent": {
3401
+ "properties": {
3402
+ "type": {
3403
+ "type": "string",
3404
+ "enum": ["response.reasoning_summary_text.delta"],
3405
+ "description": "The type of the event, always `response.reasoning_summary.delta`.",
3406
+ "default": "response.reasoning_summary_text.delta"
3407
+ },
3408
+ "sequence_number": {
3409
+ "type": "integer",
3410
+ "description": "The sequence number of the event that was emitted."
3411
+ },
3412
+ "item_id": {
3413
+ "type": "string",
3414
+ "description": "The ID of the item that was updated."
3415
+ },
3416
+ "output_index": {
3417
+ "type": "integer",
3418
+ "description": "The index of the output item that was updated."
3419
+ },
3420
+ "summary_index": {
3421
+ "type": "integer",
3422
+ "description": "The index of the summary content that was updated."
3423
+ },
3424
+ "delta": {
3425
+ "type": "string",
3426
+ "description": "The summary text delta that was appended."
3427
+ },
3428
+ "obfuscation": {
3429
+ "type": "string",
3430
+ "description": "An obfuscation string that was added to pad the event payload."
3431
+ }
3432
+ },
3433
+ "type": "object",
3434
+ "required": [
3435
+ "type",
3436
+ "sequence_number",
3437
+ "item_id",
3438
+ "output_index",
3439
+ "summary_index",
3440
+ "delta"
3441
+ ],
3442
+ "title": "Response reasoning summary delta event",
3443
+ "description": "A streaming event that indicated a reasoning summary was incrementally added."
3444
+ },
3445
+ "ResponseReasoningSummaryDoneStreamingEvent": {
3446
+ "properties": {
3447
+ "type": {
3448
+ "type": "string",
3449
+ "enum": ["response.reasoning_summary_text.done"],
3450
+ "description": "The type of the event, always `response.reasoning_summary.done`.",
3451
+ "default": "response.reasoning_summary_text.done"
3452
+ },
3453
+ "sequence_number": {
3454
+ "type": "integer",
3455
+ "description": "The sequence number of the event that was emitted."
3456
+ },
3457
+ "item_id": {
3458
+ "type": "string",
3459
+ "description": "The ID of the item that was updated."
3460
+ },
3461
+ "output_index": {
3462
+ "type": "integer",
3463
+ "description": "The index of the output item that was updated."
3464
+ },
3465
+ "summary_index": {
3466
+ "type": "integer",
3467
+ "description": "The index of the summary content that was completed."
3468
+ },
3469
+ "text": {
3470
+ "type": "string",
3471
+ "description": "The final summary text that was emitted."
3472
+ }
3473
+ },
3474
+ "type": "object",
3475
+ "required": [
3476
+ "type",
3477
+ "sequence_number",
3478
+ "item_id",
3479
+ "output_index",
3480
+ "summary_index",
3481
+ "text"
3482
+ ],
3483
+ "title": "Response reasoning summary done event",
3484
+ "description": "A streaming event that indicated a reasoning summary was completed."
3485
+ },
3486
+ "ResponseOutputTextAnnotationAddedStreamingEvent": {
3487
+ "properties": {
3488
+ "type": {
3489
+ "type": "string",
3490
+ "enum": ["response.output_text.annotation.added"],
3491
+ "description": "The type of the event, always `response.output_text.annotation.added`.",
3492
+ "default": "response.output_text.annotation.added"
3493
+ },
3494
+ "sequence_number": {
3495
+ "type": "integer",
3496
+ "description": "The sequence number of the event that was emitted."
3497
+ },
3498
+ "item_id": {
3499
+ "type": "string",
3500
+ "description": "The ID of the item that was updated."
3501
+ },
3502
+ "output_index": {
3503
+ "type": "integer",
3504
+ "description": "The index of the output item that was updated."
3505
+ },
3506
+ "content_index": {
3507
+ "type": "integer",
3508
+ "description": "The index of the output text content that was updated."
3509
+ },
3510
+ "annotation_index": {
3511
+ "type": "integer",
3512
+ "description": "The index of the annotation that was added."
3513
+ },
3514
+ "annotation": {
3515
+ "anyOf": [
3516
+ {
3517
+ "allOf": [
3518
+ {
3519
+ "$ref": "#/components/schemas/Annotation"
3520
+ },
3521
+ {
3522
+ "description": "An annotation that applies to a span of output text."
3523
+ }
3524
+ ]
3525
+ },
3526
+ {
3527
+ "type": "null"
3528
+ }
3529
+ ]
3530
+ }
3531
+ },
3532
+ "type": "object",
3533
+ "required": [
3534
+ "type",
3535
+ "sequence_number",
3536
+ "item_id",
3537
+ "output_index",
3538
+ "content_index",
3539
+ "annotation_index",
3540
+ "annotation"
3541
+ ],
3542
+ "title": "Response output text annotation added event",
3543
+ "description": "A streaming event that indicated an output text annotation was added."
3544
+ },
3545
+ "ResponseFunctionCallArgumentsDeltaStreamingEvent": {
3546
+ "properties": {
3547
+ "type": {
3548
+ "type": "string",
3549
+ "enum": ["response.function_call_arguments.delta"],
3550
+ "description": "The type of the event, always `response.function_call_arguments.delta`.",
3551
+ "default": "response.function_call_arguments.delta"
3552
+ },
3553
+ "sequence_number": {
3554
+ "type": "integer",
3555
+ "description": "The sequence number of the event that was emitted."
3556
+ },
3557
+ "item_id": {
3558
+ "type": "string",
3559
+ "description": "The ID of the tool call item that was updated."
3560
+ },
3561
+ "output_index": {
3562
+ "type": "integer",
3563
+ "description": "The index of the output item that was updated."
3564
+ },
3565
+ "delta": {
3566
+ "type": "string",
3567
+ "description": "The arguments delta that was appended."
3568
+ },
3569
+ "obfuscation": {
3570
+ "type": "string",
3571
+ "description": "An obfuscation string that was added to pad the event payload."
3572
+ }
3573
+ },
3574
+ "type": "object",
3575
+ "required": [
3576
+ "type",
3577
+ "sequence_number",
3578
+ "item_id",
3579
+ "output_index",
3580
+ "delta"
3581
+ ],
3582
+ "title": "Response function call arguments delta event",
3583
+ "description": "A streaming event that indicated function call arguments were incrementally added."
3584
+ },
3585
+ "ResponseFunctionCallArgumentsDoneStreamingEvent": {
3586
+ "properties": {
3587
+ "type": {
3588
+ "type": "string",
3589
+ "enum": ["response.function_call_arguments.done"],
3590
+ "description": "The type of the event, always `response.function_call_arguments.done`.",
3591
+ "default": "response.function_call_arguments.done"
3592
+ },
3593
+ "sequence_number": {
3594
+ "type": "integer",
3595
+ "description": "The sequence number of the event that was emitted."
3596
+ },
3597
+ "item_id": {
3598
+ "type": "string",
3599
+ "description": "The ID of the tool call item that was updated."
3600
+ },
3601
+ "output_index": {
3602
+ "type": "integer",
3603
+ "description": "The index of the output item that was updated."
3604
+ },
3605
+ "arguments": {
3606
+ "type": "string",
3607
+ "description": "The final arguments string that was emitted."
3608
+ }
3609
+ },
3610
+ "type": "object",
3611
+ "required": [
3612
+ "type",
3613
+ "sequence_number",
3614
+ "item_id",
3615
+ "output_index",
3616
+ "arguments"
3617
+ ],
3618
+ "title": "Response function call arguments done event",
3619
+ "description": "A streaming event that indicated function call arguments were completed."
3620
+ },
3621
+ "ErrorPayload": {
3622
+ "properties": {
3623
+ "type": {
3624
+ "type": "string",
3625
+ "description": "The error type that was emitted."
3626
+ },
3627
+ "code": {
3628
+ "anyOf": [
3629
+ {
3630
+ "type": "string",
3631
+ "description": "The error code that was emitted, if any."
3632
+ },
3633
+ {
3634
+ "type": "null"
3635
+ }
3636
+ ]
3637
+ },
3638
+ "message": {
3639
+ "type": "string",
3640
+ "description": "The human-readable error message that was emitted."
3641
+ },
3642
+ "param": {
3643
+ "anyOf": [
3644
+ {
3645
+ "type": "string",
3646
+ "description": "The parameter name that was associated with the error, if any."
3647
+ },
3648
+ {
3649
+ "type": "null"
3650
+ }
3651
+ ]
3652
+ },
3653
+ "headers": {
3654
+ "additionalProperties": {
3655
+ "type": "string",
3656
+ "description": "The header value that was emitted."
3657
+ },
3658
+ "type": "object",
3659
+ "description": "The response headers that were emitted with the error, if any."
3660
+ }
3661
+ },
3662
+ "type": "object",
3663
+ "required": ["type", "code", "message", "param"],
3664
+ "title": "Error payload",
3665
+ "description": "An error payload that was emitted for a streaming error event."
3666
+ },
3667
+ "ErrorStreamingEvent": {
3668
+ "properties": {
3669
+ "type": {
3670
+ "type": "string",
3671
+ "enum": ["error"],
3672
+ "description": "The type of the event, always `error`.",
3673
+ "default": "error"
3674
+ },
3675
+ "sequence_number": {
3676
+ "type": "integer",
3677
+ "description": "The sequence number of the event that was emitted."
3678
+ },
3679
+ "error": {
3680
+ "allOf": [
3681
+ {
3682
+ "$ref": "#/components/schemas/ErrorPayload"
3683
+ },
3684
+ {
3685
+ "description": "The error payload that was emitted."
3686
+ }
3687
+ ]
3688
+ }
3689
+ },
3690
+ "type": "object",
3691
+ "required": ["type", "sequence_number", "error"],
3692
+ "title": "Error event",
3693
+ "description": "A streaming event that indicated an error was emitted."
3694
+ },
3695
+ "InputVideoContent": {
3696
+ "type": "object",
3697
+ "description": "A content block representing a video input to the model.",
3698
+ "properties": {
3699
+ "type": {
3700
+ "type": "string",
3701
+ "enum": ["input_video"],
3702
+ "description": "The type of the input content. Always `input_video`."
3703
+ },
3704
+ "video_url": {
3705
+ "type": "string",
3706
+ "description": "A base64 or remote url that resolves to a video file."
3707
+ }
3708
+ },
3709
+ "required": ["type", "video_url"]
3710
+ },
3711
+ "JsonSchemaResponseFormatParam": {
3712
+ "type": "object",
3713
+ "properties": {
3714
+ "type": {
3715
+ "type": "string",
3716
+ "description": "The type of response format being defined. Always `json_schema`.",
3717
+ "enum": ["json_schema"]
3718
+ },
3719
+ "description": {
3720
+ "type": "string",
3721
+ "description": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n"
3722
+ },
3723
+ "name": {
3724
+ "type": "string",
3725
+ "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"
3726
+ },
3727
+ "schema": {
3728
+ "type": "object",
3729
+ "title": "JSON schema",
3730
+ "description": "The schema for the response format, described as a JSON Schema object.\n",
3731
+ "additionalProperties": true
3732
+ },
3733
+ "strict": {
3734
+ "anyOf": [
3735
+ {
3736
+ "type": "boolean",
3737
+ "default": false,
3738
+ "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"
3739
+ },
3740
+ {
3741
+ "type": "null"
3742
+ }
3743
+ ]
3744
+ }
3745
+ }
3746
+ },
3747
+ "TextFormatParam": {
3748
+ "oneOf": [
3749
+ {
3750
+ "$ref": "#/components/schemas/TextResponseFormat"
3751
+ },
3752
+ {
3753
+ "$ref": "#/components/schemas/JsonSchemaResponseFormatParam"
3754
+ }
3755
+ ]
3756
+ }
3757
+ }
3758
+ },
3759
+ "paths": {
3760
+ "/responses": {
3761
+ "post": {
3762
+ "summary": "Create response",
3763
+ "description": "Creates a response.",
3764
+ "operationId": "Createresponse",
3765
+ "parameters": [],
3766
+ "requestBody": {
3767
+ "content": {
3768
+ "application/json": {
3769
+ "schema": {
3770
+ "$ref": "#/components/schemas/CreateResponseBody"
3771
+ }
3772
+ },
3773
+ "application/x-www-form-urlencoded": {
3774
+ "schema": {
3775
+ "$ref": "#/components/schemas/CreateResponseBody"
3776
+ }
3777
+ }
3778
+ }
3779
+ },
3780
+ "responses": {
3781
+ "200": {
3782
+ "description": "Success",
3783
+ "content": {
3784
+ "application/json": {
3785
+ "schema": {
3786
+ "$ref": "#/components/schemas/ResponseResource"
3787
+ }
3788
+ },
3789
+ "text/event-stream": {
3790
+ "schema": {
3791
+ "oneOf": [
3792
+ {
3793
+ "$ref": "#/components/schemas/ResponseCreatedStreamingEvent"
3794
+ },
3795
+ {
3796
+ "$ref": "#/components/schemas/ResponseQueuedStreamingEvent"
3797
+ },
3798
+ {
3799
+ "$ref": "#/components/schemas/ResponseInProgressStreamingEvent"
3800
+ },
3801
+ {
3802
+ "$ref": "#/components/schemas/ResponseCompletedStreamingEvent"
3803
+ },
3804
+ {
3805
+ "$ref": "#/components/schemas/ResponseFailedStreamingEvent"
3806
+ },
3807
+ {
3808
+ "$ref": "#/components/schemas/ResponseIncompleteStreamingEvent"
3809
+ },
3810
+ {
3811
+ "$ref": "#/components/schemas/ResponseOutputItemAddedStreamingEvent"
3812
+ },
3813
+ {
3814
+ "$ref": "#/components/schemas/ResponseOutputItemDoneStreamingEvent"
3815
+ },
3816
+ {
3817
+ "$ref": "#/components/schemas/ResponseReasoningSummaryPartAddedStreamingEvent"
3818
+ },
3819
+ {
3820
+ "$ref": "#/components/schemas/ResponseReasoningSummaryPartDoneStreamingEvent"
3821
+ },
3822
+ {
3823
+ "$ref": "#/components/schemas/ResponseContentPartAddedStreamingEvent"
3824
+ },
3825
+ {
3826
+ "$ref": "#/components/schemas/ResponseContentPartDoneStreamingEvent"
3827
+ },
3828
+ {
3829
+ "$ref": "#/components/schemas/ResponseOutputTextDeltaStreamingEvent"
3830
+ },
3831
+ {
3832
+ "$ref": "#/components/schemas/ResponseOutputTextDoneStreamingEvent"
3833
+ },
3834
+ {
3835
+ "$ref": "#/components/schemas/ResponseRefusalDeltaStreamingEvent"
3836
+ },
3837
+ {
3838
+ "$ref": "#/components/schemas/ResponseRefusalDoneStreamingEvent"
3839
+ },
3840
+ {
3841
+ "$ref": "#/components/schemas/ResponseReasoningDeltaStreamingEvent"
3842
+ },
3843
+ {
3844
+ "$ref": "#/components/schemas/ResponseReasoningDoneStreamingEvent"
3845
+ },
3846
+ {
3847
+ "$ref": "#/components/schemas/ResponseReasoningSummaryDeltaStreamingEvent"
3848
+ },
3849
+ {
3850
+ "$ref": "#/components/schemas/ResponseReasoningSummaryDoneStreamingEvent"
3851
+ },
3852
+ {
3853
+ "$ref": "#/components/schemas/ResponseOutputTextAnnotationAddedStreamingEvent"
3854
+ },
3855
+ {
3856
+ "$ref": "#/components/schemas/ResponseFunctionCallArgumentsDeltaStreamingEvent"
3857
+ },
3858
+ {
3859
+ "$ref": "#/components/schemas/ResponseFunctionCallArgumentsDoneStreamingEvent"
3860
+ },
3861
+ {
3862
+ "$ref": "#/components/schemas/ErrorStreamingEvent"
3863
+ }
3864
+ ],
3865
+ "discriminator": {
3866
+ "propertyName": "type"
3867
+ }
3868
+ }
3869
+ }
3870
+ }
3871
+ }
3872
+ }
3873
+ }
3874
+ }
3875
+ }
3876
+ }