Reference 2026-08-13 22:00 UTC to 2026-08-14 23:57 UTC

30<!-- x-release-please-start-version -->30<!-- x-release-please-start-version -->

31 31 

32```sh32```sh

33go get -u 'github.com/openai/openai-go/v3@v3.50.0'33go get -u 'github.com/openai/openai-go/v3@v3.51.0'

34```34```

35 35 

36<!-- x-release-please-end -->36<!-- x-release-please-end -->

15### Gradle15### Gradle

16 16 

17```kotlin17```kotlin

18implementation("com.openai:openai-java:4.50.0")18implementation("com.openai:openai-java:4.51.0")

19```19```

20 20 

21### Maven21### Maven

24<dependency>24<dependency>

25 <groupId>com.openai</groupId>25 <groupId>com.openai</groupId>

26 <artifactId>openai-java</artifactId>26 <artifactId>openai-java</artifactId>

27 <version>4.50.0</version>27 <version>4.51.0</version>

28</dependency>28</dependency>

29```29```

30 30 

87<!-- x-release-please-start-version -->87<!-- x-release-please-start-version -->

88 88 

89```kotlin89```kotlin

90implementation("com.openai:openai-java-bedrock:4.50.0")90implementation("com.openai:openai-java-bedrock:4.51.0")

91```91```

92 92 

93<!-- x-release-please-end -->93<!-- x-release-please-end -->

12173 for reasoning items returned by `POST /v1/responses` and WebSocket12173 for reasoning items returned by `POST /v1/responses` and WebSocket

12174 `response.create` requests.12174 `response.create` requests.

12175 12175 

12176 When streaming, use the completed reasoning item and its

12177 `encrypted_content` from the `response.output_item.done` event in

12178 subsequent requests. The `encrypted_content` in

12179 `response.output_item.added` may be incomplete. This is especially

12180 important when `store` is `false` or when using Zero Data Retention.

12181 

12176 - `status: optional "in_progress" or "completed" or "incomplete"`12182 - `status: optional "in_progress" or "completed" or "incomplete"`

12177 12183 

12178 The status of the item. One of `in_progress`, `completed`, or12184 The status of the item. One of `in_progress`, `completed`, or

12946 Unique identifier for the MCP tool call approval request.12952 Unique identifier for the MCP tool call approval request.

12947 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.12953 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

12948 12954 

12949 - `error: optional string or null`12955 - `error: optional BetaMcpToolCallError or null`

12950 12956 

12951 The error from the tool call, if any.12957 The error from the tool call, if any.

12952 12958 

12959 - `McpProtocolError object { code, message, type }`

12960 

12961 - `code: number`

12962 

12963 - `message: string`

12964 

12965 - `type: "mcp_protocol_error"`

12966 

12967 - `"mcp_protocol_error"`

12968 

12969 - `McpToolExecutionError object { content, type }`

12970 

12971 - `content: unknown`

12972 

12973 - `type: "mcp_tool_execution_error"`

12974 

12975 - `"mcp_tool_execution_error"`

12976 

12977 - `HTTPError object { code, message, type }`

12978 

12979 - `code: number`

12980 

12981 - `message: string`

12982 

12983 - `type: "http_error"`

12984 

12985 - `"http_error"`

12986 

12953 - `output: optional string or null`12987 - `output: optional string or null`

12954 12988 

12955 The output from the tool call.12989 The output from the tool call.

14235 for reasoning items returned by `POST /v1/responses` and WebSocket14269 for reasoning items returned by `POST /v1/responses` and WebSocket

14236 `response.create` requests.14270 `response.create` requests.

14237 14271 

14272 When streaming, use the completed reasoning item and its

14273 `encrypted_content` from the `response.output_item.done` event in

14274 subsequent requests. The `encrypted_content` in

14275 `response.output_item.added` may be incomplete. This is especially

14276 important when `store` is `false` or when using Zero Data Retention.

14277 

14238 - `status: optional "in_progress" or "completed" or "incomplete"`14278 - `status: optional "in_progress" or "completed" or "incomplete"`

14239 14279 

14240 The status of the item. One of `in_progress`, `completed`, or14280 The status of the item. One of `in_progress`, `completed`, or

17112 Unique identifier for the MCP tool call approval request.17152 Unique identifier for the MCP tool call approval request.

17113 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.17153 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

17114 17154 

17115 - `error: optional string or null`17155 - `error: optional BetaMcpToolCallError or null`

17116 17156 

17117 The error from the tool call, if any.17157 The error from the tool call, if any.

17118 17158 

23366 for reasoning items returned by `POST /v1/responses` and WebSocket23406 for reasoning items returned by `POST /v1/responses` and WebSocket

23367 `response.create` requests.23407 `response.create` requests.

23368 23408 

23409 When streaming, use the completed reasoning item and its

23410 `encrypted_content` from the `response.output_item.done` event in

23411 subsequent requests. The `encrypted_content` in

23412 `response.output_item.added` may be incomplete. This is especially

23413 important when `store` is `false` or when using Zero Data Retention.

23414 

23369 - `status: optional "in_progress" or "completed" or "incomplete"`23415 - `status: optional "in_progress" or "completed" or "incomplete"`

23370 23416 

23371 The status of the item. One of `in_progress`, `completed`, or23417 The status of the item. One of `in_progress`, `completed`, or

24139 Unique identifier for the MCP tool call approval request.24185 Unique identifier for the MCP tool call approval request.

24140 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.24186 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

24141 24187 

24142 - `error: optional string or null`24188 - `error: optional BetaMcpToolCallError or null`

24143 24189 

24144 The error from the tool call, if any.24190 The error from the tool call, if any.

24145 24191 

24192 - `McpProtocolError object { code, message, type }`

24193 

24194 - `code: number`

24195 

24196 - `message: string`

24197 

24198 - `type: "mcp_protocol_error"`

24199 

24200 - `"mcp_protocol_error"`

24201 

24202 - `McpToolExecutionError object { content, type }`

24203 

24204 - `content: unknown`

24205 

24206 - `type: "mcp_tool_execution_error"`

24207 

24208 - `"mcp_tool_execution_error"`

24209 

24210 - `HTTPError object { code, message, type }`

24211 

24212 - `code: number`

24213 

24214 - `message: string`

24215 

24216 - `type: "http_error"`

24217 

24218 - `"http_error"`

24219 

24146 - `output: optional string or null`24220 - `output: optional string or null`

24147 24221 

24148 The output from the tool call.24222 The output from the tool call.

28291 for reasoning items returned by `POST /v1/responses` and WebSocket28365 for reasoning items returned by `POST /v1/responses` and WebSocket

28292 `response.create` requests.28366 `response.create` requests.

28293 28367 

28368 When streaming, use the completed reasoning item and its

28369 `encrypted_content` from the `response.output_item.done` event in

28370 subsequent requests. The `encrypted_content` in

28371 `response.output_item.added` may be incomplete. This is especially

28372 important when `store` is `false` or when using Zero Data Retention.

28373 

28294 - `status: optional "in_progress" or "completed" or "incomplete"`28374 - `status: optional "in_progress" or "completed" or "incomplete"`

28295 28375 

28296 The status of the item. One of `in_progress`, `completed`, or28376 The status of the item. One of `in_progress`, `completed`, or

29050 Unique identifier for the MCP tool call approval request.29130 Unique identifier for the MCP tool call approval request.

29051 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.29131 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

29052 29132 

29053 - `error: optional string or null`29133 - `error: optional BetaMcpToolCallError or null`

29054 29134 

29055 The error from the tool call, if any.29135 The error from the tool call, if any.

29056 29136 

29137 - `McpProtocolError object { code, message, type }`

29138 

29139 - `code: number`

29140 

29141 - `message: string`

29142 

29143 - `type: "mcp_protocol_error"`

29144 

29145 - `"mcp_protocol_error"`

29146 

29147 - `McpToolExecutionError object { content, type }`

29148 

29149 - `content: unknown`

29150 

29151 - `type: "mcp_tool_execution_error"`

29152 

29153 - `"mcp_tool_execution_error"`

29154 

29155 - `HTTPError object { code, message, type }`

29156 

29157 - `code: number`

29158 

29159 - `message: string`

29160 

29161 - `type: "http_error"`

29162 

29163 - `"http_error"`

29164 

29057 - `output: optional string or null`29165 - `output: optional string or null`

29058 29166 

29059 The output from the tool call.29167 The output from the tool call.

33225 for reasoning items returned by `POST /v1/responses` and WebSocket33333 for reasoning items returned by `POST /v1/responses` and WebSocket

33226 `response.create` requests.33334 `response.create` requests.

33227 33335 

33336 When streaming, use the completed reasoning item and its

33337 `encrypted_content` from the `response.output_item.done` event in

33338 subsequent requests. The `encrypted_content` in

33339 `response.output_item.added` may be incomplete. This is especially

33340 important when `store` is `false` or when using Zero Data Retention.

33341 

33228 - `status: optional "in_progress" or "completed" or "incomplete"`33342 - `status: optional "in_progress" or "completed" or "incomplete"`

33229 33343 

33230 The status of the item. One of `in_progress`, `completed`, or33344 The status of the item. One of `in_progress`, `completed`, or

33998 Unique identifier for the MCP tool call approval request.34112 Unique identifier for the MCP tool call approval request.

33999 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.34113 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

34000 34114 

34001 - `error: optional string or null`34115 - `error: optional BetaMcpToolCallError or null`

34002 34116 

34003 The error from the tool call, if any.34117 The error from the tool call, if any.

34004 34118 

34119 - `McpProtocolError object { code, message, type }`

34120 

34121 - `code: number`

34122 

34123 - `message: string`

34124 

34125 - `type: "mcp_protocol_error"`

34126 

34127 - `"mcp_protocol_error"`

34128 

34129 - `McpToolExecutionError object { content, type }`

34130 

34131 - `content: unknown`

34132 

34133 - `type: "mcp_tool_execution_error"`

34134 

34135 - `"mcp_tool_execution_error"`

34136 

34137 - `HTTPError object { code, message, type }`

34138 

34139 - `code: number`

34140 

34141 - `message: string`

34142 

34143 - `type: "http_error"`

34144 

34145 - `"http_error"`

34146 

34005 - `output: optional string or null`34147 - `output: optional string or null`

34006 34148 

34007 The output from the tool call.34149 The output from the tool call.

39950 for reasoning items returned by `POST /v1/responses` and WebSocket40092 for reasoning items returned by `POST /v1/responses` and WebSocket

39951 `response.create` requests.40093 `response.create` requests.

39952 40094 

40095 When streaming, use the completed reasoning item and its

40096 `encrypted_content` from the `response.output_item.done` event in

40097 subsequent requests. The `encrypted_content` in

40098 `response.output_item.added` may be incomplete. This is especially

40099 important when `store` is `false` or when using Zero Data Retention.

40100 

39953 - `status: optional "in_progress" or "completed" or "incomplete"`40101 - `status: optional "in_progress" or "completed" or "incomplete"`

39954 40102 

39955 The status of the item. One of `in_progress`, `completed`, or40103 The status of the item. One of `in_progress`, `completed`, or

40723 Unique identifier for the MCP tool call approval request.40871 Unique identifier for the MCP tool call approval request.

40724 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.40872 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

40725 40873 

40726 - `error: optional string or null`40874 - `error: optional BetaMcpToolCallError or null`

40727 40875 

40728 The error from the tool call, if any.40876 The error from the tool call, if any.

40729 40877 

40878 - `McpProtocolError object { code, message, type }`

40879 

40880 - `code: number`

40881 

40882 - `message: string`

40883 

40884 - `type: "mcp_protocol_error"`

40885 

40886 - `"mcp_protocol_error"`

40887 

40888 - `McpToolExecutionError object { content, type }`

40889 

40890 - `content: unknown`

40891 

40892 - `type: "mcp_tool_execution_error"`

40893 

40894 - `"mcp_tool_execution_error"`

40895 

40896 - `HTTPError object { code, message, type }`

40897 

40898 - `code: number`

40899 

40900 - `message: string`

40901 

40902 - `type: "http_error"`

40903 

40904 - `"http_error"`

40905 

40730 - `output: optional string or null`40906 - `output: optional string or null`

40731 40907 

40732 The output from the tool call.40908 The output from the tool call.

42012 for reasoning items returned by `POST /v1/responses` and WebSocket42188 for reasoning items returned by `POST /v1/responses` and WebSocket

42013 `response.create` requests.42189 `response.create` requests.

42014 42190 

42191 When streaming, use the completed reasoning item and its

42192 `encrypted_content` from the `response.output_item.done` event in

42193 subsequent requests. The `encrypted_content` in

42194 `response.output_item.added` may be incomplete. This is especially

42195 important when `store` is `false` or when using Zero Data Retention.

42196 

42015 - `status: optional "in_progress" or "completed" or "incomplete"`42197 - `status: optional "in_progress" or "completed" or "incomplete"`

42016 42198 

42017 The status of the item. One of `in_progress`, `completed`, or42199 The status of the item. One of `in_progress`, `completed`, or

44889 Unique identifier for the MCP tool call approval request.45071 Unique identifier for the MCP tool call approval request.

44890 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.45072 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

44891 45073 

44892 - `error: optional string or null`45074 - `error: optional BetaMcpToolCallError or null`

44893 45075 

44894 The error from the tool call, if any.45076 The error from the tool call, if any.

44895 45077 

51806 for reasoning items returned by `POST /v1/responses` and WebSocket51988 for reasoning items returned by `POST /v1/responses` and WebSocket

51807 `response.create` requests.51989 `response.create` requests.

51808 51990 

51991 When streaming, use the completed reasoning item and its

51992 `encrypted_content` from the `response.output_item.done` event in

51993 subsequent requests. The `encrypted_content` in

51994 `response.output_item.added` may be incomplete. This is especially

51995 important when `store` is `false` or when using Zero Data Retention.

51996 

51809 - `status: optional "in_progress" or "completed" or "incomplete"`51997 - `status: optional "in_progress" or "completed" or "incomplete"`

51810 51998 

51811 The status of the item. One of `in_progress`, `completed`, or51999 The status of the item. One of `in_progress`, `completed`, or

52579 Unique identifier for the MCP tool call approval request.52767 Unique identifier for the MCP tool call approval request.

52580 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.52768 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

52581 52769 

52582 - `error: optional string or null`52770 - `error: optional BetaMcpToolCallError or null`

52583 52771 

52584 The error from the tool call, if any.52772 The error from the tool call, if any.

52585 52773 

52774 - `McpProtocolError object { code, message, type }`

52775 

52776 - `code: number`

52777 

52778 - `message: string`

52779 

52780 - `type: "mcp_protocol_error"`

52781 

52782 - `"mcp_protocol_error"`

52783 

52784 - `McpToolExecutionError object { content, type }`

52785 

52786 - `content: unknown`

52787 

52788 - `type: "mcp_tool_execution_error"`

52789 

52790 - `"mcp_tool_execution_error"`

52791 

52792 - `HTTPError object { code, message, type }`

52793 

52794 - `code: number`

52795 

52796 - `message: string`

52797 

52798 - `type: "http_error"`

52799 

52800 - `"http_error"`

52801 

52586 - `output: optional string or null`52802 - `output: optional string or null`

52587 52803 

52588 The output from the tool call.52804 The output from the tool call.

53868 for reasoning items returned by `POST /v1/responses` and WebSocket54084 for reasoning items returned by `POST /v1/responses` and WebSocket

53869 `response.create` requests.54085 `response.create` requests.

53870 54086 

54087 When streaming, use the completed reasoning item and its

54088 `encrypted_content` from the `response.output_item.done` event in

54089 subsequent requests. The `encrypted_content` in

54090 `response.output_item.added` may be incomplete. This is especially

54091 important when `store` is `false` or when using Zero Data Retention.

54092 

53871 - `status: optional "in_progress" or "completed" or "incomplete"`54093 - `status: optional "in_progress" or "completed" or "incomplete"`

53872 54094 

53873 The status of the item. One of `in_progress`, `completed`, or54095 The status of the item. One of `in_progress`, `completed`, or

56745 Unique identifier for the MCP tool call approval request.56967 Unique identifier for the MCP tool call approval request.

56746 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.56968 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

56747 56969 

56748 - `error: optional string or null`56970 - `error: optional BetaMcpToolCallError or null`

56749 56971 

56750 The error from the tool call, if any.56972 The error from the tool call, if any.

56751 56973 

62851 for reasoning items returned by `POST /v1/responses` and WebSocket63073 for reasoning items returned by `POST /v1/responses` and WebSocket

62852 `response.create` requests.63074 `response.create` requests.

62853 63075 

63076 When streaming, use the completed reasoning item and its

63077 `encrypted_content` from the `response.output_item.done` event in

63078 subsequent requests. The `encrypted_content` in

63079 `response.output_item.added` may be incomplete. This is especially

63080 important when `store` is `false` or when using Zero Data Retention.

63081 

62854 - `status: optional "in_progress" or "completed" or "incomplete"`63082 - `status: optional "in_progress" or "completed" or "incomplete"`

62855 63083 

62856 The status of the item. One of `in_progress`, `completed`, or63084 The status of the item. One of `in_progress`, `completed`, or

63610 Unique identifier for the MCP tool call approval request.63838 Unique identifier for the MCP tool call approval request.

63611 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.63839 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

63612 63840 

63613 - `error: optional string or null`63841 - `error: optional BetaMcpToolCallError or null`

63614 63842 

63615 The error from the tool call, if any.63843 The error from the tool call, if any.

63616 63844 

63845 - `McpProtocolError object { code, message, type }`

63846 

63847 - `code: number`

63848 

63849 - `message: string`

63850 

63851 - `type: "mcp_protocol_error"`

63852 

63853 - `"mcp_protocol_error"`

63854 

63855 - `McpToolExecutionError object { content, type }`

63856 

63857 - `content: unknown`

63858 

63859 - `type: "mcp_tool_execution_error"`

63860 

63861 - `"mcp_tool_execution_error"`

63862 

63863 - `HTTPError object { code, message, type }`

63864 

63865 - `code: number`

63866 

63867 - `message: string`

63868 

63869 - `type: "http_error"`

63870 

63871 - `"http_error"`

63872 

63617 - `output: optional string or null`63873 - `output: optional string or null`

63618 63874 

63619 The output from the tool call.63875 The output from the tool call.

64654 64910 

64655 The path to the directory containing the skill.64911 The path to the directory containing the skill.

64656 64912 

64913### Beta Mcp Tool Call Error

64914 

64915- `BetaMcpToolCallError = object { code, message, type } or object { content, type } or object { code, message, type }`

64916 

64917 - `McpProtocolError object { code, message, type }`

64918 

64919 - `code: number`

64920 

64921 - `message: string`

64922 

64923 - `type: "mcp_protocol_error"`

64924 

64925 - `"mcp_protocol_error"`

64926 

64927 - `McpToolExecutionError object { content, type }`

64928 

64929 - `content: unknown`

64930 

64931 - `type: "mcp_tool_execution_error"`

64932 

64933 - `"mcp_tool_execution_error"`

64934 

64935 - `HTTPError object { code, message, type }`

64936 

64937 - `code: number`

64938 

64939 - `message: string`

64940 

64941 - `type: "http_error"`

64942 

64943 - `"http_error"`

64944 

64657### Beta Response64945### Beta Response

64658 64946 

64659- `BetaResponse object { id, created_at, error, 32 more }`64947- `BetaResponse object { id, created_at, error, 32 more }`

68500 for reasoning items returned by `POST /v1/responses` and WebSocket68788 for reasoning items returned by `POST /v1/responses` and WebSocket

68501 `response.create` requests.68789 `response.create` requests.

68502 68790 

68791 When streaming, use the completed reasoning item and its

68792 `encrypted_content` from the `response.output_item.done` event in

68793 subsequent requests. The `encrypted_content` in

68794 `response.output_item.added` may be incomplete. This is especially

68795 important when `store` is `false` or when using Zero Data Retention.

68796 

68503 - `status: optional "in_progress" or "completed" or "incomplete"`68797 - `status: optional "in_progress" or "completed" or "incomplete"`

68504 68798 

68505 The status of the item. One of `in_progress`, `completed`, or68799 The status of the item. One of `in_progress`, `completed`, or

69273 Unique identifier for the MCP tool call approval request.69567 Unique identifier for the MCP tool call approval request.

69274 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.69568 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

69275 69569 

69276 - `error: optional string or null`69570 - `error: optional BetaMcpToolCallError or null`

69277 69571 

69278 The error from the tool call, if any.69572 The error from the tool call, if any.

69279 69573 

69574 - `McpProtocolError object { code, message, type }`

69575 

69576 - `code: number`

69577 

69578 - `message: string`

69579 

69580 - `type: "mcp_protocol_error"`

69581 

69582 - `"mcp_protocol_error"`

69583 

69584 - `McpToolExecutionError object { content, type }`

69585 

69586 - `content: unknown`

69587 

69588 - `type: "mcp_tool_execution_error"`

69589 

69590 - `"mcp_tool_execution_error"`

69591 

69592 - `HTTPError object { code, message, type }`

69593 

69594 - `code: number`

69595 

69596 - `message: string`

69597 

69598 - `type: "http_error"`

69599 

69600 - `"http_error"`

69601 

69280 - `output: optional string or null`69602 - `output: optional string or null`

69281 69603 

69282 The output from the tool call.69604 The output from the tool call.

70562 for reasoning items returned by `POST /v1/responses` and WebSocket70884 for reasoning items returned by `POST /v1/responses` and WebSocket

70563 `response.create` requests.70885 `response.create` requests.

70564 70886 

70887 When streaming, use the completed reasoning item and its

70888 `encrypted_content` from the `response.output_item.done` event in

70889 subsequent requests. The `encrypted_content` in

70890 `response.output_item.added` may be incomplete. This is especially

70891 important when `store` is `false` or when using Zero Data Retention.

70892 

70565 - `status: optional "in_progress" or "completed" or "incomplete"`70893 - `status: optional "in_progress" or "completed" or "incomplete"`

70566 70894 

70567 The status of the item. One of `in_progress`, `completed`, or70895 The status of the item. One of `in_progress`, `completed`, or

73439 Unique identifier for the MCP tool call approval request.73767 Unique identifier for the MCP tool call approval request.

73440 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.73768 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

73441 73769 

73442 - `error: optional string or null`73770 - `error: optional BetaMcpToolCallError or null`

73443 73771 

73444 The error from the tool call, if any.73772 The error from the tool call, if any.

73445 73773 

79579 for reasoning items returned by `POST /v1/responses` and WebSocket79907 for reasoning items returned by `POST /v1/responses` and WebSocket

79580 `response.create` requests.79908 `response.create` requests.

79581 79909 

79910 When streaming, use the completed reasoning item and its

79911 `encrypted_content` from the `response.output_item.done` event in

79912 subsequent requests. The `encrypted_content` in

79913 `response.output_item.added` may be incomplete. This is especially

79914 important when `store` is `false` or when using Zero Data Retention.

79915 

79582 - `status: optional "in_progress" or "completed" or "incomplete"`79916 - `status: optional "in_progress" or "completed" or "incomplete"`

79583 79917 

79584 The status of the item. One of `in_progress`, `completed`, or79918 The status of the item. One of `in_progress`, `completed`, or

80352 Unique identifier for the MCP tool call approval request.80686 Unique identifier for the MCP tool call approval request.

80353 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.80687 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

80354 80688 

80355 - `error: optional string or null`80689 - `error: optional BetaMcpToolCallError or null`

80356 80690 

80357 The error from the tool call, if any.80691 The error from the tool call, if any.

80358 80692 

80693 - `McpProtocolError object { code, message, type }`

80694 

80695 - `code: number`

80696 

80697 - `message: string`

80698 

80699 - `type: "mcp_protocol_error"`

80700 

80701 - `"mcp_protocol_error"`

80702 

80703 - `McpToolExecutionError object { content, type }`

80704 

80705 - `content: unknown`

80706 

80707 - `type: "mcp_tool_execution_error"`

80708 

80709 - `"mcp_tool_execution_error"`

80710 

80711 - `HTTPError object { code, message, type }`

80712 

80713 - `code: number`

80714 

80715 - `message: string`

80716 

80717 - `type: "http_error"`

80718 

80719 - `"http_error"`

80720 

80359 - `output: optional string or null`80721 - `output: optional string or null`

80360 80722 

80361 The output from the tool call.80723 The output from the tool call.

81641 for reasoning items returned by `POST /v1/responses` and WebSocket82003 for reasoning items returned by `POST /v1/responses` and WebSocket

81642 `response.create` requests.82004 `response.create` requests.

81643 82005 

82006 When streaming, use the completed reasoning item and its

82007 `encrypted_content` from the `response.output_item.done` event in

82008 subsequent requests. The `encrypted_content` in

82009 `response.output_item.added` may be incomplete. This is especially

82010 important when `store` is `false` or when using Zero Data Retention.

82011 

81644 - `status: optional "in_progress" or "completed" or "incomplete"`82012 - `status: optional "in_progress" or "completed" or "incomplete"`

81645 82013 

81646 The status of the item. One of `in_progress`, `completed`, or82014 The status of the item. One of `in_progress`, `completed`, or

84518 Unique identifier for the MCP tool call approval request.84886 Unique identifier for the MCP tool call approval request.

84519 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.84887 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

84520 84888 

84521 - `error: optional string or null`84889 - `error: optional BetaMcpToolCallError or null`

84522 84890 

84523 The error from the tool call, if any.84891 The error from the tool call, if any.

84524 84892 

91119 for reasoning items returned by `POST /v1/responses` and WebSocket91487 for reasoning items returned by `POST /v1/responses` and WebSocket

91120 `response.create` requests.91488 `response.create` requests.

91121 91489 

91490 When streaming, use the completed reasoning item and its

91491 `encrypted_content` from the `response.output_item.done` event in

91492 subsequent requests. The `encrypted_content` in

91493 `response.output_item.added` may be incomplete. This is especially

91494 important when `store` is `false` or when using Zero Data Retention.

91495 

91122 - `status: optional "in_progress" or "completed" or "incomplete"`91496 - `status: optional "in_progress" or "completed" or "incomplete"`

91123 91497 

91124 The status of the item. One of `in_progress`, `completed`, or91498 The status of the item. One of `in_progress`, `completed`, or

91892 Unique identifier for the MCP tool call approval request.92266 Unique identifier for the MCP tool call approval request.

91893 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.92267 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

91894 92268 

91895 - `error: optional string or null`92269 - `error: optional BetaMcpToolCallError or null`

91896 92270 

91897 The error from the tool call, if any.92271 The error from the tool call, if any.

91898 92272 

92273 - `McpProtocolError object { code, message, type }`

92274 

92275 - `code: number`

92276 

92277 - `message: string`

92278 

92279 - `type: "mcp_protocol_error"`

92280 

92281 - `"mcp_protocol_error"`

92282 

92283 - `McpToolExecutionError object { content, type }`

92284 

92285 - `content: unknown`

92286 

92287 - `type: "mcp_tool_execution_error"`

92288 

92289 - `"mcp_tool_execution_error"`

92290 

92291 - `HTTPError object { code, message, type }`

92292 

92293 - `code: number`

92294 

92295 - `message: string`

92296 

92297 - `type: "http_error"`

92298 

92299 - `"http_error"`

92300 

91899 - `output: optional string or null`92301 - `output: optional string or null`

91900 92302 

91901 The output from the tool call.92303 The output from the tool call.

93181 for reasoning items returned by `POST /v1/responses` and WebSocket93583 for reasoning items returned by `POST /v1/responses` and WebSocket

93182 `response.create` requests.93584 `response.create` requests.

93183 93585 

93586 When streaming, use the completed reasoning item and its

93587 `encrypted_content` from the `response.output_item.done` event in

93588 subsequent requests. The `encrypted_content` in

93589 `response.output_item.added` may be incomplete. This is especially

93590 important when `store` is `false` or when using Zero Data Retention.

93591 

93184 - `status: optional "in_progress" or "completed" or "incomplete"`93592 - `status: optional "in_progress" or "completed" or "incomplete"`

93185 93593 

93186 The status of the item. One of `in_progress`, `completed`, or93594 The status of the item. One of `in_progress`, `completed`, or

96058 Unique identifier for the MCP tool call approval request.96466 Unique identifier for the MCP tool call approval request.

96059 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.96467 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

96060 96468 

96061 - `error: optional string or null`96469 - `error: optional BetaMcpToolCallError or null`

96062 96470 

96063 The error from the tool call, if any.96471 The error from the tool call, if any.

96064 96472 

102106 for reasoning items returned by `POST /v1/responses` and WebSocket102514 for reasoning items returned by `POST /v1/responses` and WebSocket

102107 `response.create` requests.102515 `response.create` requests.

102108 102516 

102517 When streaming, use the completed reasoning item and its

102518 `encrypted_content` from the `response.output_item.done` event in

102519 subsequent requests. The `encrypted_content` in

102520 `response.output_item.added` may be incomplete. This is especially

102521 important when `store` is `false` or when using Zero Data Retention.

102522 

102109 - `status: optional "in_progress" or "completed" or "incomplete"`102523 - `status: optional "in_progress" or "completed" or "incomplete"`

102110 102524 

102111 The status of the item. One of `in_progress`, `completed`, or102525 The status of the item. One of `in_progress`, `completed`, or

102879 Unique identifier for the MCP tool call approval request.103293 Unique identifier for the MCP tool call approval request.

102880 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.103294 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

102881 103295 

102882 - `error: optional string or null`103296 - `error: optional BetaMcpToolCallError or null`

102883 103297 

102884 The error from the tool call, if any.103298 The error from the tool call, if any.

102885 103299 

103300 - `McpProtocolError object { code, message, type }`

103301 

103302 - `code: number`

103303 

103304 - `message: string`

103305 

103306 - `type: "mcp_protocol_error"`

103307 

103308 - `"mcp_protocol_error"`

103309 

103310 - `McpToolExecutionError object { content, type }`

103311 

103312 - `content: unknown`

103313 

103314 - `type: "mcp_tool_execution_error"`

103315 

103316 - `"mcp_tool_execution_error"`

103317 

103318 - `HTTPError object { code, message, type }`

103319 

103320 - `code: number`

103321 

103322 - `message: string`

103323 

103324 - `type: "http_error"`

103325 

103326 - `"http_error"`

103327 

102886 - `output: optional string or null`103328 - `output: optional string or null`

102887 103329 

102888 The output from the tool call.103330 The output from the tool call.

104168 for reasoning items returned by `POST /v1/responses` and WebSocket104610 for reasoning items returned by `POST /v1/responses` and WebSocket

104169 `response.create` requests.104611 `response.create` requests.

104170 104612 

104613 When streaming, use the completed reasoning item and its

104614 `encrypted_content` from the `response.output_item.done` event in

104615 subsequent requests. The `encrypted_content` in

104616 `response.output_item.added` may be incomplete. This is especially

104617 important when `store` is `false` or when using Zero Data Retention.

104618 

104171 - `status: optional "in_progress" or "completed" or "incomplete"`104619 - `status: optional "in_progress" or "completed" or "incomplete"`

104172 104620 

104173 The status of the item. One of `in_progress`, `completed`, or104621 The status of the item. One of `in_progress`, `completed`, or

107045 Unique identifier for the MCP tool call approval request.107493 Unique identifier for the MCP tool call approval request.

107046 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.107494 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

107047 107495 

107048 - `error: optional string or null`107496 - `error: optional BetaMcpToolCallError or null`

107049 107497 

107050 The error from the tool call, if any.107498 The error from the tool call, if any.

107051 107499 

109500 109948 

109501### Beta Response Image Gen Call Partial Image Event109949### Beta Response Image Gen Call Partial Image Event

109502 109950 

109503- `BetaResponseImageGenCallPartialImageEvent object { item_id, output_index, partial_image_b64, 4 more }`109951- `BetaResponseImageGenCallPartialImageEvent object { item_id, output_index, partial_image_b64, 8 more }`

109504 109952 

109505 Emitted when a partial image is available during image generation streaming.109953 Emitted when a partial image is available during image generation streaming.

109506 109954 

109538 109986 

109539 The canonical name of the agent that produced this item.109987 The canonical name of the agent that produced this item.

109540 109988 

109989 - `background: optional string`

109990 

109991 The background setting that was used.

109992 

109993 - `output_format: optional string`

109994 

109995 The output format that was used.

109996 

109997 - `quality: optional string`

109998 

109999 The image quality that was used.

110000 

110001 - `size: optional string`

110002 

110003 The image size that was used.

110004 

109541### Beta Response In Progress Event110005### Beta Response In Progress Event

109542 110006 

109543- `BetaResponseInProgressEvent object { response, sequence_number, type, agent }`110007- `BetaResponseInProgressEvent object { response, sequence_number, type, agent }`

113390 for reasoning items returned by `POST /v1/responses` and WebSocket113854 for reasoning items returned by `POST /v1/responses` and WebSocket

113391 `response.create` requests.113855 `response.create` requests.

113392 113856 

113857 When streaming, use the completed reasoning item and its

113858 `encrypted_content` from the `response.output_item.done` event in

113859 subsequent requests. The `encrypted_content` in

113860 `response.output_item.added` may be incomplete. This is especially

113861 important when `store` is `false` or when using Zero Data Retention.

113862 

113393 - `status: optional "in_progress" or "completed" or "incomplete"`113863 - `status: optional "in_progress" or "completed" or "incomplete"`

113394 113864 

113395 The status of the item. One of `in_progress`, `completed`, or113865 The status of the item. One of `in_progress`, `completed`, or

114163 Unique identifier for the MCP tool call approval request.114633 Unique identifier for the MCP tool call approval request.

114164 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.114634 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

114165 114635 

114166 - `error: optional string or null`114636 - `error: optional BetaMcpToolCallError or null`

114167 114637 

114168 The error from the tool call, if any.114638 The error from the tool call, if any.

114169 114639 

114640 - `McpProtocolError object { code, message, type }`

114641 

114642 - `code: number`

114643 

114644 - `message: string`

114645 

114646 - `type: "mcp_protocol_error"`

114647 

114648 - `"mcp_protocol_error"`

114649 

114650 - `McpToolExecutionError object { content, type }`

114651 

114652 - `content: unknown`

114653 

114654 - `type: "mcp_tool_execution_error"`

114655 

114656 - `"mcp_tool_execution_error"`

114657 

114658 - `HTTPError object { code, message, type }`

114659 

114660 - `code: number`

114661 

114662 - `message: string`

114663 

114664 - `type: "http_error"`

114665 

114666 - `"http_error"`

114667 

114170 - `output: optional string or null`114668 - `output: optional string or null`

114171 114669 

114172 The output from the tool call.114670 The output from the tool call.

115452 for reasoning items returned by `POST /v1/responses` and WebSocket115950 for reasoning items returned by `POST /v1/responses` and WebSocket

115453 `response.create` requests.115951 `response.create` requests.

115454 115952 

115953 When streaming, use the completed reasoning item and its

115954 `encrypted_content` from the `response.output_item.done` event in

115955 subsequent requests. The `encrypted_content` in

115956 `response.output_item.added` may be incomplete. This is especially

115957 important when `store` is `false` or when using Zero Data Retention.

115958 

115455 - `status: optional "in_progress" or "completed" or "incomplete"`115959 - `status: optional "in_progress" or "completed" or "incomplete"`

115456 115960 

115457 The status of the item. One of `in_progress`, `completed`, or115961 The status of the item. One of `in_progress`, `completed`, or

118329 Unique identifier for the MCP tool call approval request.118833 Unique identifier for the MCP tool call approval request.

118330 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.118834 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

118331 118835 

118332 - `error: optional string or null`118836 - `error: optional BetaMcpToolCallError or null`

118333 118837 

118334 The error from the tool call, if any.118838 The error from the tool call, if any.

118335 118839 

124246 for reasoning items returned by `POST /v1/responses` and WebSocket124750 for reasoning items returned by `POST /v1/responses` and WebSocket

124247 `response.create` requests.124751 `response.create` requests.

124248 124752 

124753 When streaming, use the completed reasoning item and its

124754 `encrypted_content` from the `response.output_item.done` event in

124755 subsequent requests. The `encrypted_content` in

124756 `response.output_item.added` may be incomplete. This is especially

124757 important when `store` is `false` or when using Zero Data Retention.

124758 

124249 - `status: optional "in_progress" or "completed" or "incomplete"`124759 - `status: optional "in_progress" or "completed" or "incomplete"`

124250 124760 

124251 The status of the item. One of `in_progress`, `completed`, or124761 The status of the item. One of `in_progress`, `completed`, or

125019 Unique identifier for the MCP tool call approval request.125529 Unique identifier for the MCP tool call approval request.

125020 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.125530 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

125021 125531 

125022 - `error: optional string or null`125532 - `error: optional BetaMcpToolCallError or null`

125023 125533 

125024 The error from the tool call, if any.125534 The error from the tool call, if any.

125025 125535 

125536 - `McpProtocolError object { code, message, type }`

125537 

125538 - `code: number`

125539 

125540 - `message: string`

125541 

125542 - `type: "mcp_protocol_error"`

125543 

125544 - `"mcp_protocol_error"`

125545 

125546 - `McpToolExecutionError object { content, type }`

125547 

125548 - `content: unknown`

125549 

125550 - `type: "mcp_tool_execution_error"`

125551 

125552 - `"mcp_tool_execution_error"`

125553 

125554 - `HTTPError object { code, message, type }`

125555 

125556 - `code: number`

125557 

125558 - `message: string`

125559 

125560 - `type: "http_error"`

125561 

125562 - `"http_error"`

125563 

125026 - `output: optional string or null`125564 - `output: optional string or null`

125027 125565 

125028 The output from the tool call.125566 The output from the tool call.

126308 for reasoning items returned by `POST /v1/responses` and WebSocket126846 for reasoning items returned by `POST /v1/responses` and WebSocket

126309 `response.create` requests.126847 `response.create` requests.

126310 126848 

126849 When streaming, use the completed reasoning item and its

126850 `encrypted_content` from the `response.output_item.done` event in

126851 subsequent requests. The `encrypted_content` in

126852 `response.output_item.added` may be incomplete. This is especially

126853 important when `store` is `false` or when using Zero Data Retention.

126854 

126311 - `status: optional "in_progress" or "completed" or "incomplete"`126855 - `status: optional "in_progress" or "completed" or "incomplete"`

126312 126856 

126313 The status of the item. One of `in_progress`, `completed`, or126857 The status of the item. One of `in_progress`, `completed`, or

129185 Unique identifier for the MCP tool call approval request.129729 Unique identifier for the MCP tool call approval request.

129186 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.129730 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

129187 129731 

129188 - `error: optional string or null`129732 - `error: optional BetaMcpToolCallError or null`

129189 129733 

129190 The error from the tool call, if any.129734 The error from the tool call, if any.

129191 129735 

135009 for reasoning items returned by `POST /v1/responses` and WebSocket135553 for reasoning items returned by `POST /v1/responses` and WebSocket

135010 `response.create` requests.135554 `response.create` requests.

135011 135555 

135556 When streaming, use the completed reasoning item and its

135557 `encrypted_content` from the `response.output_item.done` event in

135558 subsequent requests. The `encrypted_content` in

135559 `response.output_item.added` may be incomplete. This is especially

135560 important when `store` is `false` or when using Zero Data Retention.

135561 

135012 - `status: optional "in_progress" or "completed" or "incomplete"`135562 - `status: optional "in_progress" or "completed" or "incomplete"`

135013 135563 

135014 The status of the item. One of `in_progress`, `completed`, or135564 The status of the item. One of `in_progress`, `completed`, or

135782 Unique identifier for the MCP tool call approval request.136332 Unique identifier for the MCP tool call approval request.

135783 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.136333 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

135784 136334 

135785 - `error: optional string or null`136335 - `error: optional BetaMcpToolCallError or null`

135786 136336 

135787 The error from the tool call, if any.136337 The error from the tool call, if any.

135788 136338 

136339 - `McpProtocolError object { code, message, type }`

136340 

136341 - `code: number`

136342 

136343 - `message: string`

136344 

136345 - `type: "mcp_protocol_error"`

136346 

136347 - `"mcp_protocol_error"`

136348 

136349 - `McpToolExecutionError object { content, type }`

136350 

136351 - `content: unknown`

136352 

136353 - `type: "mcp_tool_execution_error"`

136354 

136355 - `"mcp_tool_execution_error"`

136356 

136357 - `HTTPError object { code, message, type }`

136358 

136359 - `code: number`

136360 

136361 - `message: string`

136362 

136363 - `type: "http_error"`

136364 

136365 - `"http_error"`

136366 

135789 - `output: optional string or null`136367 - `output: optional string or null`

135790 136368 

135791 The output from the tool call.136369 The output from the tool call.

139835 for reasoning items returned by `POST /v1/responses` and WebSocket140413 for reasoning items returned by `POST /v1/responses` and WebSocket

139836 `response.create` requests.140414 `response.create` requests.

139837 140415 

140416 When streaming, use the completed reasoning item and its

140417 `encrypted_content` from the `response.output_item.done` event in

140418 subsequent requests. The `encrypted_content` in

140419 `response.output_item.added` may be incomplete. This is especially

140420 important when `store` is `false` or when using Zero Data Retention.

140421 

139838 - `status: optional "in_progress" or "completed" or "incomplete"`140422 - `status: optional "in_progress" or "completed" or "incomplete"`

139839 140423 

139840 The status of the item. One of `in_progress`, `completed`, or140424 The status of the item. One of `in_progress`, `completed`, or

140608 Unique identifier for the MCP tool call approval request.141192 Unique identifier for the MCP tool call approval request.

140609 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.141193 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

140610 141194 

140611 - `error: optional string or null`141195 - `error: optional BetaMcpToolCallError or null`

140612 141196 

140613 The error from the tool call, if any.141197 The error from the tool call, if any.

140614 141198 

141199 - `McpProtocolError object { code, message, type }`

141200 

141201 - `code: number`

141202 

141203 - `message: string`

141204 

141205 - `type: "mcp_protocol_error"`

141206 

141207 - `"mcp_protocol_error"`

141208 

141209 - `McpToolExecutionError object { content, type }`

141210 

141211 - `content: unknown`

141212 

141213 - `type: "mcp_tool_execution_error"`

141214 

141215 - `"mcp_tool_execution_error"`

141216 

141217 - `HTTPError object { code, message, type }`

141218 

141219 - `code: number`

141220 

141221 - `message: string`

141222 

141223 - `type: "http_error"`

141224 

141225 - `"http_error"`

141226 

140615 - `output: optional string or null`141227 - `output: optional string or null`

140616 141228 

140617 The output from the tool call.141229 The output from the tool call.

143155 for reasoning items returned by `POST /v1/responses` and WebSocket143767 for reasoning items returned by `POST /v1/responses` and WebSocket

143156 `response.create` requests.143768 `response.create` requests.

143157 143769 

143770 When streaming, use the completed reasoning item and its

143771 `encrypted_content` from the `response.output_item.done` event in

143772 subsequent requests. The `encrypted_content` in

143773 `response.output_item.added` may be incomplete. This is especially

143774 important when `store` is `false` or when using Zero Data Retention.

143775 

143158 - `status: optional "in_progress" or "completed" or "incomplete"`143776 - `status: optional "in_progress" or "completed" or "incomplete"`

143159 143777 

143160 The status of the item. One of `in_progress`, `completed`, or143778 The status of the item. One of `in_progress`, `completed`, or

146182 Unique identifier for the MCP tool call approval request.146800 Unique identifier for the MCP tool call approval request.

146183 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.146801 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

146184 146802 

146185 - `error: optional string or null`146803 - `error: optional BetaMcpToolCallError or null`

146186 146804 

146187 The error from the tool call, if any.146805 The error from the tool call, if any.

146188 146806 

146807 - `McpProtocolError object { code, message, type }`

146808 

146809 - `code: number`

146810 

146811 - `message: string`

146812 

146813 - `type: "mcp_protocol_error"`

146814 

146815 - `"mcp_protocol_error"`

146816 

146817 - `McpToolExecutionError object { content, type }`

146818 

146819 - `content: unknown`

146820 

146821 - `type: "mcp_tool_execution_error"`

146822 

146823 - `"mcp_tool_execution_error"`

146824 

146825 - `HTTPError object { code, message, type }`

146826 

146827 - `code: number`

146828 

146829 - `message: string`

146830 

146831 - `type: "http_error"`

146832 

146833 - `"http_error"`

146834 

146189 - `output: optional string or null`146835 - `output: optional string or null`

146190 146836 

146191 The output from the tool call.146837 The output from the tool call.

146476 147122 

146477 - `item: BetaResponseOutputItem`147123 - `item: BetaResponseOutputItem`

146478 147124 

146479 The output item that was added.147125 The output item that was added. For reasoning items, `encrypted_content`

147126 may be incomplete while the item is in progress. Use the reasoning item

147127 from the corresponding `response.output_item.done` event when passing it

147128 as input to a subsequent request.

146480 147129 

146481 - `BetaResponseOutputMessage object { id, content, role, 4 more }`147130 - `BetaResponseOutputMessage object { id, content, role, 4 more }`

146482 147131 

147791 for reasoning items returned by `POST /v1/responses` and WebSocket148440 for reasoning items returned by `POST /v1/responses` and WebSocket

147792 `response.create` requests.148441 `response.create` requests.

147793 148442 

148443 When streaming, use the completed reasoning item and its

148444 `encrypted_content` from the `response.output_item.done` event in

148445 subsequent requests. The `encrypted_content` in

148446 `response.output_item.added` may be incomplete. This is especially

148447 important when `store` is `false` or when using Zero Data Retention.

148448 

147794 - `status: optional "in_progress" or "completed" or "incomplete"`148449 - `status: optional "in_progress" or "completed" or "incomplete"`

147795 148450 

147796 The status of the item. One of `in_progress`, `completed`, or148451 The status of the item. One of `in_progress`, `completed`, or

150818 Unique identifier for the MCP tool call approval request.151473 Unique identifier for the MCP tool call approval request.

150819 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.151474 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

150820 151475 

150821 - `error: optional string or null`151476 - `error: optional BetaMcpToolCallError or null`

150822 151477 

150823 The error from the tool call, if any.151478 The error from the tool call, if any.

150824 151479 

151480 - `McpProtocolError object { code, message, type }`

151481 

151482 - `code: number`

151483 

151484 - `message: string`

151485 

151486 - `type: "mcp_protocol_error"`

151487 

151488 - `"mcp_protocol_error"`

151489 

151490 - `McpToolExecutionError object { content, type }`

151491 

151492 - `content: unknown`

151493 

151494 - `type: "mcp_tool_execution_error"`

151495 

151496 - `"mcp_tool_execution_error"`

151497 

151498 - `HTTPError object { code, message, type }`

151499 

151500 - `code: number`

151501 

151502 - `message: string`

151503 

151504 - `type: "http_error"`

151505 

151506 - `"http_error"`

151507 

150825 - `output: optional string or null`151508 - `output: optional string or null`

150826 151509 

150827 The output from the tool call.151510 The output from the tool call.

152449 for reasoning items returned by `POST /v1/responses` and WebSocket153132 for reasoning items returned by `POST /v1/responses` and WebSocket

152450 `response.create` requests.153133 `response.create` requests.

152451 153134 

153135 When streaming, use the completed reasoning item and its

153136 `encrypted_content` from the `response.output_item.done` event in

153137 subsequent requests. The `encrypted_content` in

153138 `response.output_item.added` may be incomplete. This is especially

153139 important when `store` is `false` or when using Zero Data Retention.

153140 

152452 - `status: optional "in_progress" or "completed" or "incomplete"`153141 - `status: optional "in_progress" or "completed" or "incomplete"`

152453 153142 

152454 The status of the item. One of `in_progress`, `completed`, or153143 The status of the item. One of `in_progress`, `completed`, or

155476 Unique identifier for the MCP tool call approval request.156165 Unique identifier for the MCP tool call approval request.

155477 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.156166 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

155478 156167 

155479 - `error: optional string or null`156168 - `error: optional BetaMcpToolCallError or null`

155480 156169 

155481 The error from the tool call, if any.156170 The error from the tool call, if any.

155482 156171 

156172 - `McpProtocolError object { code, message, type }`

156173 

156174 - `code: number`

156175 

156176 - `message: string`

156177 

156178 - `type: "mcp_protocol_error"`

156179 

156180 - `"mcp_protocol_error"`

156181 

156182 - `McpToolExecutionError object { content, type }`

156183 

156184 - `content: unknown`

156185 

156186 - `type: "mcp_tool_execution_error"`

156187 

156188 - `"mcp_tool_execution_error"`

156189 

156190 - `HTTPError object { code, message, type }`

156191 

156192 - `code: number`

156193 

156194 - `message: string`

156195 

156196 - `type: "http_error"`

156197 

156198 - `"http_error"`

156199 

155483 - `output: optional string or null`156200 - `output: optional string or null`

155484 156201 

155485 The output from the tool call.156202 The output from the tool call.

156137 156854 

156138 Emitted when an annotation is added to output text content.156855 Emitted when an annotation is added to output text content.

156139 156856 

156140 - `annotation: unknown`156857 - `annotation: object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type } or null`

156858 

156859 An annotation that applies to a span of output text.

156860 

156861 - `FileCitation object { file_id, filename, index, type }`

156862 

156863 A citation to a file.

156864 

156865 - `file_id: string`

156866 

156867 The ID of the file.

156868 

156869 - `filename: string`

156870 

156871 The filename of the file cited.

156872 

156873 - `index: number`

156874 

156875 The index of the file in the list of files.

156876 

156877 - `type: "file_citation"`

156878 

156879 The type of the file citation. Always `file_citation`.

156880 

156881 - `"file_citation"`

156882 

156883 - `URLCitation object { end_index, start_index, title, 2 more }`

156884 

156885 A citation for a web resource used to generate a model response.

156886 

156887 - `end_index: number`

156888 

156889 The index of the last character of the URL citation in the message.

156890 

156891 - `start_index: number`

156892 

156893 The index of the first character of the URL citation in the message.

156894 

156895 - `title: string`

156896 

156897 The title of the web resource.

156898 

156899 - `type: "url_citation"`

156900 

156901 The type of the URL citation. Always `url_citation`.

156141 156902 

156142 The annotation object being added. (See annotation schema for details.)156903 - `"url_citation"`

156904 

156905 - `url: string`

156906 

156907 The URL of the web resource.

156908 

156909 - `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`

156910 

156911 A citation for a container file used to generate a model response.

156912 

156913 - `container_id: string`

156914 

156915 The ID of the container file.

156916 

156917 - `end_index: number`

156918 

156919 The index of the last character of the container file citation in the message.

156920 

156921 - `file_id: string`

156922 

156923 The ID of the file.

156924 

156925 - `filename: string`

156926 

156927 The filename of the container file cited.

156928 

156929 - `start_index: number`

156930 

156931 The index of the first character of the container file citation in the message.

156932 

156933 - `type: "container_file_citation"`

156934 

156935 The type of the container file citation. Always `container_file_citation`.

156936 

156937 - `"container_file_citation"`

156938 

156939 - `FilePath object { file_id, index, type }`

156940 

156941 A path to a file.

156942 

156943 - `file_id: string`

156944 

156945 The ID of the file.

156946 

156947 - `index: number`

156948 

156949 The index of the file in the list of files.

156950 

156951 - `type: "file_path"`

156952 

156953 The type of the file path. Always `file_path`.

156954 

156955 - `"file_path"`

156143 156956 

156144 - `annotation_index: number`156957 - `annotation_index: number`

156145 156958 

160160 for reasoning items returned by `POST /v1/responses` and WebSocket160973 for reasoning items returned by `POST /v1/responses` and WebSocket

160161 `response.create` requests.160974 `response.create` requests.

160162 160975 

160976 When streaming, use the completed reasoning item and its

160977 `encrypted_content` from the `response.output_item.done` event in

160978 subsequent requests. The `encrypted_content` in

160979 `response.output_item.added` may be incomplete. This is especially

160980 important when `store` is `false` or when using Zero Data Retention.

160981 

160163 - `status: optional "in_progress" or "completed" or "incomplete"`160982 - `status: optional "in_progress" or "completed" or "incomplete"`

160164 160983 

160165 The status of the item. One of `in_progress`, `completed`, or160984 The status of the item. One of `in_progress`, `completed`, or

160933 Unique identifier for the MCP tool call approval request.161752 Unique identifier for the MCP tool call approval request.

160934 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.161753 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

160935 161754 

160936 - `error: optional string or null`161755 - `error: optional BetaMcpToolCallError or null`

160937 161756 

160938 The error from the tool call, if any.161757 The error from the tool call, if any.

160939 161758 

161759 - `McpProtocolError object { code, message, type }`

161760 

161761 - `code: number`

161762 

161763 - `message: string`

161764 

161765 - `type: "mcp_protocol_error"`

161766 

161767 - `"mcp_protocol_error"`

161768 

161769 - `McpToolExecutionError object { content, type }`

161770 

161771 - `content: unknown`

161772 

161773 - `type: "mcp_tool_execution_error"`

161774 

161775 - `"mcp_tool_execution_error"`

161776 

161777 - `HTTPError object { code, message, type }`

161778 

161779 - `code: number`

161780 

161781 - `message: string`

161782 

161783 - `type: "http_error"`

161784 

161785 - `"http_error"`

161786 

160940 - `output: optional string or null`161787 - `output: optional string or null`

160941 161788 

160942 The output from the tool call.161789 The output from the tool call.

162222 for reasoning items returned by `POST /v1/responses` and WebSocket163069 for reasoning items returned by `POST /v1/responses` and WebSocket

162223 `response.create` requests.163070 `response.create` requests.

162224 163071 

163072 When streaming, use the completed reasoning item and its

163073 `encrypted_content` from the `response.output_item.done` event in

163074 subsequent requests. The `encrypted_content` in

163075 `response.output_item.added` may be incomplete. This is especially

163076 important when `store` is `false` or when using Zero Data Retention.

163077 

162225 - `status: optional "in_progress" or "completed" or "incomplete"`163078 - `status: optional "in_progress" or "completed" or "incomplete"`

162226 163079 

162227 The status of the item. One of `in_progress`, `completed`, or163080 The status of the item. One of `in_progress`, `completed`, or

165099 Unique identifier for the MCP tool call approval request.165952 Unique identifier for the MCP tool call approval request.

165100 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.165953 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

165101 165954 

165102 - `error: optional string or null`165955 - `error: optional BetaMcpToolCallError or null`

165103 165956 

165104 The error from the tool call, if any.165957 The error from the tool call, if any.

165105 165958 

171609 for reasoning items returned by `POST /v1/responses` and WebSocket172462 for reasoning items returned by `POST /v1/responses` and WebSocket

171610 `response.create` requests.172463 `response.create` requests.

171611 172464 

172465 When streaming, use the completed reasoning item and its

172466 `encrypted_content` from the `response.output_item.done` event in

172467 subsequent requests. The `encrypted_content` in

172468 `response.output_item.added` may be incomplete. This is especially

172469 important when `store` is `false` or when using Zero Data Retention.

172470 

171612 - `status: optional "in_progress" or "completed" or "incomplete"`172471 - `status: optional "in_progress" or "completed" or "incomplete"`

171613 172472 

171614 The status of the item. One of `in_progress`, `completed`, or172473 The status of the item. One of `in_progress`, `completed`, or

172382 Unique identifier for the MCP tool call approval request.173241 Unique identifier for the MCP tool call approval request.

172383 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.173242 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

172384 173243 

172385 - `error: optional string or null`173244 - `error: optional BetaMcpToolCallError or null`

172386 173245 

172387 The error from the tool call, if any.173246 The error from the tool call, if any.

172388 173247 

173248 - `McpProtocolError object { code, message, type }`

173249 

173250 - `code: number`

173251 

173252 - `message: string`

173253 

173254 - `type: "mcp_protocol_error"`

173255 

173256 - `"mcp_protocol_error"`

173257 

173258 - `McpToolExecutionError object { content, type }`

173259 

173260 - `content: unknown`

173261 

173262 - `type: "mcp_tool_execution_error"`

173263 

173264 - `"mcp_tool_execution_error"`

173265 

173266 - `HTTPError object { code, message, type }`

173267 

173268 - `code: number`

173269 

173270 - `message: string`

173271 

173272 - `type: "http_error"`

173273 

173274 - `"http_error"`

173275 

172389 - `output: optional string or null`173276 - `output: optional string or null`

172390 173277 

172391 The output from the tool call.173278 The output from the tool call.

173671 for reasoning items returned by `POST /v1/responses` and WebSocket174558 for reasoning items returned by `POST /v1/responses` and WebSocket

173672 `response.create` requests.174559 `response.create` requests.

173673 174560 

174561 When streaming, use the completed reasoning item and its

174562 `encrypted_content` from the `response.output_item.done` event in

174563 subsequent requests. The `encrypted_content` in

174564 `response.output_item.added` may be incomplete. This is especially

174565 important when `store` is `false` or when using Zero Data Retention.

174566 

173674 - `status: optional "in_progress" or "completed" or "incomplete"`174567 - `status: optional "in_progress" or "completed" or "incomplete"`

173675 174568 

173676 The status of the item. One of `in_progress`, `completed`, or174569 The status of the item. One of `in_progress`, `completed`, or

176548 Unique identifier for the MCP tool call approval request.177441 Unique identifier for the MCP tool call approval request.

176549 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.177442 Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.

176550 177443 

176551 - `error: optional string or null`177444 - `error: optional BetaMcpToolCallError or null`

176552 177445 

176553 The error from the tool call, if any.177446 The error from the tool call, if any.

176554 177447 

179006 179899 

179007 - `item: BetaResponseOutputItem`179900 - `item: BetaResponseOutputItem`

179008 179901 

179009 The output item that was added.179902 The output item that was added. For reasoning items, `encrypted_content`

179903 may be incomplete while the item is in progress. Use the reasoning item

179904 from the corresponding `response.output_item.done` event when passing it

179905 as input to a subsequent request.

179010 179906 

179011 - `BetaResponseOutputMessage object { id, content, role, 4 more }`179907 - `BetaResponseOutputMessage object { id, content, role, 4 more }`

179012 179908 

179804 180700 

179805 The canonical name of the agent that produced this item.180701 The canonical name of the agent that produced this item.

179806 180702 

179807 - `BetaResponseImageGenCallPartialImageEvent object { item_id, output_index, partial_image_b64, 4 more }`180703 - `BetaResponseImageGenCallPartialImageEvent object { item_id, output_index, partial_image_b64, 8 more }`

179808 180704 

179809 Emitted when a partial image is available during image generation streaming.180705 Emitted when a partial image is available during image generation streaming.

179810 180706 

179842 180738 

179843 The canonical name of the agent that produced this item.180739 The canonical name of the agent that produced this item.

179844 180740 

180741 - `background: optional string`

180742 

180743 The background setting that was used.

180744 

180745 - `output_format: optional string`

180746 

180747 The output format that was used.

180748 

180749 - `quality: optional string`

180750 

180751 The image quality that was used.

180752 

180753 - `size: optional string`

180754 

180755 The image size that was used.

180756 

179845 - `BetaResponseMcpCallArgumentsDeltaEvent object { delta, item_id, output_index, 3 more }`180757 - `BetaResponseMcpCallArgumentsDeltaEvent object { delta, item_id, output_index, 3 more }`

179846 180758 

179847 Emitted when there is a delta (partial update) to the arguments of an MCP tool call.180759 Emitted when there is a delta (partial update) to the arguments of an MCP tool call.

180094 181006 

180095 Emitted when an annotation is added to output text content.181007 Emitted when an annotation is added to output text content.

180096 181008 

180097 - `annotation: unknown`181009 - `annotation: object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type } or null`

181010 

181011 An annotation that applies to a span of output text.

181012 

181013 - `FileCitation object { file_id, filename, index, type }`

181014 

181015 A citation to a file.

181016 

181017 - `file_id: string`

181018 

181019 The ID of the file.

181020 

181021 - `filename: string`

181022 

181023 The filename of the file cited.

181024 

181025 - `index: number`

181026 

181027 The index of the file in the list of files.

181028 

181029 - `type: "file_citation"`

181030 

181031 The type of the file citation. Always `file_citation`.

181032 

181033 - `"file_citation"`

181034 

181035 - `URLCitation object { end_index, start_index, title, 2 more }`

181036 

181037 A citation for a web resource used to generate a model response.

181038 

181039 - `end_index: number`

181040 

181041 The index of the last character of the URL citation in the message.

181042 

181043 - `start_index: number`

181044 

181045 The index of the first character of the URL citation in the message.

181046 

181047 - `title: string`

180098 181048 

180099 The annotation object being added. (See annotation schema for details.)181049 The title of the web resource.

181050 

181051 - `type: "url_citation"`

181052 

181053 The type of the URL citation. Always `url_citation`.

181054 

181055 - `"url_citation"`

181056 

181057 - `url: string`

181058 

181059 The URL of the web resource.

181060 

181061 - `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`

181062 

181063 A citation for a container file used to generate a model response.

181064 

181065 - `container_id: string`

181066 

181067 The ID of the container file.

181068 

181069 - `end_index: number`

181070 

181071 The index of the last character of the container file citation in the message.

181072 

181073 - `file_id: string`

181074 

181075 The ID of the file.

181076 

181077 - `filename: string`

181078 

181079 The filename of the container file cited.

181080 

181081 - `start_index: number`

181082 

181083 The index of the first character of the container file citation in the message.