SpyBara
Go Premium

Reference 2026-08-12 16:01 UTC to 2026-08-13 22:00 UTC

42 files changed +16,186 −38,221. View all changes and history on the product overview
2026
Fri 14 15:02 Thu 13 22:00 Wed 12 16:01 Tue 11 22:59 Mon 10 22:00 Sat 8 00:59 Fri 7 21:59 Thu 6 18:59 Wed 5 02:01 Tue 4 22:59 Mon 3 21:58 Sat 1 01:00
Details

4 4 

5### All Models5### All Models

6 6 

7- `AllModels = string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more`7- `AllModels = string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`

8 8 

9 - `string`9 - `string`

10 10 

11 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more`11 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`

12 12 

13 - `"gpt-5.6-sol"`13 - `"gpt-5.6-sol"`

14 14 


18 18 

19 - `"gpt-5.5"`19 - `"gpt-5.5"`

20 20 

21 - `"gpt-5.5-2026-04-23"`

22 

21 - `"gpt-5.4"`23 - `"gpt-5.4"`

22 24 

23 - `"gpt-5.4-mini"`25 - `"gpt-5.4-mini"`


174 176 

175 - `"gpt-3.5-turbo-16k-0613"`177 - `"gpt-3.5-turbo-16k-0613"`

176 178 

177 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more`179 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`

178 180 

179 - `"o1-pro"`181 - `"o1-pro"`

180 182 


196 198 

197 - `"computer-use-preview-2025-03-11"`199 - `"computer-use-preview-2025-03-11"`

198 200 

201 - `"gpt-5.5-pro"`

202 

203 - `"gpt-5.5-pro-2026-04-23"`

204 

199 - `"gpt-5-codex"`205 - `"gpt-5-codex"`

200 206 

201 - `"gpt-5-pro"`207 - `"gpt-5-pro"`


649 655 

650### Responses Model656### Responses Model

651 657 

652- `ResponsesModel = string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more`658- `ResponsesModel = string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`

653 659 

654 - `string`660 - `string`

655 661 

656 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more`662 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`

657 663 

658 - `"gpt-5.6-sol"`664 - `"gpt-5.6-sol"`

659 665 


663 669 

664 - `"gpt-5.5"`670 - `"gpt-5.5"`

665 671 

672 - `"gpt-5.5-2026-04-23"`

673 

666 - `"gpt-5.4"`674 - `"gpt-5.4"`

667 675 

668 - `"gpt-5.4-mini"`676 - `"gpt-5.4-mini"`


819 827 

820 - `"gpt-3.5-turbo-16k-0613"`828 - `"gpt-3.5-turbo-16k-0613"`

821 829 

822 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more`830 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`

823 831 

824 - `"o1-pro"`832 - `"o1-pro"`

825 833 


841 849 

842 - `"computer-use-preview-2025-03-11"`850 - `"computer-use-preview-2025-03-11"`

843 851 

852 - `"gpt-5.5-pro"`

853 

854 - `"gpt-5.5-pro-2026-04-23"`

855 

844 - `"gpt-5-codex"`856 - `"gpt-5-codex"`

845 857 

846 - `"gpt-5-pro"`858 - `"gpt-5-pro"`

Details

1855 1855 

1856 - `"computer_use_preview"`1856 - `"computer_use_preview"`

1857 1857 

1858 - `WebSearch object { type, filters, search_context_size, user_location }`1858 - `WebSearch object { type, external_web_access, filters, 2 more }`

1859 1859 

1860 Search the Internet for sources related to the prompt. Learn more about the1860 Search the Internet for sources related to the prompt. Learn more about the

1861 [web search tool](/docs/guides/tools-web-search).1861 [web search tool](/docs/guides/tools-web-search).


1868 1868 

1869 - `"web_search_2025_08_26"`1869 - `"web_search_2025_08_26"`

1870 1870 

1871 - `external_web_access: optional boolean`

1872 

1873 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1874 

1871 - `filters: optional object { allowed_domains } or null`1875 - `filters: optional object { allowed_domains } or null`

1872 1876 

1873 Filters for the search.1877 Filters for the search.


3046 3050 

3047 - `"computer_use_preview"`3051 - `"computer_use_preview"`

3048 3052 

3049 - `WebSearch object { type, filters, search_context_size, user_location }`3053 - `WebSearch object { type, external_web_access, filters, 2 more }`

3050 3054 

3051 Search the Internet for sources related to the prompt. Learn more about the3055 Search the Internet for sources related to the prompt. Learn more about the

3052 [web search tool](/docs/guides/tools-web-search).3056 [web search tool](/docs/guides/tools-web-search).


3059 3063 

3060 - `"web_search_2025_08_26"`3064 - `"web_search_2025_08_26"`

3061 3065 

3066 - `external_web_access: optional boolean`

3067 

3068 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

3069 

3062 - `filters: optional object { allowed_domains } or null`3070 - `filters: optional object { allowed_domains } or null`

3063 3071 

3064 Filters for the search.3072 Filters for the search.


4899 Keys are strings with a maximum length of 64 characters. Values are strings4907 Keys are strings with a maximum length of 64 characters. Values are strings

4900 with a maximum length of 512 characters.4908 with a maximum length of 512 characters.

4901 4909 

4902 - `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more or string`4910 - `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more or string`

4903 4911 

4904 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI4912 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

4905 offers a wide range of models with different capabilities, performance4913 offers a wide range of models with different capabilities, performance

4906 characteristics, and price points. Refer to the [model guide](/docs/models)4914 characteristics, and price points. Refer to the [model guide](/docs/models)

4907 to browse and compare available models.4915 to browse and compare available models.

4908 4916 

4909 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more`4917 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more`

4910 4918 

4911 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI4919 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

4912 offers a wide range of models with different capabilities, performance4920 offers a wide range of models with different capabilities, performance


4921 4929 

4922 - `"gpt-5.5"`4930 - `"gpt-5.5"`

4923 4931 

4932 - `"gpt-5.5-2026-04-23"`

4933 

4924 - `"gpt-5.4"`4934 - `"gpt-5.4"`

4925 4935 

4926 - `"gpt-5.4-mini"`4936 - `"gpt-5.4-mini"`


5097 5107 

5098 - `"computer-use-preview-2025-03-11"`5108 - `"computer-use-preview-2025-03-11"`

5099 5109 

5110 - `"gpt-5.5-pro"`

5111 

5112 - `"gpt-5.5-pro-2026-04-23"`

5113 

5100 - `"gpt-5-codex"`5114 - `"gpt-5-codex"`

5101 5115 

5102 - `"gpt-5-pro"`5116 - `"gpt-5-pro"`


6329 6343 

6330 - `"computer_use_preview"`6344 - `"computer_use_preview"`

6331 6345 

6332 - `WebSearch object { type, filters, search_context_size, user_location }`6346 - `WebSearch object { type, external_web_access, filters, 2 more }`

6333 6347 

6334 Search the Internet for sources related to the prompt. Learn more about the6348 Search the Internet for sources related to the prompt. Learn more about the

6335 [web search tool](/docs/guides/tools-web-search).6349 [web search tool](/docs/guides/tools-web-search).


6342 6356 

6343 - `"web_search_2025_08_26"`6357 - `"web_search_2025_08_26"`

6344 6358 

6359 - `external_web_access: optional boolean`

6360 

6361 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

6362 

6345 - `filters: optional object { allowed_domains } or null`6363 - `filters: optional object { allowed_domains } or null`

6346 6364 

6347 Filters for the search.6365 Filters for the search.


7366 7384 

7367 - `"computer_use_preview"`7385 - `"computer_use_preview"`

7368 7386 

7369 - `WebSearch object { type, filters, search_context_size, user_location }`7387 - `WebSearch object { type, external_web_access, filters, 2 more }`

7370 7388 

7371 Search the Internet for sources related to the prompt. Learn more about the7389 Search the Internet for sources related to the prompt. Learn more about the

7372 [web search tool](/docs/guides/tools-web-search).7390 [web search tool](/docs/guides/tools-web-search).


7379 7397 

7380 - `"web_search_2025_08_26"`7398 - `"web_search_2025_08_26"`

7381 7399 

7400 - `external_web_access: optional boolean`

7401 

7402 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

7403 

7382 - `filters: optional object { allowed_domains } or null`7404 - `filters: optional object { allowed_domains } or null`

7383 7405 

7384 Filters for the search.7406 Filters for the search.


9522 9544 

9523 - `"computer_use_preview"`9545 - `"computer_use_preview"`

9524 9546 

9525 - `WebSearch object { type, filters, search_context_size, user_location }`9547 - `WebSearch object { type, external_web_access, filters, 2 more }`

9526 9548 

9527 Search the Internet for sources related to the prompt. Learn more about the9549 Search the Internet for sources related to the prompt. Learn more about the

9528 [web search tool](/docs/guides/tools-web-search).9550 [web search tool](/docs/guides/tools-web-search).


9535 9557 

9536 - `"web_search_2025_08_26"`9558 - `"web_search_2025_08_26"`

9537 9559 

9560 - `external_web_access: optional boolean`

9561 

9562 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

9563 

9538 - `filters: optional object { allowed_domains } or null`9564 - `filters: optional object { allowed_domains } or null`

9539 9565 

9540 Filters for the search.9566 Filters for the search.


10588 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.10614 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.

10589 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).10615 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).

10590 10616 

10591 - `service_tier: optional "auto" or "default" or "flex" or 3 more or null`10617 - `service_tier: optional "auto" or "default" or "flex" or 4 more or null`

10592 10618 

10593 Specifies the processing type used for serving the request.10619 Specifies the processing type used for serving the request.

10594 10620 


10596 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.10622 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.

10597 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.10623 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.

10598 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.10624 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.

10625 - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`.

10599 - When not set, the default behavior is 'auto'.10626 - When not set, the default behavior is 'auto'.

10600 10627 

10601 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.10628 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.


10612 10639 

10613 - `"fast"`10640 - `"fast"`

10614 10641 

10642 - `"ultrafast"`

10643 

10615 - `status: optional BetaResponseStatus`10644 - `status: optional BetaResponseStatus`

10616 10645 

10617 The status of the response generation. One of `completed`, `failed`,10646 The status of the response generation. One of `completed`, `failed`,

Details

14 14 

15### Body Parameters15### Body Parameters

16 16 

17- `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more or string or null`17- `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more or string or null`

18 18 

19 Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.19 Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.

20 20 

21 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more`21 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more`

22 22 

23 Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.23 Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.

24 24 


30 30 

31 - `"gpt-5.5"`31 - `"gpt-5.5"`

32 32 

33 - `"gpt-5.5-2026-04-23"`

34 

33 - `"gpt-5.4"`35 - `"gpt-5.4"`

34 36 

35 - `"gpt-5.4-mini"`37 - `"gpt-5.4-mini"`


206 208 

207 - `"computer-use-preview-2025-03-11"`209 - `"computer-use-preview-2025-03-11"`

208 210 

211 - `"gpt-5.5-pro"`

212 

213 - `"gpt-5.5-pro-2026-04-23"`

214 

209 - `"gpt-5-codex"`215 - `"gpt-5-codex"`

210 216 

211 - `"gpt-5-pro"`217 - `"gpt-5-pro"`


1979 1985 

1980 - `"computer_use_preview"`1986 - `"computer_use_preview"`

1981 1987 

1982 - `WebSearch object { type, filters, search_context_size, user_location }`1988 - `WebSearch object { type, external_web_access, filters, 2 more }`

1983 1989 

1984 Search the Internet for sources related to the prompt. Learn more about the1990 Search the Internet for sources related to the prompt. Learn more about the

1985 [web search tool](/docs/guides/tools-web-search).1991 [web search tool](/docs/guides/tools-web-search).


1992 1998 

1993 - `"web_search_2025_08_26"`1999 - `"web_search_2025_08_26"`

1994 2000 

2001 - `external_web_access: optional boolean`

2002 

2003 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2004 

1995 - `filters: optional object { allowed_domains } or null`2005 - `filters: optional object { allowed_domains } or null`

1996 2006 

1997 Filters for the search.2007 Filters for the search.


3170 3180 

3171 - `"computer_use_preview"`3181 - `"computer_use_preview"`

3172 3182 

3173 - `WebSearch object { type, filters, search_context_size, user_location }`3183 - `WebSearch object { type, external_web_access, filters, 2 more }`

3174 3184 

3175 Search the Internet for sources related to the prompt. Learn more about the3185 Search the Internet for sources related to the prompt. Learn more about the

3176 [web search tool](/docs/guides/tools-web-search).3186 [web search tool](/docs/guides/tools-web-search).


3183 3193 

3184 - `"web_search_2025_08_26"`3194 - `"web_search_2025_08_26"`

3185 3195 

3196 - `external_web_access: optional boolean`

3197 

3198 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

3199 

3186 - `filters: optional object { allowed_domains } or null`3200 - `filters: optional object { allowed_domains } or null`

3187 3201 

3188 Filters for the search.3202 Filters for the search.


6080 6094 

6081 - `"computer_use_preview"`6095 - `"computer_use_preview"`

6082 6096 

6083 - `WebSearch object { type, filters, search_context_size, user_location }`6097 - `WebSearch object { type, external_web_access, filters, 2 more }`

6084 6098 

6085 Search the Internet for sources related to the prompt. Learn more about the6099 Search the Internet for sources related to the prompt. Learn more about the

6086 [web search tool](/docs/guides/tools-web-search).6100 [web search tool](/docs/guides/tools-web-search).


6093 6107 

6094 - `"web_search_2025_08_26"`6108 - `"web_search_2025_08_26"`

6095 6109 

6110 - `external_web_access: optional boolean`

6111 

6112 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

6113 

6096 - `filters: optional object { allowed_domains } or null`6114 - `filters: optional object { allowed_domains } or null`

6097 6115 

6098 Filters for the search.6116 Filters for the search.


7267 7285 

7268 - `"computer_use_preview"`7286 - `"computer_use_preview"`

7269 7287 

7270 - `WebSearch object { type, filters, search_context_size, user_location }`7288 - `WebSearch object { type, external_web_access, filters, 2 more }`

7271 7289 

7272 Search the Internet for sources related to the prompt. Learn more about the7290 Search the Internet for sources related to the prompt. Learn more about the

7273 [web search tool](/docs/guides/tools-web-search).7291 [web search tool](/docs/guides/tools-web-search).


7280 7298 

7281 - `"web_search_2025_08_26"`7299 - `"web_search_2025_08_26"`

7282 7300 

7301 - `external_web_access: optional boolean`

7302 

7303 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

7304 

7283 - `filters: optional object { allowed_domains } or null`7305 - `filters: optional object { allowed_domains } or null`

7284 7306 

7285 Filters for the search.7307 Filters for the search.

Details

1847 1847 

1848 - `"computer_use_preview"`1848 - `"computer_use_preview"`

1849 1849 

1850 - `WebSearch object { type, filters, search_context_size, user_location }`1850 - `WebSearch object { type, external_web_access, filters, 2 more }`

1851 1851 

1852 Search the Internet for sources related to the prompt. Learn more about the1852 Search the Internet for sources related to the prompt. Learn more about the

1853 [web search tool](/docs/guides/tools-web-search).1853 [web search tool](/docs/guides/tools-web-search).


1860 1860 

1861 - `"web_search_2025_08_26"`1861 - `"web_search_2025_08_26"`

1862 1862 

1863 - `external_web_access: optional boolean`

1864 

1865 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1866 

1863 - `filters: optional object { allowed_domains } or null`1867 - `filters: optional object { allowed_domains } or null`

1864 1868 

1865 Filters for the search.1869 Filters for the search.


3038 3042 

3039 - `"computer_use_preview"`3043 - `"computer_use_preview"`

3040 3044 

3041 - `WebSearch object { type, filters, search_context_size, user_location }`3045 - `WebSearch object { type, external_web_access, filters, 2 more }`

3042 3046 

3043 Search the Internet for sources related to the prompt. Learn more about the3047 Search the Internet for sources related to the prompt. Learn more about the

3044 [web search tool](/docs/guides/tools-web-search).3048 [web search tool](/docs/guides/tools-web-search).


3051 3055 

3052 - `"web_search_2025_08_26"`3056 - `"web_search_2025_08_26"`

3053 3057 

3058 - `external_web_access: optional boolean`

3059 

3060 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

3061 

3054 - `filters: optional object { allowed_domains } or null`3062 - `filters: optional object { allowed_domains } or null`

3055 3063 

3056 Filters for the search.3064 Filters for the search.


4907 Keys are strings with a maximum length of 64 characters. Values are strings4915 Keys are strings with a maximum length of 64 characters. Values are strings

4908 with a maximum length of 512 characters.4916 with a maximum length of 512 characters.

4909 4917 

4910- `model: optional "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more or string`4918- `model: optional "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more or string`

4911 4919 

4912 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI4920 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

4913 offers a wide range of models with different capabilities, performance4921 offers a wide range of models with different capabilities, performance

4914 characteristics, and price points. Refer to the [model guide](/docs/models)4922 characteristics, and price points. Refer to the [model guide](/docs/models)

4915 to browse and compare available models.4923 to browse and compare available models.

4916 4924 

4917 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more`4925 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more`

4918 4926 

4919 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI4927 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

4920 offers a wide range of models with different capabilities, performance4928 offers a wide range of models with different capabilities, performance


4929 4937 

4930 - `"gpt-5.5"`4938 - `"gpt-5.5"`

4931 4939 

4940 - `"gpt-5.5-2026-04-23"`

4941 

4932 - `"gpt-5.4"`4942 - `"gpt-5.4"`

4933 4943 

4934 - `"gpt-5.4-mini"`4944 - `"gpt-5.4-mini"`


5105 5115 

5106 - `"computer-use-preview-2025-03-11"`5116 - `"computer-use-preview-2025-03-11"`

5107 5117 

5118 - `"gpt-5.5-pro"`

5119 

5120 - `"gpt-5.5-pro-2026-04-23"`

5121 

5108 - `"gpt-5-codex"`5122 - `"gpt-5-codex"`

5109 5123 

5110 - `"gpt-5-pro"`5124 - `"gpt-5-pro"`


5348 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.5362 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.

5349 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).5363 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).

5350 5364 

5351- `service_tier: optional "auto" or "default" or "flex" or 3 more or null`5365- `service_tier: optional "auto" or "default" or "flex" or 4 more or null`

5352 5366 

5353 Specifies the processing type used for serving the request.5367 Specifies the processing type used for serving the request.

5354 5368 


5356 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.5370 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.

5357 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.5371 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.

5358 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.5372 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.

5373 - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`.

5359 - When not set, the default behavior is 'auto'.5374 - When not set, the default behavior is 'auto'.

5360 5375 

5361 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.5376 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.


5372 5387 

5373 - `"fast"`5388 - `"fast"`

5374 5389 

5390 - `"ultrafast"`

5391 

5375- `store: optional boolean or null`5392- `store: optional boolean or null`

5376 5393 

5377 Whether to store the generated model response for later retrieval via5394 Whether to store the generated model response for later retrieval via


5945 5962 

5946 - `"computer_use_preview"`5963 - `"computer_use_preview"`

5947 5964 

5948 - `WebSearch object { type, filters, search_context_size, user_location }`5965 - `WebSearch object { type, external_web_access, filters, 2 more }`

5949 5966 

5950 Search the Internet for sources related to the prompt. Learn more about the5967 Search the Internet for sources related to the prompt. Learn more about the

5951 [web search tool](/docs/guides/tools-web-search).5968 [web search tool](/docs/guides/tools-web-search).


5958 5975 

5959 - `"web_search_2025_08_26"`5976 - `"web_search_2025_08_26"`

5960 5977 

5978 - `external_web_access: optional boolean`

5979 

5980 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

5981 

5961 - `filters: optional object { allowed_domains } or null`5982 - `filters: optional object { allowed_domains } or null`

5962 5983 

5963 Filters for the search.5984 Filters for the search.


8551 8572 

8552 - `"computer_use_preview"`8573 - `"computer_use_preview"`

8553 8574 

8554 - `WebSearch object { type, filters, search_context_size, user_location }`8575 - `WebSearch object { type, external_web_access, filters, 2 more }`

8555 8576 

8556 Search the Internet for sources related to the prompt. Learn more about the8577 Search the Internet for sources related to the prompt. Learn more about the

8557 [web search tool](/docs/guides/tools-web-search).8578 [web search tool](/docs/guides/tools-web-search).


8564 8585 

8565 - `"web_search_2025_08_26"`8586 - `"web_search_2025_08_26"`

8566 8587 

8588 - `external_web_access: optional boolean`

8589 

8590 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

8591 

8567 - `filters: optional object { allowed_domains } or null`8592 - `filters: optional object { allowed_domains } or null`

8568 8593 

8569 Filters for the search.8594 Filters for the search.


9742 9767 

9743 - `"computer_use_preview"`9768 - `"computer_use_preview"`

9744 9769 

9745 - `WebSearch object { type, filters, search_context_size, user_location }`9770 - `WebSearch object { type, external_web_access, filters, 2 more }`

9746 9771 

9747 Search the Internet for sources related to the prompt. Learn more about the9772 Search the Internet for sources related to the prompt. Learn more about the

9748 [web search tool](/docs/guides/tools-web-search).9773 [web search tool](/docs/guides/tools-web-search).


9755 9780 

9756 - `"web_search_2025_08_26"`9781 - `"web_search_2025_08_26"`

9757 9782 

9783 - `external_web_access: optional boolean`

9784 

9785 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

9786 

9758 - `filters: optional object { allowed_domains } or null`9787 - `filters: optional object { allowed_domains } or null`

9759 9788 

9760 Filters for the search.9789 Filters for the search.


11595 Keys are strings with a maximum length of 64 characters. Values are strings11624 Keys are strings with a maximum length of 64 characters. Values are strings

11596 with a maximum length of 512 characters.11625 with a maximum length of 512 characters.

11597 11626 

11598 - `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more or string`11627 - `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more or string`

11599 11628 

11600 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI11629 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

11601 offers a wide range of models with different capabilities, performance11630 offers a wide range of models with different capabilities, performance

11602 characteristics, and price points. Refer to the [model guide](/docs/models)11631 characteristics, and price points. Refer to the [model guide](/docs/models)

11603 to browse and compare available models.11632 to browse and compare available models.

11604 11633 

11605 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more`11634 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more`

11606 11635 

11607 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI11636 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

11608 offers a wide range of models with different capabilities, performance11637 offers a wide range of models with different capabilities, performance


11617 11646 

11618 - `"gpt-5.5"`11647 - `"gpt-5.5"`

11619 11648 

11649 - `"gpt-5.5-2026-04-23"`

11650 

11620 - `"gpt-5.4"`11651 - `"gpt-5.4"`

11621 11652 

11622 - `"gpt-5.4-mini"`11653 - `"gpt-5.4-mini"`


11793 11824 

11794 - `"computer-use-preview-2025-03-11"`11825 - `"computer-use-preview-2025-03-11"`

11795 11826 

11827 - `"gpt-5.5-pro"`

11828 

11829 - `"gpt-5.5-pro-2026-04-23"`

11830 

11796 - `"gpt-5-codex"`11831 - `"gpt-5-codex"`

11797 11832 

11798 - `"gpt-5-pro"`11833 - `"gpt-5-pro"`


13025 13060 

13026 - `"computer_use_preview"`13061 - `"computer_use_preview"`

13027 13062 

13028 - `WebSearch object { type, filters, search_context_size, user_location }`13063 - `WebSearch object { type, external_web_access, filters, 2 more }`

13029 13064 

13030 Search the Internet for sources related to the prompt. Learn more about the13065 Search the Internet for sources related to the prompt. Learn more about the

13031 [web search tool](/docs/guides/tools-web-search).13066 [web search tool](/docs/guides/tools-web-search).


13038 13073 

13039 - `"web_search_2025_08_26"`13074 - `"web_search_2025_08_26"`

13040 13075 

13076 - `external_web_access: optional boolean`

13077 

13078 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

13079 

13041 - `filters: optional object { allowed_domains } or null`13080 - `filters: optional object { allowed_domains } or null`

13042 13081 

13043 Filters for the search.13082 Filters for the search.


14062 14101 

14063 - `"computer_use_preview"`14102 - `"computer_use_preview"`

14064 14103 

14065 - `WebSearch object { type, filters, search_context_size, user_location }`14104 - `WebSearch object { type, external_web_access, filters, 2 more }`

14066 14105 

14067 Search the Internet for sources related to the prompt. Learn more about the14106 Search the Internet for sources related to the prompt. Learn more about the

14068 [web search tool](/docs/guides/tools-web-search).14107 [web search tool](/docs/guides/tools-web-search).


14075 14114 

14076 - `"web_search_2025_08_26"`14115 - `"web_search_2025_08_26"`

14077 14116 

14117 - `external_web_access: optional boolean`

14118 

14119 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

14120 

14078 - `filters: optional object { allowed_domains } or null`14121 - `filters: optional object { allowed_domains } or null`

14079 14122 

14080 Filters for the search.14123 Filters for the search.


16218 16261 

16219 - `"computer_use_preview"`16262 - `"computer_use_preview"`

16220 16263 

16221 - `WebSearch object { type, filters, search_context_size, user_location }`16264 - `WebSearch object { type, external_web_access, filters, 2 more }`

16222 16265 

16223 Search the Internet for sources related to the prompt. Learn more about the16266 Search the Internet for sources related to the prompt. Learn more about the

16224 [web search tool](/docs/guides/tools-web-search).16267 [web search tool](/docs/guides/tools-web-search).


16231 16274 

16232 - `"web_search_2025_08_26"`16275 - `"web_search_2025_08_26"`

16233 16276 

16277 - `external_web_access: optional boolean`

16278 

16279 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

16280 

16234 - `filters: optional object { allowed_domains } or null`16281 - `filters: optional object { allowed_domains } or null`

16235 16282 

16236 Filters for the search.16283 Filters for the search.


17284 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.17331 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.

17285 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).17332 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).

17286 17333 

17287 - `service_tier: optional "auto" or "default" or "flex" or 3 more or null`17334 - `service_tier: optional "auto" or "default" or "flex" or 4 more or null`

17288 17335 

17289 Specifies the processing type used for serving the request.17336 Specifies the processing type used for serving the request.

17290 17337 


17292 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.17339 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.

17293 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.17340 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.

17294 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.17341 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.

17342 - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`.

17295 - When not set, the default behavior is 'auto'.17343 - When not set, the default behavior is 'auto'.

17296 17344 

17297 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.17345 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.


17308 17356 

17309 - `"fast"`17357 - `"fast"`

17310 17358 

17359 - `"ultrafast"`

17360 

17311 - `status: optional BetaResponseStatus`17361 - `status: optional BetaResponseStatus`

17312 17362 

17313 The status of the response generation. One of `completed`, `failed`,17363 The status of the response generation. One of `completed`, `failed`,

Details

1899 1899 

1900 - `"computer_use_preview"`1900 - `"computer_use_preview"`

1901 1901 

1902 - `WebSearch object { type, filters, search_context_size, user_location }`1902 - `WebSearch object { type, external_web_access, filters, 2 more }`

1903 1903 

1904 Search the Internet for sources related to the prompt. Learn more about the1904 Search the Internet for sources related to the prompt. Learn more about the

1905 [web search tool](/docs/guides/tools-web-search).1905 [web search tool](/docs/guides/tools-web-search).


1912 1912 

1913 - `"web_search_2025_08_26"`1913 - `"web_search_2025_08_26"`

1914 1914 

1915 - `external_web_access: optional boolean`

1916 

1917 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1918 

1915 - `filters: optional object { allowed_domains } or null`1919 - `filters: optional object { allowed_domains } or null`

1916 1920 

1917 Filters for the search.1921 Filters for the search.


3090 3094 

3091 - `"computer_use_preview"`3095 - `"computer_use_preview"`

3092 3096 

3093 - `WebSearch object { type, filters, search_context_size, user_location }`3097 - `WebSearch object { type, external_web_access, filters, 2 more }`

3094 3098 

3095 Search the Internet for sources related to the prompt. Learn more about the3099 Search the Internet for sources related to the prompt. Learn more about the

3096 [web search tool](/docs/guides/tools-web-search).3100 [web search tool](/docs/guides/tools-web-search).


3103 3107 

3104 - `"web_search_2025_08_26"`3108 - `"web_search_2025_08_26"`

3105 3109 

3110 - `external_web_access: optional boolean`

3111 

3112 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

3113 

3106 - `filters: optional object { allowed_domains } or null`3114 - `filters: optional object { allowed_domains } or null`

3107 3115 

3108 Filters for the search.3116 Filters for the search.


4943 Keys are strings with a maximum length of 64 characters. Values are strings4951 Keys are strings with a maximum length of 64 characters. Values are strings

4944 with a maximum length of 512 characters.4952 with a maximum length of 512 characters.

4945 4953 

4946 - `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more or string`4954 - `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more or string`

4947 4955 

4948 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI4956 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

4949 offers a wide range of models with different capabilities, performance4957 offers a wide range of models with different capabilities, performance

4950 characteristics, and price points. Refer to the [model guide](/docs/models)4958 characteristics, and price points. Refer to the [model guide](/docs/models)

4951 to browse and compare available models.4959 to browse and compare available models.

4952 4960 

4953 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more`4961 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more`

4954 4962 

4955 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI4963 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

4956 offers a wide range of models with different capabilities, performance4964 offers a wide range of models with different capabilities, performance


4965 4973 

4966 - `"gpt-5.5"`4974 - `"gpt-5.5"`

4967 4975 

4976 - `"gpt-5.5-2026-04-23"`

4977 

4968 - `"gpt-5.4"`4978 - `"gpt-5.4"`

4969 4979 

4970 - `"gpt-5.4-mini"`4980 - `"gpt-5.4-mini"`


5141 5151 

5142 - `"computer-use-preview-2025-03-11"`5152 - `"computer-use-preview-2025-03-11"`

5143 5153 

5154 - `"gpt-5.5-pro"`

5155 

5156 - `"gpt-5.5-pro-2026-04-23"`

5157 

5144 - `"gpt-5-codex"`5158 - `"gpt-5-codex"`

5145 5159 

5146 - `"gpt-5-pro"`5160 - `"gpt-5-pro"`


6373 6387 

6374 - `"computer_use_preview"`6388 - `"computer_use_preview"`

6375 6389 

6376 - `WebSearch object { type, filters, search_context_size, user_location }`6390 - `WebSearch object { type, external_web_access, filters, 2 more }`

6377 6391 

6378 Search the Internet for sources related to the prompt. Learn more about the6392 Search the Internet for sources related to the prompt. Learn more about the

6379 [web search tool](/docs/guides/tools-web-search).6393 [web search tool](/docs/guides/tools-web-search).


6386 6400 

6387 - `"web_search_2025_08_26"`6401 - `"web_search_2025_08_26"`

6388 6402 

6403 - `external_web_access: optional boolean`

6404 

6405 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

6406 

6389 - `filters: optional object { allowed_domains } or null`6407 - `filters: optional object { allowed_domains } or null`

6390 6408 

6391 Filters for the search.6409 Filters for the search.


7410 7428 

7411 - `"computer_use_preview"`7429 - `"computer_use_preview"`

7412 7430 

7413 - `WebSearch object { type, filters, search_context_size, user_location }`7431 - `WebSearch object { type, external_web_access, filters, 2 more }`

7414 7432 

7415 Search the Internet for sources related to the prompt. Learn more about the7433 Search the Internet for sources related to the prompt. Learn more about the

7416 [web search tool](/docs/guides/tools-web-search).7434 [web search tool](/docs/guides/tools-web-search).


7423 7441 

7424 - `"web_search_2025_08_26"`7442 - `"web_search_2025_08_26"`

7425 7443 

7444 - `external_web_access: optional boolean`

7445 

7446 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

7447 

7426 - `filters: optional object { allowed_domains } or null`7448 - `filters: optional object { allowed_domains } or null`

7427 7449 

7428 Filters for the search.7450 Filters for the search.


9566 9588 

9567 - `"computer_use_preview"`9589 - `"computer_use_preview"`

9568 9590 

9569 - `WebSearch object { type, filters, search_context_size, user_location }`9591 - `WebSearch object { type, external_web_access, filters, 2 more }`

9570 9592 

9571 Search the Internet for sources related to the prompt. Learn more about the9593 Search the Internet for sources related to the prompt. Learn more about the

9572 [web search tool](/docs/guides/tools-web-search).9594 [web search tool](/docs/guides/tools-web-search).


9579 9601 

9580 - `"web_search_2025_08_26"`9602 - `"web_search_2025_08_26"`

9581 9603 

9604 - `external_web_access: optional boolean`

9605 

9606 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

9607 

9582 - `filters: optional object { allowed_domains } or null`9608 - `filters: optional object { allowed_domains } or null`

9583 9609 

9584 Filters for the search.9610 Filters for the search.


10632 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.10658 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.

10633 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).10659 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).

10634 10660 

10635 - `service_tier: optional "auto" or "default" or "flex" or 3 more or null`10661 - `service_tier: optional "auto" or "default" or "flex" or 4 more or null`

10636 10662 

10637 Specifies the processing type used for serving the request.10663 Specifies the processing type used for serving the request.

10638 10664 


10640 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.10666 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.

10641 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.10667 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.

10642 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.10668 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.

10669 - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`.

10643 - When not set, the default behavior is 'auto'.10670 - When not set, the default behavior is 'auto'.

10644 10671 

10645 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.10672 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.


10656 10683 

10657 - `"fast"`10684 - `"fast"`

10658 10685 

10686 - `"ultrafast"`

10687 

10659 - `status: optional BetaResponseStatus`10688 - `status: optional BetaResponseStatus`

10660 10689 

10661 The status of the response generation. One of `completed`, `failed`,10690 The status of the response generation. One of `completed`, `failed`,

Details

1722 1722 

1723 - `"computer_use_preview"`1723 - `"computer_use_preview"`

1724 1724 

1725 - `WebSearch object { type, filters, search_context_size, user_location }`1725 - `WebSearch object { type, external_web_access, filters, 2 more }`

1726 1726 

1727 Search the Internet for sources related to the prompt. Learn more about the1727 Search the Internet for sources related to the prompt. Learn more about the

1728 [web search tool](/docs/guides/tools-web-search).1728 [web search tool](/docs/guides/tools-web-search).


1735 1735 

1736 - `"web_search_2025_08_26"`1736 - `"web_search_2025_08_26"`

1737 1737 

1738 - `external_web_access: optional boolean`

1739 

1740 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1741 

1738 - `filters: optional object { allowed_domains } or null`1742 - `filters: optional object { allowed_domains } or null`

1739 1743 

1740 Filters for the search.1744 Filters for the search.


2909 2913 

2910 - `"computer_use_preview"`2914 - `"computer_use_preview"`

2911 2915 

2912 - `WebSearch object { type, filters, search_context_size, user_location }`2916 - `WebSearch object { type, external_web_access, filters, 2 more }`

2913 2917 

2914 Search the Internet for sources related to the prompt. Learn more about the2918 Search the Internet for sources related to the prompt. Learn more about the

2915 [web search tool](/docs/guides/tools-web-search).2919 [web search tool](/docs/guides/tools-web-search).


2922 2926 

2923 - `"web_search_2025_08_26"`2927 - `"web_search_2025_08_26"`

2924 2928 

2929 - `external_web_access: optional boolean`

2930 

2931 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2932 

2925 - `filters: optional object { allowed_domains } or null`2933 - `filters: optional object { allowed_domains } or null`

2926 2934 

2927 Filters for the search.2935 Filters for the search.


6512 6520 

6513 - `"computer_use_preview"`6521 - `"computer_use_preview"`

6514 6522 

6515 - `WebSearch object { type, filters, search_context_size, user_location }`6523 - `WebSearch object { type, external_web_access, filters, 2 more }`

6516 6524 

6517 Search the Internet for sources related to the prompt. Learn more about the6525 Search the Internet for sources related to the prompt. Learn more about the

6518 [web search tool](/docs/guides/tools-web-search).6526 [web search tool](/docs/guides/tools-web-search).


6525 6533 

6526 - `"web_search_2025_08_26"`6534 - `"web_search_2025_08_26"`

6527 6535 

6536 - `external_web_access: optional boolean`

6537 

6538 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

6539 

6528 - `filters: optional object { allowed_domains } or null`6540 - `filters: optional object { allowed_domains } or null`

6529 6541 

6530 Filters for the search.6542 Filters for the search.


7699 7711 

7700 - `"computer_use_preview"`7712 - `"computer_use_preview"`

7701 7713 

7702 - `WebSearch object { type, filters, search_context_size, user_location }`7714 - `WebSearch object { type, external_web_access, filters, 2 more }`

7703 7715 

7704 Search the Internet for sources related to the prompt. Learn more about the7716 Search the Internet for sources related to the prompt. Learn more about the

7705 [web search tool](/docs/guides/tools-web-search).7717 [web search tool](/docs/guides/tools-web-search).


7712 7724 

7713 - `"web_search_2025_08_26"`7725 - `"web_search_2025_08_26"`

7714 7726 

7727 - `external_web_access: optional boolean`

7728 

7729 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

7730 

7715 - `filters: optional object { allowed_domains } or null`7731 - `filters: optional object { allowed_domains } or null`

7716 7732 

7717 Filters for the search.7733 Filters for the search.

Details

1720 1720 

1721 - `"computer_use_preview"`1721 - `"computer_use_preview"`

1722 1722 

1723 - `WebSearch object { type, filters, search_context_size, user_location }`1723 - `WebSearch object { type, external_web_access, filters, 2 more }`

1724 1724 

1725 Search the Internet for sources related to the prompt. Learn more about the1725 Search the Internet for sources related to the prompt. Learn more about the

1726 [web search tool](/docs/guides/tools-web-search).1726 [web search tool](/docs/guides/tools-web-search).


1733 1733 

1734 - `"web_search_2025_08_26"`1734 - `"web_search_2025_08_26"`

1735 1735 

1736 - `external_web_access: optional boolean`

1737 

1738 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1739 

1736 - `filters: optional object { allowed_domains } or null`1740 - `filters: optional object { allowed_domains } or null`

1737 1741 

1738 Filters for the search.1742 Filters for the search.


2907 2911 

2908 - `"computer_use_preview"`2912 - `"computer_use_preview"`

2909 2913 

2910 - `WebSearch object { type, filters, search_context_size, user_location }`2914 - `WebSearch object { type, external_web_access, filters, 2 more }`

2911 2915 

2912 Search the Internet for sources related to the prompt. Learn more about the2916 Search the Internet for sources related to the prompt. Learn more about the

2913 [web search tool](/docs/guides/tools-web-search).2917 [web search tool](/docs/guides/tools-web-search).


2920 2924 

2921 - `"web_search_2025_08_26"`2925 - `"web_search_2025_08_26"`

2922 2926 

2927 - `external_web_access: optional boolean`

2928 

2929 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2930 

2923 - `filters: optional object { allowed_domains } or null`2931 - `filters: optional object { allowed_domains } or null`

2924 2932 

2925 Filters for the search.2933 Filters for the search.

Details

1790 1790 

1791 - `"computer_use_preview"`1791 - `"computer_use_preview"`

1792 1792 

1793 - `WebSearch object { type, filters, search_context_size, user_location }`1793 - `WebSearch object { type, external_web_access, filters, 2 more }`

1794 1794 

1795 Search the Internet for sources related to the prompt. Learn more about the1795 Search the Internet for sources related to the prompt. Learn more about the

1796 [web search tool](/docs/guides/tools-web-search).1796 [web search tool](/docs/guides/tools-web-search).


1803 1803 

1804 - `"web_search_2025_08_26"`1804 - `"web_search_2025_08_26"`

1805 1805 

1806 - `external_web_access: optional boolean`

1807 

1808 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1809 

1806 - `filters: optional object { allowed_domains } or null`1810 - `filters: optional object { allowed_domains } or null`

1807 1811 

1808 Filters for the search.1812 Filters for the search.


2981 2985 

2982 - `"computer_use_preview"`2986 - `"computer_use_preview"`

2983 2987 

2984 - `WebSearch object { type, filters, search_context_size, user_location }`2988 - `WebSearch object { type, external_web_access, filters, 2 more }`

2985 2989 

2986 Search the Internet for sources related to the prompt. Learn more about the2990 Search the Internet for sources related to the prompt. Learn more about the

2987 [web search tool](/docs/guides/tools-web-search).2991 [web search tool](/docs/guides/tools-web-search).


2994 2998 

2995 - `"web_search_2025_08_26"`2999 - `"web_search_2025_08_26"`

2996 3000 

3001 - `external_web_access: optional boolean`

3002 

3003 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

3004 

2997 - `filters: optional object { allowed_domains } or null`3005 - `filters: optional object { allowed_domains } or null`

2998 3006 

2999 Filters for the search.3007 Filters for the search.


5470 5478 

5471 - `"computer_use_preview"`5479 - `"computer_use_preview"`

5472 5480 

5473 - `WebSearch object { type, filters, search_context_size, user_location }`5481 - `WebSearch object { type, external_web_access, filters, 2 more }`

5474 5482 

5475 Search the Internet for sources related to the prompt. Learn more about the5483 Search the Internet for sources related to the prompt. Learn more about the

5476 [web search tool](/docs/guides/tools-web-search).5484 [web search tool](/docs/guides/tools-web-search).


5483 5491 

5484 - `"web_search_2025_08_26"`5492 - `"web_search_2025_08_26"`

5485 5493 

5494 - `external_web_access: optional boolean`

5495 

5496 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

5497 

5486 - `filters: optional object { allowed_domains } or null`5498 - `filters: optional object { allowed_domains } or null`

5487 5499 

5488 Filters for the search.5500 Filters for the search.

Details

1788 1788 

1789 - `"computer_use_preview"`1789 - `"computer_use_preview"`

1790 1790 

1791 - `WebSearch object { type, filters, search_context_size, user_location }`1791 - `WebSearch object { type, external_web_access, filters, 2 more }`

1792 1792 

1793 Search the Internet for sources related to the prompt. Learn more about the1793 Search the Internet for sources related to the prompt. Learn more about the

1794 [web search tool](/docs/guides/tools-web-search).1794 [web search tool](/docs/guides/tools-web-search).


1801 1801 

1802 - `"web_search_2025_08_26"`1802 - `"web_search_2025_08_26"`

1803 1803 

1804 - `external_web_access: optional boolean`

1805 

1806 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1807 

1804 - `filters: optional object { allowed_domains } or null`1808 - `filters: optional object { allowed_domains } or null`

1805 1809 

1806 Filters for the search.1810 Filters for the search.


2979 2983 

2980 - `"computer_use_preview"`2984 - `"computer_use_preview"`

2981 2985 

2982 - `WebSearch object { type, filters, search_context_size, user_location }`2986 - `WebSearch object { type, external_web_access, filters, 2 more }`

2983 2987 

2984 Search the Internet for sources related to the prompt. Learn more about the2988 Search the Internet for sources related to the prompt. Learn more about the

2985 [web search tool](/docs/guides/tools-web-search).2989 [web search tool](/docs/guides/tools-web-search).


2992 2996 

2993 - `"web_search_2025_08_26"`2997 - `"web_search_2025_08_26"`

2994 2998 

2999 - `external_web_access: optional boolean`

3000 

3001 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

3002 

2995 - `filters: optional object { allowed_domains } or null`3003 - `filters: optional object { allowed_domains } or null`

2996 3004 

2997 Filters for the search.3005 Filters for the search.


5468 5476 

5469 - `"computer_use_preview"`5477 - `"computer_use_preview"`

5470 5478 

5471 - `WebSearch object { type, filters, search_context_size, user_location }`5479 - `WebSearch object { type, external_web_access, filters, 2 more }`

5472 5480 

5473 Search the Internet for sources related to the prompt. Learn more about the5481 Search the Internet for sources related to the prompt. Learn more about the

5474 [web search tool](/docs/guides/tools-web-search).5482 [web search tool](/docs/guides/tools-web-search).


5481 5489 

5482 - `"web_search_2025_08_26"`5490 - `"web_search_2025_08_26"`

5483 5491 

5492 - `external_web_access: optional boolean`

5493 

5494 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

5495 

5484 - `filters: optional object { allowed_domains } or null`5496 - `filters: optional object { allowed_domains } or null`

5485 5497 

5486 Filters for the search.5498 Filters for the search.

Details

446 446 

447 - `"function"`447 - `"function"`

448 448 

449- `model: string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more`449- `model: string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`

450 450 

451 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI451 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

452 offers a wide range of models with different capabilities, performance452 offers a wide range of models with different capabilities, performance


455 455 

456 - `string`456 - `string`

457 457 

458 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more`458 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`

459 459 

460 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI460 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

461 offers a wide range of models with different capabilities, performance461 offers a wide range of models with different capabilities, performance


470 470 

471 - `"gpt-5.5"`471 - `"gpt-5.5"`

472 472 

473 - `"gpt-5.5-2026-04-23"`

474 

473 - `"gpt-5.4"`475 - `"gpt-5.4"`

474 476 

475 - `"gpt-5.4-mini"`477 - `"gpt-5.4-mini"`

Details

444 444 

445 - `"function"`445 - `"function"`

446 446 

447- `model: string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more`447- `model: string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`

448 448 

449 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI449 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

450 offers a wide range of models with different capabilities, performance450 offers a wide range of models with different capabilities, performance


453 453 

454 - `string`454 - `string`

455 455 

456 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more`456 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`

457 457 

458 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI458 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

459 offers a wide range of models with different capabilities, performance459 offers a wide range of models with different capabilities, performance


468 468 

469 - `"gpt-5.5"`469 - `"gpt-5.5"`

470 470 

471 - `"gpt-5.5-2026-04-23"`

472 

471 - `"gpt-5.4"`473 - `"gpt-5.4"`

472 474 

473 - `"gpt-5.4-mini"`475 - `"gpt-5.4-mini"`

Details

442 442 

443 - `"function"`443 - `"function"`

444 444 

445- `model: string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more`445- `model: string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`

446 446 

447 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI447 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

448 offers a wide range of models with different capabilities, performance448 offers a wide range of models with different capabilities, performance


451 451 

452 - `string`452 - `string`

453 453 

454 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more`454 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`

455 455 

456 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI456 Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI

457 offers a wide range of models with different capabilities, performance457 offers a wide range of models with different capabilities, performance


466 466 

467 - `"gpt-5.5"`467 - `"gpt-5.5"`

468 468 

469 - `"gpt-5.5-2026-04-23"`

470 

469 - `"gpt-5.4"`471 - `"gpt-5.4"`

470 472 

471 - `"gpt-5.4-mini"`473 - `"gpt-5.4-mini"`

Details

1406 1406 

1407 - `"computer_use_preview"`1407 - `"computer_use_preview"`

1408 1408 

1409 - `WebSearch object { type, filters, search_context_size, user_location }`1409 - `WebSearch object { type, external_web_access, filters, 2 more }`

1410 1410 

1411 Search the Internet for sources related to the prompt. Learn more about the1411 Search the Internet for sources related to the prompt. Learn more about the

1412 [web search tool](/docs/guides/tools-web-search).1412 [web search tool](/docs/guides/tools-web-search).


1419 1419 

1420 - `"web_search_2025_08_26"`1420 - `"web_search_2025_08_26"`

1421 1421 

1422 - `external_web_access: optional boolean`

1423 

1424 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1425 

1422 - `filters: optional object { allowed_domains } or null`1426 - `filters: optional object { allowed_domains } or null`

1423 1427 

1424 Filters for the search.1428 Filters for the search.


2441 2445 

2442 - `"computer_use_preview"`2446 - `"computer_use_preview"`

2443 2447 

2444 - `WebSearch object { type, filters, search_context_size, user_location }`2448 - `WebSearch object { type, external_web_access, filters, 2 more }`

2445 2449 

2446 Search the Internet for sources related to the prompt. Learn more about the2450 Search the Internet for sources related to the prompt. Learn more about the

2447 [web search tool](/docs/guides/tools-web-search).2451 [web search tool](/docs/guides/tools-web-search).


2454 2458 

2455 - `"web_search_2025_08_26"`2459 - `"web_search_2025_08_26"`

2456 2460 

2461 - `external_web_access: optional boolean`

2462 

2463 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2464 

2457 - `filters: optional object { allowed_domains } or null`2465 - `filters: optional object { allowed_domains } or null`

2458 2466 

2459 Filters for the search.2467 Filters for the search.


6293 6301 

6294 - `"computer_use_preview"`6302 - `"computer_use_preview"`

6295 6303 

6296 - `WebSearch object { type, filters, search_context_size, user_location }`6304 - `WebSearch object { type, external_web_access, filters, 2 more }`

6297 6305 

6298 Search the Internet for sources related to the prompt. Learn more about the6306 Search the Internet for sources related to the prompt. Learn more about the

6299 [web search tool](/docs/guides/tools-web-search).6307 [web search tool](/docs/guides/tools-web-search).


6306 6314 

6307 - `"web_search_2025_08_26"`6315 - `"web_search_2025_08_26"`

6308 6316 

6317 - `external_web_access: optional boolean`

6318 

6319 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

6320 

6309 - `filters: optional object { allowed_domains } or null`6321 - `filters: optional object { allowed_domains } or null`

6310 6322 

6311 Filters for the search.6323 Filters for the search.


7328 7340 

7329 - `"computer_use_preview"`7341 - `"computer_use_preview"`

7330 7342 

7331 - `WebSearch object { type, filters, search_context_size, user_location }`7343 - `WebSearch object { type, external_web_access, filters, 2 more }`

7332 7344 

7333 Search the Internet for sources related to the prompt. Learn more about the7345 Search the Internet for sources related to the prompt. Learn more about the

7334 [web search tool](/docs/guides/tools-web-search).7346 [web search tool](/docs/guides/tools-web-search).


7341 7353 

7342 - `"web_search_2025_08_26"`7354 - `"web_search_2025_08_26"`

7343 7355 

7356 - `external_web_access: optional boolean`

7357 

7358 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

7359 

7344 - `filters: optional object { allowed_domains } or null`7360 - `filters: optional object { allowed_domains } or null`

7345 7361 

7346 Filters for the search.7362 Filters for the search.


10317 10333 

10318 - `"computer_use_preview"`10334 - `"computer_use_preview"`

10319 10335 

10320 - `WebSearch object { type, filters, search_context_size, user_location }`10336 - `WebSearch object { type, external_web_access, filters, 2 more }`

10321 10337 

10322 Search the Internet for sources related to the prompt. Learn more about the10338 Search the Internet for sources related to the prompt. Learn more about the

10323 [web search tool](/docs/guides/tools-web-search).10339 [web search tool](/docs/guides/tools-web-search).


10330 10346 

10331 - `"web_search_2025_08_26"`10347 - `"web_search_2025_08_26"`

10332 10348 

10349 - `external_web_access: optional boolean`

10350 

10351 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

10352 

10333 - `filters: optional object { allowed_domains } or null`10353 - `filters: optional object { allowed_domains } or null`

10334 10354 

10335 Filters for the search.10355 Filters for the search.


11348 11368 

11349 - `"computer_use_preview"`11369 - `"computer_use_preview"`

11350 11370 

11351 - `WebSearch object { type, filters, search_context_size, user_location }`11371 - `WebSearch object { type, external_web_access, filters, 2 more }`

11352 11372 

11353 Search the Internet for sources related to the prompt. Learn more about the11373 Search the Internet for sources related to the prompt. Learn more about the

11354 [web search tool](/docs/guides/tools-web-search).11374 [web search tool](/docs/guides/tools-web-search).


11361 11381 

11362 - `"web_search_2025_08_26"`11382 - `"web_search_2025_08_26"`

11363 11383 

11384 - `external_web_access: optional boolean`

11385 

11386 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

11387 

11364 - `filters: optional object { allowed_domains } or null`11388 - `filters: optional object { allowed_domains } or null`

11365 11389 

11366 Filters for the search.11390 Filters for the search.


14554 14578 

14555 - `"computer_use_preview"`14579 - `"computer_use_preview"`

14556 14580 

14557 - `WebSearch object { type, filters, search_context_size, user_location }`14581 - `WebSearch object { type, external_web_access, filters, 2 more }`

14558 14582 

14559 Search the Internet for sources related to the prompt. Learn more about the14583 Search the Internet for sources related to the prompt. Learn more about the

14560 [web search tool](/docs/guides/tools-web-search).14584 [web search tool](/docs/guides/tools-web-search).


14567 14591 

14568 - `"web_search_2025_08_26"`14592 - `"web_search_2025_08_26"`

14569 14593 

14594 - `external_web_access: optional boolean`

14595 

14596 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

14597 

14570 - `filters: optional object { allowed_domains } or null`14598 - `filters: optional object { allowed_domains } or null`

14571 14599 

14572 Filters for the search.14600 Filters for the search.


15585 15613 

15586 - `"computer_use_preview"`15614 - `"computer_use_preview"`

15587 15615 

15588 - `WebSearch object { type, filters, search_context_size, user_location }`15616 - `WebSearch object { type, external_web_access, filters, 2 more }`

15589 15617 

15590 Search the Internet for sources related to the prompt. Learn more about the15618 Search the Internet for sources related to the prompt. Learn more about the

15591 [web search tool](/docs/guides/tools-web-search).15619 [web search tool](/docs/guides/tools-web-search).


15598 15626 

15599 - `"web_search_2025_08_26"`15627 - `"web_search_2025_08_26"`

15600 15628 

15629 - `external_web_access: optional boolean`

15630 

15631 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

15632 

15601 - `filters: optional object { allowed_domains } or null`15633 - `filters: optional object { allowed_domains } or null`

15602 15634 

15603 Filters for the search.15635 Filters for the search.


18652 18684 

18653 - `"computer_use_preview"`18685 - `"computer_use_preview"`

18654 18686 

18655 - `WebSearch object { type, filters, search_context_size, user_location }`18687 - `WebSearch object { type, external_web_access, filters, 2 more }`

18656 18688 

18657 Search the Internet for sources related to the prompt. Learn more about the18689 Search the Internet for sources related to the prompt. Learn more about the

18658 [web search tool](/docs/guides/tools-web-search).18690 [web search tool](/docs/guides/tools-web-search).


18665 18697 

18666 - `"web_search_2025_08_26"`18698 - `"web_search_2025_08_26"`

18667 18699 

18700 - `external_web_access: optional boolean`

18701 

18702 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

18703 

18668 - `filters: optional object { allowed_domains } or null`18704 - `filters: optional object { allowed_domains } or null`

18669 18705 

18670 Filters for the search.18706 Filters for the search.


19683 19719 

19684 - `"computer_use_preview"`19720 - `"computer_use_preview"`

19685 19721 

19686 - `WebSearch object { type, filters, search_context_size, user_location }`19722 - `WebSearch object { type, external_web_access, filters, 2 more }`

19687 19723 

19688 Search the Internet for sources related to the prompt. Learn more about the19724 Search the Internet for sources related to the prompt. Learn more about the

19689 [web search tool](/docs/guides/tools-web-search).19725 [web search tool](/docs/guides/tools-web-search).


19696 19732 

19697 - `"web_search_2025_08_26"`19733 - `"web_search_2025_08_26"`

19698 19734 

19735 - `external_web_access: optional boolean`

19736 

19737 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

19738 

19699 - `filters: optional object { allowed_domains } or null`19739 - `filters: optional object { allowed_domains } or null`

19700 19740 

19701 Filters for the search.19741 Filters for the search.


22683 22723 

22684 - `"computer_use_preview"`22724 - `"computer_use_preview"`

22685 22725 

22686 - `WebSearch object { type, filters, search_context_size, user_location }`22726 - `WebSearch object { type, external_web_access, filters, 2 more }`

22687 22727 

22688 Search the Internet for sources related to the prompt. Learn more about the22728 Search the Internet for sources related to the prompt. Learn more about the

22689 [web search tool](/docs/guides/tools-web-search).22729 [web search tool](/docs/guides/tools-web-search).


22696 22736 

22697 - `"web_search_2025_08_26"`22737 - `"web_search_2025_08_26"`

22698 22738 

22739 - `external_web_access: optional boolean`

22740 

22741 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

22742 

22699 - `filters: optional object { allowed_domains } or null`22743 - `filters: optional object { allowed_domains } or null`

22700 22744 

22701 Filters for the search.22745 Filters for the search.


23714 23758 

23715 - `"computer_use_preview"`23759 - `"computer_use_preview"`

23716 23760 

23717 - `WebSearch object { type, filters, search_context_size, user_location }`23761 - `WebSearch object { type, external_web_access, filters, 2 more }`

23718 23762 

23719 Search the Internet for sources related to the prompt. Learn more about the23763 Search the Internet for sources related to the prompt. Learn more about the

23720 [web search tool](/docs/guides/tools-web-search).23764 [web search tool](/docs/guides/tools-web-search).


23727 23771 

23728 - `"web_search_2025_08_26"`23772 - `"web_search_2025_08_26"`

23729 23773 

23774 - `external_web_access: optional boolean`

23775 

23776 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

23777 

23730 - `filters: optional object { allowed_domains } or null`23778 - `filters: optional object { allowed_domains } or null`

23731 23779 

23732 Filters for the search.23780 Filters for the search.


26667 26715 

26668 - `"computer_use_preview"`26716 - `"computer_use_preview"`

26669 26717 

26670 - `WebSearch object { type, filters, search_context_size, user_location }`26718 - `WebSearch object { type, external_web_access, filters, 2 more }`

26671 26719 

26672 Search the Internet for sources related to the prompt. Learn more about the26720 Search the Internet for sources related to the prompt. Learn more about the

26673 [web search tool](/docs/guides/tools-web-search).26721 [web search tool](/docs/guides/tools-web-search).


26680 26728 

26681 - `"web_search_2025_08_26"`26729 - `"web_search_2025_08_26"`

26682 26730 

26731 - `external_web_access: optional boolean`

26732 

26733 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

26734 

26683 - `filters: optional object { allowed_domains } or null`26735 - `filters: optional object { allowed_domains } or null`

26684 26736 

26685 Filters for the search.26737 Filters for the search.


27698 27750 

27699 - `"computer_use_preview"`27751 - `"computer_use_preview"`

27700 27752 

27701 - `WebSearch object { type, filters, search_context_size, user_location }`27753 - `WebSearch object { type, external_web_access, filters, 2 more }`

27702 27754 

27703 Search the Internet for sources related to the prompt. Learn more about the27755 Search the Internet for sources related to the prompt. Learn more about the

27704 [web search tool](/docs/guides/tools-web-search).27756 [web search tool](/docs/guides/tools-web-search).


27711 27763 

27712 - `"web_search_2025_08_26"`27764 - `"web_search_2025_08_26"`

27713 27765 

27766 - `external_web_access: optional boolean`

27767 

27768 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

27769 

27714 - `filters: optional object { allowed_domains } or null`27770 - `filters: optional object { allowed_domains } or null`

27715 27771 

27716 Filters for the search.27772 Filters for the search.

Details

1404 1404 

1405 - `"computer_use_preview"`1405 - `"computer_use_preview"`

1406 1406 

1407 - `WebSearch object { type, filters, search_context_size, user_location }`1407 - `WebSearch object { type, external_web_access, filters, 2 more }`

1408 1408 

1409 Search the Internet for sources related to the prompt. Learn more about the1409 Search the Internet for sources related to the prompt. Learn more about the

1410 [web search tool](/docs/guides/tools-web-search).1410 [web search tool](/docs/guides/tools-web-search).


1417 1417 

1418 - `"web_search_2025_08_26"`1418 - `"web_search_2025_08_26"`

1419 1419 

1420 - `external_web_access: optional boolean`

1421 

1422 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1423 

1420 - `filters: optional object { allowed_domains } or null`1424 - `filters: optional object { allowed_domains } or null`

1421 1425 

1422 Filters for the search.1426 Filters for the search.


2439 2443 

2440 - `"computer_use_preview"`2444 - `"computer_use_preview"`

2441 2445 

2442 - `WebSearch object { type, filters, search_context_size, user_location }`2446 - `WebSearch object { type, external_web_access, filters, 2 more }`

2443 2447 

2444 Search the Internet for sources related to the prompt. Learn more about the2448 Search the Internet for sources related to the prompt. Learn more about the

2445 [web search tool](/docs/guides/tools-web-search).2449 [web search tool](/docs/guides/tools-web-search).


2452 2456 

2453 - `"web_search_2025_08_26"`2457 - `"web_search_2025_08_26"`

2454 2458 

2459 - `external_web_access: optional boolean`

2460 

2461 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2462 

2455 - `filters: optional object { allowed_domains } or null`2463 - `filters: optional object { allowed_domains } or null`

2456 2464 

2457 Filters for the search.2465 Filters for the search.

Details

1433 1433 

1434 - `"computer_use_preview"`1434 - `"computer_use_preview"`

1435 1435 

1436 - `WebSearch object { type, filters, search_context_size, user_location }`1436 - `WebSearch object { type, external_web_access, filters, 2 more }`

1437 1437 

1438 Search the Internet for sources related to the prompt. Learn more about the1438 Search the Internet for sources related to the prompt. Learn more about the

1439 [web search tool](/docs/guides/tools-web-search).1439 [web search tool](/docs/guides/tools-web-search).


1446 1446 

1447 - `"web_search_2025_08_26"`1447 - `"web_search_2025_08_26"`

1448 1448 

1449 - `external_web_access: optional boolean`

1450 

1451 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1452 

1449 - `filters: optional object { allowed_domains } or null`1453 - `filters: optional object { allowed_domains } or null`

1450 1454 

1451 Filters for the search.1455 Filters for the search.


2468 2472 

2469 - `"computer_use_preview"`2473 - `"computer_use_preview"`

2470 2474 

2471 - `WebSearch object { type, filters, search_context_size, user_location }`2475 - `WebSearch object { type, external_web_access, filters, 2 more }`

2472 2476 

2473 Search the Internet for sources related to the prompt. Learn more about the2477 Search the Internet for sources related to the prompt. Learn more about the

2474 [web search tool](/docs/guides/tools-web-search).2478 [web search tool](/docs/guides/tools-web-search).


2481 2485 

2482 - `"web_search_2025_08_26"`2486 - `"web_search_2025_08_26"`

2483 2487 

2488 - `external_web_access: optional boolean`

2489 

2490 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2491 

2484 - `filters: optional object { allowed_domains } or null`2492 - `filters: optional object { allowed_domains } or null`

2485 2493 

2486 Filters for the search.2494 Filters for the search.


5457 5465 

5458 - `"computer_use_preview"`5466 - `"computer_use_preview"`

5459 5467 

5460 - `WebSearch object { type, filters, search_context_size, user_location }`5468 - `WebSearch object { type, external_web_access, filters, 2 more }`

5461 5469 

5462 Search the Internet for sources related to the prompt. Learn more about the5470 Search the Internet for sources related to the prompt. Learn more about the

5463 [web search tool](/docs/guides/tools-web-search).5471 [web search tool](/docs/guides/tools-web-search).


5470 5478 

5471 - `"web_search_2025_08_26"`5479 - `"web_search_2025_08_26"`

5472 5480 

5481 - `external_web_access: optional boolean`

5482 

5483 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

5484 

5473 - `filters: optional object { allowed_domains } or null`5485 - `filters: optional object { allowed_domains } or null`

5474 5486 

5475 Filters for the search.5487 Filters for the search.


6488 6500 

6489 - `"computer_use_preview"`6501 - `"computer_use_preview"`

6490 6502 

6491 - `WebSearch object { type, filters, search_context_size, user_location }`6503 - `WebSearch object { type, external_web_access, filters, 2 more }`

6492 6504 

6493 Search the Internet for sources related to the prompt. Learn more about the6505 Search the Internet for sources related to the prompt. Learn more about the

6494 [web search tool](/docs/guides/tools-web-search).6506 [web search tool](/docs/guides/tools-web-search).


6501 6513 

6502 - `"web_search_2025_08_26"`6514 - `"web_search_2025_08_26"`

6503 6515 

6516 - `external_web_access: optional boolean`

6517 

6518 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

6519 

6504 - `filters: optional object { allowed_domains } or null`6520 - `filters: optional object { allowed_domains } or null`

6505 6521 

6506 Filters for the search.6522 Filters for the search.


9694 9710 

9695 - `"computer_use_preview"`9711 - `"computer_use_preview"`

9696 9712 

9697 - `WebSearch object { type, filters, search_context_size, user_location }`9713 - `WebSearch object { type, external_web_access, filters, 2 more }`

9698 9714 

9699 Search the Internet for sources related to the prompt. Learn more about the9715 Search the Internet for sources related to the prompt. Learn more about the

9700 [web search tool](/docs/guides/tools-web-search).9716 [web search tool](/docs/guides/tools-web-search).


9707 9723 

9708 - `"web_search_2025_08_26"`9724 - `"web_search_2025_08_26"`

9709 9725 

9726 - `external_web_access: optional boolean`

9727 

9728 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

9729 

9710 - `filters: optional object { allowed_domains } or null`9730 - `filters: optional object { allowed_domains } or null`

9711 9731 

9712 Filters for the search.9732 Filters for the search.


10725 10745 

10726 - `"computer_use_preview"`10746 - `"computer_use_preview"`

10727 10747 

10728 - `WebSearch object { type, filters, search_context_size, user_location }`10748 - `WebSearch object { type, external_web_access, filters, 2 more }`

10729 10749 

10730 Search the Internet for sources related to the prompt. Learn more about the10750 Search the Internet for sources related to the prompt. Learn more about the

10731 [web search tool](/docs/guides/tools-web-search).10751 [web search tool](/docs/guides/tools-web-search).


10738 10758 

10739 - `"web_search_2025_08_26"`10759 - `"web_search_2025_08_26"`

10740 10760 

10761 - `external_web_access: optional boolean`

10762 

10763 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

10764 

10741 - `filters: optional object { allowed_domains } or null`10765 - `filters: optional object { allowed_domains } or null`

10742 10766 

10743 Filters for the search.10767 Filters for the search.


13792 13816 

13793 - `"computer_use_preview"`13817 - `"computer_use_preview"`

13794 13818 

13795 - `WebSearch object { type, filters, search_context_size, user_location }`13819 - `WebSearch object { type, external_web_access, filters, 2 more }`

13796 13820 

13797 Search the Internet for sources related to the prompt. Learn more about the13821 Search the Internet for sources related to the prompt. Learn more about the

13798 [web search tool](/docs/guides/tools-web-search).13822 [web search tool](/docs/guides/tools-web-search).


13805 13829 

13806 - `"web_search_2025_08_26"`13830 - `"web_search_2025_08_26"`

13807 13831 

13832 - `external_web_access: optional boolean`

13833 

13834 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

13835 

13808 - `filters: optional object { allowed_domains } or null`13836 - `filters: optional object { allowed_domains } or null`

13809 13837 

13810 Filters for the search.13838 Filters for the search.


14823 14851 

14824 - `"computer_use_preview"`14852 - `"computer_use_preview"`

14825 14853 

14826 - `WebSearch object { type, filters, search_context_size, user_location }`14854 - `WebSearch object { type, external_web_access, filters, 2 more }`

14827 14855 

14828 Search the Internet for sources related to the prompt. Learn more about the14856 Search the Internet for sources related to the prompt. Learn more about the

14829 [web search tool](/docs/guides/tools-web-search).14857 [web search tool](/docs/guides/tools-web-search).


14836 14864 

14837 - `"web_search_2025_08_26"`14865 - `"web_search_2025_08_26"`

14838 14866 

14867 - `external_web_access: optional boolean`

14868 

14869 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

14870 

14839 - `filters: optional object { allowed_domains } or null`14871 - `filters: optional object { allowed_domains } or null`

14840 14872 

14841 Filters for the search.14873 Filters for the search.


17823 17855 

17824 - `"computer_use_preview"`17856 - `"computer_use_preview"`

17825 17857 

17826 - `WebSearch object { type, filters, search_context_size, user_location }`17858 - `WebSearch object { type, external_web_access, filters, 2 more }`

17827 17859 

17828 Search the Internet for sources related to the prompt. Learn more about the17860 Search the Internet for sources related to the prompt. Learn more about the

17829 [web search tool](/docs/guides/tools-web-search).17861 [web search tool](/docs/guides/tools-web-search).


17836 17868 

17837 - `"web_search_2025_08_26"`17869 - `"web_search_2025_08_26"`

17838 17870 

17871 - `external_web_access: optional boolean`

17872 

17873 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

17874 

17839 - `filters: optional object { allowed_domains } or null`17875 - `filters: optional object { allowed_domains } or null`

17840 17876 

17841 Filters for the search.17877 Filters for the search.


18854 18890 

18855 - `"computer_use_preview"`18891 - `"computer_use_preview"`

18856 18892 

18857 - `WebSearch object { type, filters, search_context_size, user_location }`18893 - `WebSearch object { type, external_web_access, filters, 2 more }`

18858 18894 

18859 Search the Internet for sources related to the prompt. Learn more about the18895 Search the Internet for sources related to the prompt. Learn more about the

18860 [web search tool](/docs/guides/tools-web-search).18896 [web search tool](/docs/guides/tools-web-search).


18867 18903 

18868 - `"web_search_2025_08_26"`18904 - `"web_search_2025_08_26"`

18869 18905 

18906 - `external_web_access: optional boolean`

18907 

18908 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

18909 

18870 - `filters: optional object { allowed_domains } or null`18910 - `filters: optional object { allowed_domains } or null`

18871 18911 

18872 Filters for the search.18912 Filters for the search.


21807 21847 

21808 - `"computer_use_preview"`21848 - `"computer_use_preview"`

21809 21849 

21810 - `WebSearch object { type, filters, search_context_size, user_location }`21850 - `WebSearch object { type, external_web_access, filters, 2 more }`

21811 21851 

21812 Search the Internet for sources related to the prompt. Learn more about the21852 Search the Internet for sources related to the prompt. Learn more about the

21813 [web search tool](/docs/guides/tools-web-search).21853 [web search tool](/docs/guides/tools-web-search).


21820 21860 

21821 - `"web_search_2025_08_26"`21861 - `"web_search_2025_08_26"`

21822 21862 

21863 - `external_web_access: optional boolean`

21864 

21865 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

21866 

21823 - `filters: optional object { allowed_domains } or null`21867 - `filters: optional object { allowed_domains } or null`

21824 21868 

21825 Filters for the search.21869 Filters for the search.


22838 22882 

22839 - `"computer_use_preview"`22883 - `"computer_use_preview"`

22840 22884 

22841 - `WebSearch object { type, filters, search_context_size, user_location }`22885 - `WebSearch object { type, external_web_access, filters, 2 more }`

22842 22886 

22843 Search the Internet for sources related to the prompt. Learn more about the22887 Search the Internet for sources related to the prompt. Learn more about the

22844 [web search tool](/docs/guides/tools-web-search).22888 [web search tool](/docs/guides/tools-web-search).


22851 22895 

22852 - `"web_search_2025_08_26"`22896 - `"web_search_2025_08_26"`

22853 22897 

22898 - `external_web_access: optional boolean`

22899 

22900 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

22901 

22854 - `filters: optional object { allowed_domains } or null`22902 - `filters: optional object { allowed_domains } or null`

22855 22903 

22856 Filters for the search.22904 Filters for the search.

Details

1431 1431 

1432 - `"computer_use_preview"`1432 - `"computer_use_preview"`

1433 1433 

1434 - `WebSearch object { type, filters, search_context_size, user_location }`1434 - `WebSearch object { type, external_web_access, filters, 2 more }`

1435 1435 

1436 Search the Internet for sources related to the prompt. Learn more about the1436 Search the Internet for sources related to the prompt. Learn more about the

1437 [web search tool](/docs/guides/tools-web-search).1437 [web search tool](/docs/guides/tools-web-search).


1444 1444 

1445 - `"web_search_2025_08_26"`1445 - `"web_search_2025_08_26"`

1446 1446 

1447 - `external_web_access: optional boolean`

1448 

1449 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1450 

1447 - `filters: optional object { allowed_domains } or null`1451 - `filters: optional object { allowed_domains } or null`

1448 1452 

1449 Filters for the search.1453 Filters for the search.


2466 2470 

2467 - `"computer_use_preview"`2471 - `"computer_use_preview"`

2468 2472 

2469 - `WebSearch object { type, filters, search_context_size, user_location }`2473 - `WebSearch object { type, external_web_access, filters, 2 more }`

2470 2474 

2471 Search the Internet for sources related to the prompt. Learn more about the2475 Search the Internet for sources related to the prompt. Learn more about the

2472 [web search tool](/docs/guides/tools-web-search).2476 [web search tool](/docs/guides/tools-web-search).


2479 2483 

2480 - `"web_search_2025_08_26"`2484 - `"web_search_2025_08_26"`

2481 2485 

2486 - `external_web_access: optional boolean`

2487 

2488 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2489 

2482 - `filters: optional object { allowed_domains } or null`2490 - `filters: optional object { allowed_domains } or null`

2483 2491 

2484 Filters for the search.2492 Filters for the search.


5455 5463 

5456 - `"computer_use_preview"`5464 - `"computer_use_preview"`

5457 5465 

5458 - `WebSearch object { type, filters, search_context_size, user_location }`5466 - `WebSearch object { type, external_web_access, filters, 2 more }`

5459 5467 

5460 Search the Internet for sources related to the prompt. Learn more about the5468 Search the Internet for sources related to the prompt. Learn more about the

5461 [web search tool](/docs/guides/tools-web-search).5469 [web search tool](/docs/guides/tools-web-search).


5468 5476 

5469 - `"web_search_2025_08_26"`5477 - `"web_search_2025_08_26"`

5470 5478 

5479 - `external_web_access: optional boolean`

5480 

5481 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

5482 

5471 - `filters: optional object { allowed_domains } or null`5483 - `filters: optional object { allowed_domains } or null`

5472 5484 

5473 Filters for the search.5485 Filters for the search.


6486 6498 

6487 - `"computer_use_preview"`6499 - `"computer_use_preview"`

6488 6500 

6489 - `WebSearch object { type, filters, search_context_size, user_location }`6501 - `WebSearch object { type, external_web_access, filters, 2 more }`

6490 6502 

6491 Search the Internet for sources related to the prompt. Learn more about the6503 Search the Internet for sources related to the prompt. Learn more about the

6492 [web search tool](/docs/guides/tools-web-search).6504 [web search tool](/docs/guides/tools-web-search).


6499 6511 

6500 - `"web_search_2025_08_26"`6512 - `"web_search_2025_08_26"`

6501 6513 

6514 - `external_web_access: optional boolean`

6515 

6516 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

6517 

6502 - `filters: optional object { allowed_domains } or null`6518 - `filters: optional object { allowed_domains } or null`

6503 6519 

6504 Filters for the search.6520 Filters for the search.

Details

1435 1435 

1436 - `"computer_use_preview"`1436 - `"computer_use_preview"`

1437 1437 

1438 - `WebSearch object { type, filters, search_context_size, user_location }`1438 - `WebSearch object { type, external_web_access, filters, 2 more }`

1439 1439 

1440 Search the Internet for sources related to the prompt. Learn more about the1440 Search the Internet for sources related to the prompt. Learn more about the

1441 [web search tool](/docs/guides/tools-web-search).1441 [web search tool](/docs/guides/tools-web-search).


1448 1448 

1449 - `"web_search_2025_08_26"`1449 - `"web_search_2025_08_26"`

1450 1450 

1451 - `external_web_access: optional boolean`

1452 

1453 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1454 

1451 - `filters: optional object { allowed_domains } or null`1455 - `filters: optional object { allowed_domains } or null`

1452 1456 

1453 Filters for the search.1457 Filters for the search.


2466 2470 

2467 - `"computer_use_preview"`2471 - `"computer_use_preview"`

2468 2472 

2469 - `WebSearch object { type, filters, search_context_size, user_location }`2473 - `WebSearch object { type, external_web_access, filters, 2 more }`

2470 2474 

2471 Search the Internet for sources related to the prompt. Learn more about the2475 Search the Internet for sources related to the prompt. Learn more about the

2472 [web search tool](/docs/guides/tools-web-search).2476 [web search tool](/docs/guides/tools-web-search).


2479 2483 

2480 - `"web_search_2025_08_26"`2484 - `"web_search_2025_08_26"`

2481 2485 

2486 - `external_web_access: optional boolean`

2487 

2488 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2489 

2482 - `filters: optional object { allowed_domains } or null`2490 - `filters: optional object { allowed_domains } or null`

2483 2491 

2484 Filters for the search.2492 Filters for the search.

Details

1406 1406 

1407 - `"computer_use_preview"`1407 - `"computer_use_preview"`

1408 1408 

1409 - `WebSearch object { type, filters, search_context_size, user_location }`1409 - `WebSearch object { type, external_web_access, filters, 2 more }`

1410 1410 

1411 Search the Internet for sources related to the prompt. Learn more about the1411 Search the Internet for sources related to the prompt. Learn more about the

1412 [web search tool](/docs/guides/tools-web-search).1412 [web search tool](/docs/guides/tools-web-search).


1419 1419 

1420 - `"web_search_2025_08_26"`1420 - `"web_search_2025_08_26"`

1421 1421 

1422 - `external_web_access: optional boolean`

1423 

1424 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1425 

1422 - `filters: optional object { allowed_domains } or null`1426 - `filters: optional object { allowed_domains } or null`

1423 1427 

1424 Filters for the search.1428 Filters for the search.


2437 2441 

2438 - `"computer_use_preview"`2442 - `"computer_use_preview"`

2439 2443 

2440 - `WebSearch object { type, filters, search_context_size, user_location }`2444 - `WebSearch object { type, external_web_access, filters, 2 more }`

2441 2445 

2442 Search the Internet for sources related to the prompt. Learn more about the2446 Search the Internet for sources related to the prompt. Learn more about the

2443 [web search tool](/docs/guides/tools-web-search).2447 [web search tool](/docs/guides/tools-web-search).


2450 2454 

2451 - `"web_search_2025_08_26"`2455 - `"web_search_2025_08_26"`

2452 2456 

2457 - `external_web_access: optional boolean`

2458 

2459 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2460 

2453 - `filters: optional object { allowed_domains } or null`2461 - `filters: optional object { allowed_domains } or null`

2454 2462 

2455 Filters for the search.2463 Filters for the search.

Details

5098 5098 

5099 - `"computer_use_preview"`5099 - `"computer_use_preview"`

5100 5100 

5101 - `WebSearch object { type, filters, search_context_size, user_location }`5101 - `WebSearch object { type, external_web_access, filters, 2 more }`

5102 5102 

5103 Search the Internet for sources related to the prompt. Learn more about the5103 Search the Internet for sources related to the prompt. Learn more about the

5104 [web search tool](/docs/guides/tools-web-search).5104 [web search tool](/docs/guides/tools-web-search).


5111 5111 

5112 - `"web_search_2025_08_26"`5112 - `"web_search_2025_08_26"`

5113 5113 

5114 - `external_web_access: optional boolean`

5115 

5116 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

5117 

5114 - `filters: optional object { allowed_domains } or null`5118 - `filters: optional object { allowed_domains } or null`

5115 5119 

5116 Filters for the search.5120 Filters for the search.


7447 7451 

7448 - `"computer_use_preview"`7452 - `"computer_use_preview"`

7449 7453 

7450 - `WebSearch object { type, filters, search_context_size, user_location }`7454 - `WebSearch object { type, external_web_access, filters, 2 more }`

7451 7455 

7452 Search the Internet for sources related to the prompt. Learn more about the7456 Search the Internet for sources related to the prompt. Learn more about the

7453 [web search tool](/docs/guides/tools-web-search).7457 [web search tool](/docs/guides/tools-web-search).


7460 7464 

7461 - `"web_search_2025_08_26"`7465 - `"web_search_2025_08_26"`

7462 7466 

7467 - `external_web_access: optional boolean`

7468 

7469 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

7470 

7463 - `filters: optional object { allowed_domains } or null`7471 - `filters: optional object { allowed_domains } or null`

7464 7472 

7465 Filters for the search.7473 Filters for the search.


9467 9475 

9468 - `"computer_use_preview"`9476 - `"computer_use_preview"`

9469 9477 

9470 - `WebSearch object { type, filters, search_context_size, user_location }`9478 - `WebSearch object { type, external_web_access, filters, 2 more }`

9471 9479 

9472 Search the Internet for sources related to the prompt. Learn more about the9480 Search the Internet for sources related to the prompt. Learn more about the

9473 [web search tool](/docs/guides/tools-web-search).9481 [web search tool](/docs/guides/tools-web-search).


9480 9488 

9481 - `"web_search_2025_08_26"`9489 - `"web_search_2025_08_26"`

9482 9490 

9491 - `external_web_access: optional boolean`

9492 

9493 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

9494 

9483 - `filters: optional object { allowed_domains } or null`9495 - `filters: optional object { allowed_domains } or null`

9484 9496 

9485 Filters for the search.9497 Filters for the search.


11849 11861 

11850 - `"computer_use_preview"`11862 - `"computer_use_preview"`

11851 11863 

11852 - `WebSearch object { type, filters, search_context_size, user_location }`11864 - `WebSearch object { type, external_web_access, filters, 2 more }`

11853 11865 

11854 Search the Internet for sources related to the prompt. Learn more about the11866 Search the Internet for sources related to the prompt. Learn more about the

11855 [web search tool](/docs/guides/tools-web-search).11867 [web search tool](/docs/guides/tools-web-search).


11862 11874 

11863 - `"web_search_2025_08_26"`11875 - `"web_search_2025_08_26"`

11864 11876 

11877 - `external_web_access: optional boolean`

11878 

11879 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

11880 

11865 - `filters: optional object { allowed_domains } or null`11881 - `filters: optional object { allowed_domains } or null`

11866 11882 

11867 Filters for the search.11883 Filters for the search.


14165 14181 

14166 - `"computer_use_preview"`14182 - `"computer_use_preview"`

14167 14183 

14168 - `WebSearch object { type, filters, search_context_size, user_location }`14184 - `WebSearch object { type, external_web_access, filters, 2 more }`

14169 14185 

14170 Search the Internet for sources related to the prompt. Learn more about the14186 Search the Internet for sources related to the prompt. Learn more about the

14171 [web search tool](/docs/guides/tools-web-search).14187 [web search tool](/docs/guides/tools-web-search).


14178 14194 

14179 - `"web_search_2025_08_26"`14195 - `"web_search_2025_08_26"`

14180 14196 

14197 - `external_web_access: optional boolean`

14198 

14199 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

14200 

14181 - `filters: optional object { allowed_domains } or null`14201 - `filters: optional object { allowed_domains } or null`

14182 14202 

14183 Filters for the search.14203 Filters for the search.


17137 17157 

17138 - `"computer_use_preview"`17158 - `"computer_use_preview"`

17139 17159 

17140 - `WebSearch object { type, filters, search_context_size, user_location }`17160 - `WebSearch object { type, external_web_access, filters, 2 more }`

17141 17161 

17142 Search the Internet for sources related to the prompt. Learn more about the17162 Search the Internet for sources related to the prompt. Learn more about the

17143 [web search tool](/docs/guides/tools-web-search).17163 [web search tool](/docs/guides/tools-web-search).


17150 17170 

17151 - `"web_search_2025_08_26"`17171 - `"web_search_2025_08_26"`

17152 17172 

17173 - `external_web_access: optional boolean`

17174 

17175 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

17176 

17153 - `filters: optional object { allowed_domains } or null`17177 - `filters: optional object { allowed_domains } or null`

17154 17178 

17155 Filters for the search.17179 Filters for the search.


19259 19283 

19260 - `"computer_use_preview"`19284 - `"computer_use_preview"`

19261 19285 

19262 - `WebSearch object { type, filters, search_context_size, user_location }`19286 - `WebSearch object { type, external_web_access, filters, 2 more }`

19263 19287 

19264 Search the Internet for sources related to the prompt. Learn more about the19288 Search the Internet for sources related to the prompt. Learn more about the

19265 [web search tool](/docs/guides/tools-web-search).19289 [web search tool](/docs/guides/tools-web-search).


19272 19296 

19273 - `"web_search_2025_08_26"`19297 - `"web_search_2025_08_26"`

19274 19298 

19299 - `external_web_access: optional boolean`

19300 

19301 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

19302 

19275 - `filters: optional object { allowed_domains } or null`19303 - `filters: optional object { allowed_domains } or null`

19276 19304 

19277 Filters for the search.19305 Filters for the search.


21391 21419 

21392 - `"computer_use_preview"`21420 - `"computer_use_preview"`

21393 21421 

21394 - `WebSearch object { type, filters, search_context_size, user_location }`21422 - `WebSearch object { type, external_web_access, filters, 2 more }`

21395 21423 

21396 Search the Internet for sources related to the prompt. Learn more about the21424 Search the Internet for sources related to the prompt. Learn more about the

21397 [web search tool](/docs/guides/tools-web-search).21425 [web search tool](/docs/guides/tools-web-search).


21404 21432 

21405 - `"web_search_2025_08_26"`21433 - `"web_search_2025_08_26"`

21406 21434 

21435 - `external_web_access: optional boolean`

21436 

21437 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

21438 

21407 - `filters: optional object { allowed_domains } or null`21439 - `filters: optional object { allowed_domains } or null`

21408 21440 

21409 Filters for the search.21441 Filters for the search.


23513 23545 

23514 - `"computer_use_preview"`23546 - `"computer_use_preview"`

23515 23547 

23516 - `WebSearch object { type, filters, search_context_size, user_location }`23548 - `WebSearch object { type, external_web_access, filters, 2 more }`

23517 23549 

23518 Search the Internet for sources related to the prompt. Learn more about the23550 Search the Internet for sources related to the prompt. Learn more about the

23519 [web search tool](/docs/guides/tools-web-search).23551 [web search tool](/docs/guides/tools-web-search).


23526 23558 

23527 - `"web_search_2025_08_26"`23559 - `"web_search_2025_08_26"`

23528 23560 

23561 - `external_web_access: optional boolean`

23562 

23563 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

23564 

23529 - `filters: optional object { allowed_domains } or null`23565 - `filters: optional object { allowed_domains } or null`

23530 23566 

23531 Filters for the search.23567 Filters for the search.

Details

1166 1166 

1167 - `"computer_use_preview"`1167 - `"computer_use_preview"`

1168 1168 

1169 - `WebSearch object { type, filters, search_context_size, user_location }`1169 - `WebSearch object { type, external_web_access, filters, 2 more }`

1170 1170 

1171 Search the Internet for sources related to the prompt. Learn more about the1171 Search the Internet for sources related to the prompt. Learn more about the

1172 [web search tool](/docs/guides/tools-web-search).1172 [web search tool](/docs/guides/tools-web-search).


1179 1179 

1180 - `"web_search_2025_08_26"`1180 - `"web_search_2025_08_26"`

1181 1181 

1182 - `external_web_access: optional boolean`

1183 

1184 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1185 

1182 - `filters: optional object { allowed_domains } or null`1186 - `filters: optional object { allowed_domains } or null`

1183 1187 

1184 Filters for the search.1188 Filters for the search.


3515 3519 

3516 - `"computer_use_preview"`3520 - `"computer_use_preview"`

3517 3521 

3518 - `WebSearch object { type, filters, search_context_size, user_location }`3522 - `WebSearch object { type, external_web_access, filters, 2 more }`

3519 3523 

3520 Search the Internet for sources related to the prompt. Learn more about the3524 Search the Internet for sources related to the prompt. Learn more about the

3521 [web search tool](/docs/guides/tools-web-search).3525 [web search tool](/docs/guides/tools-web-search).


3528 3532 

3529 - `"web_search_2025_08_26"`3533 - `"web_search_2025_08_26"`

3530 3534 

3535 - `external_web_access: optional boolean`

3536 

3537 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

3538 

3531 - `filters: optional object { allowed_domains } or null`3539 - `filters: optional object { allowed_domains } or null`

3532 3540 

3533 Filters for the search.3541 Filters for the search.


5535 5543 

5536 - `"computer_use_preview"`5544 - `"computer_use_preview"`

5537 5545 

5538 - `WebSearch object { type, filters, search_context_size, user_location }`5546 - `WebSearch object { type, external_web_access, filters, 2 more }`

5539 5547 

5540 Search the Internet for sources related to the prompt. Learn more about the5548 Search the Internet for sources related to the prompt. Learn more about the

5541 [web search tool](/docs/guides/tools-web-search).5549 [web search tool](/docs/guides/tools-web-search).


5548 5556 

5549 - `"web_search_2025_08_26"`5557 - `"web_search_2025_08_26"`

5550 5558 

5559 - `external_web_access: optional boolean`

5560 

5561 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

5562 

5551 - `filters: optional object { allowed_domains } or null`5563 - `filters: optional object { allowed_domains } or null`

5552 5564 

5553 Filters for the search.5565 Filters for the search.


7917 7929 

7918 - `"computer_use_preview"`7930 - `"computer_use_preview"`

7919 7931 

7920 - `WebSearch object { type, filters, search_context_size, user_location }`7932 - `WebSearch object { type, external_web_access, filters, 2 more }`

7921 7933 

7922 Search the Internet for sources related to the prompt. Learn more about the7934 Search the Internet for sources related to the prompt. Learn more about the

7923 [web search tool](/docs/guides/tools-web-search).7935 [web search tool](/docs/guides/tools-web-search).


7930 7942 

7931 - `"web_search_2025_08_26"`7943 - `"web_search_2025_08_26"`

7932 7944 

7945 - `external_web_access: optional boolean`

7946 

7947 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

7948 

7933 - `filters: optional object { allowed_domains } or null`7949 - `filters: optional object { allowed_domains } or null`

7934 7950 

7935 Filters for the search.7951 Filters for the search.


10233 10249 

10234 - `"computer_use_preview"`10250 - `"computer_use_preview"`

10235 10251 

10236 - `WebSearch object { type, filters, search_context_size, user_location }`10252 - `WebSearch object { type, external_web_access, filters, 2 more }`

10237 10253 

10238 Search the Internet for sources related to the prompt. Learn more about the10254 Search the Internet for sources related to the prompt. Learn more about the

10239 [web search tool](/docs/guides/tools-web-search).10255 [web search tool](/docs/guides/tools-web-search).


10246 10262 

10247 - `"web_search_2025_08_26"`10263 - `"web_search_2025_08_26"`

10248 10264 

10265 - `external_web_access: optional boolean`

10266 

10267 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

10268 

10249 - `filters: optional object { allowed_domains } or null`10269 - `filters: optional object { allowed_domains } or null`

10250 10270 

10251 Filters for the search.10271 Filters for the search.


13205 13225 

13206 - `"computer_use_preview"`13226 - `"computer_use_preview"`

13207 13227 

13208 - `WebSearch object { type, filters, search_context_size, user_location }`13228 - `WebSearch object { type, external_web_access, filters, 2 more }`

13209 13229 

13210 Search the Internet for sources related to the prompt. Learn more about the13230 Search the Internet for sources related to the prompt. Learn more about the

13211 [web search tool](/docs/guides/tools-web-search).13231 [web search tool](/docs/guides/tools-web-search).


13218 13238 

13219 - `"web_search_2025_08_26"`13239 - `"web_search_2025_08_26"`

13220 13240 

13241 - `external_web_access: optional boolean`

13242 

13243 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

13244 

13221 - `filters: optional object { allowed_domains } or null`13245 - `filters: optional object { allowed_domains } or null`

13222 13246 

13223 Filters for the search.13247 Filters for the search.


15327 15351 

15328 - `"computer_use_preview"`15352 - `"computer_use_preview"`

15329 15353 

15330 - `WebSearch object { type, filters, search_context_size, user_location }`15354 - `WebSearch object { type, external_web_access, filters, 2 more }`

15331 15355 

15332 Search the Internet for sources related to the prompt. Learn more about the15356 Search the Internet for sources related to the prompt. Learn more about the

15333 [web search tool](/docs/guides/tools-web-search).15357 [web search tool](/docs/guides/tools-web-search).


15340 15364 

15341 - `"web_search_2025_08_26"`15365 - `"web_search_2025_08_26"`

15342 15366 

15367 - `external_web_access: optional boolean`

15368 

15369 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

15370 

15343 - `filters: optional object { allowed_domains } or null`15371 - `filters: optional object { allowed_domains } or null`

15344 15372 

15345 Filters for the search.15373 Filters for the search.


17459 17487 

17460 - `"computer_use_preview"`17488 - `"computer_use_preview"`

17461 17489 

17462 - `WebSearch object { type, filters, search_context_size, user_location }`17490 - `WebSearch object { type, external_web_access, filters, 2 more }`

17463 17491 

17464 Search the Internet for sources related to the prompt. Learn more about the17492 Search the Internet for sources related to the prompt. Learn more about the

17465 [web search tool](/docs/guides/tools-web-search).17493 [web search tool](/docs/guides/tools-web-search).


17472 17500 

17473 - `"web_search_2025_08_26"`17501 - `"web_search_2025_08_26"`

17474 17502 

17503 - `external_web_access: optional boolean`

17504 

17505 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

17506 

17475 - `filters: optional object { allowed_domains } or null`17507 - `filters: optional object { allowed_domains } or null`

17476 17508 

17477 Filters for the search.17509 Filters for the search.


19581 19613 

19582 - `"computer_use_preview"`19614 - `"computer_use_preview"`

19583 19615 

19584 - `WebSearch object { type, filters, search_context_size, user_location }`19616 - `WebSearch object { type, external_web_access, filters, 2 more }`

19585 19617 

19586 Search the Internet for sources related to the prompt. Learn more about the19618 Search the Internet for sources related to the prompt. Learn more about the

19587 [web search tool](/docs/guides/tools-web-search).19619 [web search tool](/docs/guides/tools-web-search).


19594 19626 

19595 - `"web_search_2025_08_26"`19627 - `"web_search_2025_08_26"`

19596 19628 

19629 - `external_web_access: optional boolean`

19630 

19631 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

19632 

19597 - `filters: optional object { allowed_domains } or null`19633 - `filters: optional object { allowed_domains } or null`

19598 19634 

19599 Filters for the search.19635 Filters for the search.

Details

1164 1164 

1165 - `"computer_use_preview"`1165 - `"computer_use_preview"`

1166 1166 

1167 - `WebSearch object { type, filters, search_context_size, user_location }`1167 - `WebSearch object { type, external_web_access, filters, 2 more }`

1168 1168 

1169 Search the Internet for sources related to the prompt. Learn more about the1169 Search the Internet for sources related to the prompt. Learn more about the

1170 [web search tool](/docs/guides/tools-web-search).1170 [web search tool](/docs/guides/tools-web-search).


1177 1177 

1178 - `"web_search_2025_08_26"`1178 - `"web_search_2025_08_26"`

1179 1179 

1180 - `external_web_access: optional boolean`

1181 

1182 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1183 

1180 - `filters: optional object { allowed_domains } or null`1184 - `filters: optional object { allowed_domains } or null`

1181 1185 

1182 Filters for the search.1186 Filters for the search.

Details

1154 1154 

1155 - `"computer_use_preview"`1155 - `"computer_use_preview"`

1156 1156 

1157 - `WebSearch object { type, filters, search_context_size, user_location }`1157 - `WebSearch object { type, external_web_access, filters, 2 more }`

1158 1158 

1159 Search the Internet for sources related to the prompt. Learn more about the1159 Search the Internet for sources related to the prompt. Learn more about the

1160 [web search tool](/docs/guides/tools-web-search).1160 [web search tool](/docs/guides/tools-web-search).


1167 1167 

1168 - `"web_search_2025_08_26"`1168 - `"web_search_2025_08_26"`

1169 1169 

1170 - `external_web_access: optional boolean`

1171 

1172 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1173 

1170 - `filters: optional object { allowed_domains } or null`1174 - `filters: optional object { allowed_domains } or null`

1171 1175 

1172 Filters for the search.1176 Filters for the search.


3174 3178 

3175 - `"computer_use_preview"`3179 - `"computer_use_preview"`

3176 3180 

3177 - `WebSearch object { type, filters, search_context_size, user_location }`3181 - `WebSearch object { type, external_web_access, filters, 2 more }`

3178 3182 

3179 Search the Internet for sources related to the prompt. Learn more about the3183 Search the Internet for sources related to the prompt. Learn more about the

3180 [web search tool](/docs/guides/tools-web-search).3184 [web search tool](/docs/guides/tools-web-search).


3187 3191 

3188 - `"web_search_2025_08_26"`3192 - `"web_search_2025_08_26"`

3189 3193 

3194 - `external_web_access: optional boolean`

3195 

3196 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

3197 

3190 - `filters: optional object { allowed_domains } or null`3198 - `filters: optional object { allowed_domains } or null`

3191 3199 

3192 Filters for the search.3200 Filters for the search.

Details

1198 1198 

1199 - `"computer_use_preview"`1199 - `"computer_use_preview"`

1200 1200 

1201 - `WebSearch object { type, filters, search_context_size, user_location }`1201 - `WebSearch object { type, external_web_access, filters, 2 more }`

1202 1202 

1203 Search the Internet for sources related to the prompt. Learn more about the1203 Search the Internet for sources related to the prompt. Learn more about the

1204 [web search tool](/docs/guides/tools-web-search).1204 [web search tool](/docs/guides/tools-web-search).


1211 1211 

1212 - `"web_search_2025_08_26"`1212 - `"web_search_2025_08_26"`

1213 1213 

1214 - `external_web_access: optional boolean`

1215 

1216 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1217 

1214 - `filters: optional object { allowed_domains } or null`1218 - `filters: optional object { allowed_domains } or null`

1215 1219 

1216 Filters for the search.1220 Filters for the search.

Details

1164 1164 

1165 - `"computer_use_preview"`1165 - `"computer_use_preview"`

1166 1166 

1167 - `WebSearch object { type, filters, search_context_size, user_location }`1167 - `WebSearch object { type, external_web_access, filters, 2 more }`

1168 1168 

1169 Search the Internet for sources related to the prompt. Learn more about the1169 Search the Internet for sources related to the prompt. Learn more about the

1170 [web search tool](/docs/guides/tools-web-search).1170 [web search tool](/docs/guides/tools-web-search).


1177 1177 

1178 - `"web_search_2025_08_26"`1178 - `"web_search_2025_08_26"`

1179 1179 

1180 - `external_web_access: optional boolean`

1181 

1182 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1183 

1180 - `filters: optional object { allowed_domains } or null`1184 - `filters: optional object { allowed_domains } or null`

1181 1185 

1182 Filters for the search.1186 Filters for the search.

Details

4 4 

5**get** `/files/{file_id}/content`5**get** `/files/{file_id}/content`

6 6 

7Returns the contents of the specified file.7Returns a response containing the contents of the specified file.

8 8 

9### Path Parameters9### Path Parameters

10 10 

Details

2 2 

3**get** `/files/{file_id}/content`3**get** `/files/{file_id}/content`

4 4 

5Returns the contents of the specified file.5Returns a response containing the contents of the specified file.

6 6 

7### Path Parameters7### Path Parameters

8 8 

Details

1498 1498 

1499 - `"computer_use_preview"`1499 - `"computer_use_preview"`

1500 1500 

1501 - `WebSearch object { type, filters, search_context_size, user_location }`1501 - `WebSearch object { type, external_web_access, filters, 2 more }`

1502 1502 

1503 Search the Internet for sources related to the prompt. Learn more about the1503 Search the Internet for sources related to the prompt. Learn more about the

1504 [web search tool](/docs/guides/tools-web-search).1504 [web search tool](/docs/guides/tools-web-search).


1511 1511 

1512 - `"web_search_2025_08_26"`1512 - `"web_search_2025_08_26"`

1513 1513 

1514 - `external_web_access: optional boolean`

1515 

1516 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1517 

1514 - `filters: optional object { allowed_domains } or null`1518 - `filters: optional object { allowed_domains } or null`

1515 1519 

1516 Filters for the search.1520 Filters for the search.


2533 2537 

2534 - `"computer_use_preview"`2538 - `"computer_use_preview"`

2535 2539 

2536 - `WebSearch object { type, filters, search_context_size, user_location }`2540 - `WebSearch object { type, external_web_access, filters, 2 more }`

2537 2541 

2538 Search the Internet for sources related to the prompt. Learn more about the2542 Search the Internet for sources related to the prompt. Learn more about the

2539 [web search tool](/docs/guides/tools-web-search).2543 [web search tool](/docs/guides/tools-web-search).


2546 2550 

2547 - `"web_search_2025_08_26"`2551 - `"web_search_2025_08_26"`

2548 2552 

2553 - `external_web_access: optional boolean`

2554 

2555 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2556 

2549 - `filters: optional object { allowed_domains } or null`2557 - `filters: optional object { allowed_domains } or null`

2550 2558 

2551 Filters for the search.2559 Filters for the search.


4163 4171 

4164 - `string`4172 - `string`

4165 4173 

4166 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more`4174 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`

4167 4175 

4168 - `"gpt-5.6-sol"`4176 - `"gpt-5.6-sol"`

4169 4177 


4173 4181 

4174 - `"gpt-5.5"`4182 - `"gpt-5.5"`

4175 4183 

4184 - `"gpt-5.5-2026-04-23"`

4185 

4176 - `"gpt-5.4"`4186 - `"gpt-5.4"`

4177 4187 

4178 - `"gpt-5.4-mini"`4188 - `"gpt-5.4-mini"`


4329 4339 

4330 - `"gpt-3.5-turbo-16k-0613"`4340 - `"gpt-3.5-turbo-16k-0613"`

4331 4341 

4332 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more`4342 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`

4333 4343 

4334 - `"o1-pro"`4344 - `"o1-pro"`

4335 4345 


4351 4361 

4352 - `"computer-use-preview-2025-03-11"`4362 - `"computer-use-preview-2025-03-11"`

4353 4363 

4364 - `"gpt-5.5-pro"`

4365 

4366 - `"gpt-5.5-pro-2026-04-23"`

4367 

4354 - `"gpt-5-codex"`4368 - `"gpt-5-codex"`

4355 4369 

4356 - `"gpt-5-pro"`4370 - `"gpt-5-pro"`


5137 5151 

5138 - `"computer_use_preview"`5152 - `"computer_use_preview"`

5139 5153 

5140 - `WebSearch object { type, filters, search_context_size, user_location }`5154 - `WebSearch object { type, external_web_access, filters, 2 more }`

5141 5155 

5142 Search the Internet for sources related to the prompt. Learn more about the5156 Search the Internet for sources related to the prompt. Learn more about the

5143 [web search tool](/docs/guides/tools-web-search).5157 [web search tool](/docs/guides/tools-web-search).


5150 5164 

5151 - `"web_search_2025_08_26"`5165 - `"web_search_2025_08_26"`

5152 5166 

5167 - `external_web_access: optional boolean`

5168 

5169 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

5170 

5153 - `filters: optional object { allowed_domains } or null`5171 - `filters: optional object { allowed_domains } or null`

5154 5172 

5155 Filters for the search.5173 Filters for the search.


5986 6004 

5987 - `"computer_use_preview"`6005 - `"computer_use_preview"`

5988 6006 

5989 - `WebSearch object { type, filters, search_context_size, user_location }`6007 - `WebSearch object { type, external_web_access, filters, 2 more }`

5990 6008 

5991 Search the Internet for sources related to the prompt. Learn more about the6009 Search the Internet for sources related to the prompt. Learn more about the

5992 [web search tool](/docs/guides/tools-web-search).6010 [web search tool](/docs/guides/tools-web-search).


5999 6017 

6000 - `"web_search_2025_08_26"`6018 - `"web_search_2025_08_26"`

6001 6019 

6020 - `external_web_access: optional boolean`

6021 

6022 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

6023 

6002 - `filters: optional object { allowed_domains } or null`6024 - `filters: optional object { allowed_domains } or null`

6003 6025 

6004 Filters for the search.6026 Filters for the search.


7834 7856 

7835 - `"computer_use_preview"`7857 - `"computer_use_preview"`

7836 7858 

7837 - `WebSearch object { type, filters, search_context_size, user_location }`7859 - `WebSearch object { type, external_web_access, filters, 2 more }`

7838 7860 

7839 Search the Internet for sources related to the prompt. Learn more about the7861 Search the Internet for sources related to the prompt. Learn more about the

7840 [web search tool](/docs/guides/tools-web-search).7862 [web search tool](/docs/guides/tools-web-search).


7847 7869 

7848 - `"web_search_2025_08_26"`7870 - `"web_search_2025_08_26"`

7849 7871 

7872 - `external_web_access: optional boolean`

7873 

7874 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

7875 

7850 - `filters: optional object { allowed_domains } or null`7876 - `filters: optional object { allowed_domains } or null`

7851 7877 

7852 Filters for the search.7878 Filters for the search.


8836 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.8862 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.

8837 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).8863 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).

8838 8864 

8839 - `service_tier: optional "auto" or "default" or "flex" or 3 more or null`8865 - `service_tier: optional "auto" or "default" or "flex" or 4 more or null`

8840 8866 

8841 Specifies the processing type used for serving the request.8867 Specifies the processing type used for serving the request.

8842 8868 


8844 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.8870 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.

8845 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.8871 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.

8846 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.8872 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.

8873 - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`.

8847 - When not set, the default behavior is 'auto'.8874 - When not set, the default behavior is 'auto'.

8848 8875 

8849 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.8876 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.


8860 8887 

8861 - `"fast"`8888 - `"fast"`

8862 8889 

8890 - `"ultrafast"`

8891 

8863 - `status: optional ResponseStatus`8892 - `status: optional ResponseStatus`

8864 8893 

8865 The status of the response generation. One of `completed`, `failed`,8894 The status of the response generation. One of `completed`, `failed`,

Details

8 8 

9### Body Parameters9### Body Parameters

10 10 

11- `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more or string or null`11- `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more or string or null`

12 12 

13 Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.13 Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.

14 14 

15 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more`15 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more`

16 16 

17 Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.17 Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.

18 18 


24 24 

25 - `"gpt-5.5"`25 - `"gpt-5.5"`

26 26 

27 - `"gpt-5.5-2026-04-23"`

28 

27 - `"gpt-5.4"`29 - `"gpt-5.4"`

28 30 

29 - `"gpt-5.4-mini"`31 - `"gpt-5.4-mini"`


200 202 

201 - `"computer-use-preview-2025-03-11"`203 - `"computer-use-preview-2025-03-11"`

202 204 

205 - `"gpt-5.5-pro"`

206 

207 - `"gpt-5.5-pro-2026-04-23"`

208 

203 - `"gpt-5-codex"`209 - `"gpt-5-codex"`

204 210 

205 - `"gpt-5-pro"`211 - `"gpt-5-pro"`


1622 1628 

1623 - `"computer_use_preview"`1629 - `"computer_use_preview"`

1624 1630 

1625 - `WebSearch object { type, filters, search_context_size, user_location }`1631 - `WebSearch object { type, external_web_access, filters, 2 more }`

1626 1632 

1627 Search the Internet for sources related to the prompt. Learn more about the1633 Search the Internet for sources related to the prompt. Learn more about the

1628 [web search tool](/docs/guides/tools-web-search).1634 [web search tool](/docs/guides/tools-web-search).


1635 1641 

1636 - `"web_search_2025_08_26"`1642 - `"web_search_2025_08_26"`

1637 1643 

1644 - `external_web_access: optional boolean`

1645 

1646 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1647 

1638 - `filters: optional object { allowed_domains } or null`1648 - `filters: optional object { allowed_domains } or null`

1639 1649 

1640 Filters for the search.1650 Filters for the search.


2657 2667 

2658 - `"computer_use_preview"`2668 - `"computer_use_preview"`

2659 2669 

2660 - `WebSearch object { type, filters, search_context_size, user_location }`2670 - `WebSearch object { type, external_web_access, filters, 2 more }`

2661 2671 

2662 Search the Internet for sources related to the prompt. Learn more about the2672 Search the Internet for sources related to the prompt. Learn more about the

2663 [web search tool](/docs/guides/tools-web-search).2673 [web search tool](/docs/guides/tools-web-search).


2670 2680 

2671 - `"web_search_2025_08_26"`2681 - `"web_search_2025_08_26"`

2672 2682 

2683 - `external_web_access: optional boolean`

2684 

2685 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2686 

2673 - `filters: optional object { allowed_domains } or null`2687 - `filters: optional object { allowed_domains } or null`

2674 2688 

2675 Filters for the search.2689 Filters for the search.


5130 5144 

5131 - `"computer_use_preview"`5145 - `"computer_use_preview"`

5132 5146 

5133 - `WebSearch object { type, filters, search_context_size, user_location }`5147 - `WebSearch object { type, external_web_access, filters, 2 more }`

5134 5148 

5135 Search the Internet for sources related to the prompt. Learn more about the5149 Search the Internet for sources related to the prompt. Learn more about the

5136 [web search tool](/docs/guides/tools-web-search).5150 [web search tool](/docs/guides/tools-web-search).


5143 5157 

5144 - `"web_search_2025_08_26"`5158 - `"web_search_2025_08_26"`

5145 5159 

5160 - `external_web_access: optional boolean`

5161 

5162 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

5163 

5146 - `filters: optional object { allowed_domains } or null`5164 - `filters: optional object { allowed_domains } or null`

5147 5165 

5148 Filters for the search.5166 Filters for the search.


6161 6179 

6162 - `"computer_use_preview"`6180 - `"computer_use_preview"`

6163 6181 

6164 - `WebSearch object { type, filters, search_context_size, user_location }`6182 - `WebSearch object { type, external_web_access, filters, 2 more }`

6165 6183 

6166 Search the Internet for sources related to the prompt. Learn more about the6184 Search the Internet for sources related to the prompt. Learn more about the

6167 [web search tool](/docs/guides/tools-web-search).6185 [web search tool](/docs/guides/tools-web-search).


6174 6192 

6175 - `"web_search_2025_08_26"`6193 - `"web_search_2025_08_26"`

6176 6194 

6195 - `external_web_access: optional boolean`

6196 

6197 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

6198 

6177 - `filters: optional object { allowed_domains } or null`6199 - `filters: optional object { allowed_domains } or null`

6178 6200 

6179 Filters for the search.6201 Filters for the search.

Details

1490 1490 

1491 - `"computer_use_preview"`1491 - `"computer_use_preview"`

1492 1492 

1493 - `WebSearch object { type, filters, search_context_size, user_location }`1493 - `WebSearch object { type, external_web_access, filters, 2 more }`

1494 1494 

1495 Search the Internet for sources related to the prompt. Learn more about the1495 Search the Internet for sources related to the prompt. Learn more about the

1496 [web search tool](/docs/guides/tools-web-search).1496 [web search tool](/docs/guides/tools-web-search).


1503 1503 

1504 - `"web_search_2025_08_26"`1504 - `"web_search_2025_08_26"`

1505 1505 

1506 - `external_web_access: optional boolean`

1507 

1508 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1509 

1506 - `filters: optional object { allowed_domains } or null`1510 - `filters: optional object { allowed_domains } or null`

1507 1511 

1508 Filters for the search.1512 Filters for the search.


2525 2529 

2526 - `"computer_use_preview"`2530 - `"computer_use_preview"`

2527 2531 

2528 - `WebSearch object { type, filters, search_context_size, user_location }`2532 - `WebSearch object { type, external_web_access, filters, 2 more }`

2529 2533 

2530 Search the Internet for sources related to the prompt. Learn more about the2534 Search the Internet for sources related to the prompt. Learn more about the

2531 [web search tool](/docs/guides/tools-web-search).2535 [web search tool](/docs/guides/tools-web-search).


2538 2542 

2539 - `"web_search_2025_08_26"`2543 - `"web_search_2025_08_26"`

2540 2544 

2545 - `external_web_access: optional boolean`

2546 

2547 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2548 

2541 - `filters: optional object { allowed_domains } or null`2549 - `filters: optional object { allowed_domains } or null`

2542 2550 

2543 Filters for the search.2551 Filters for the search.


4171 4179 

4172 - `string`4180 - `string`

4173 4181 

4174 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more`4182 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`

4175 4183 

4176 - `"gpt-5.6-sol"`4184 - `"gpt-5.6-sol"`

4177 4185 


4181 4189 

4182 - `"gpt-5.5"`4190 - `"gpt-5.5"`

4183 4191 

4192 - `"gpt-5.5-2026-04-23"`

4193 

4184 - `"gpt-5.4"`4194 - `"gpt-5.4"`

4185 4195 

4186 - `"gpt-5.4-mini"`4196 - `"gpt-5.4-mini"`


4337 4347 

4338 - `"gpt-3.5-turbo-16k-0613"`4348 - `"gpt-3.5-turbo-16k-0613"`

4339 4349 

4340 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more`4350 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`

4341 4351 

4342 - `"o1-pro"`4352 - `"o1-pro"`

4343 4353 


4359 4369 

4360 - `"computer-use-preview-2025-03-11"`4370 - `"computer-use-preview-2025-03-11"`

4361 4371 

4372 - `"gpt-5.5-pro"`

4373 

4374 - `"gpt-5.5-pro-2026-04-23"`

4375 

4362 - `"gpt-5-codex"`4376 - `"gpt-5-codex"`

4363 4377 

4364 - `"gpt-5-pro"`4378 - `"gpt-5-pro"`


4587 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.4601 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.

4588 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).4602 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).

4589 4603 

4590- `service_tier: optional "auto" or "default" or "flex" or 3 more or null`4604- `service_tier: optional "auto" or "default" or "flex" or 4 more or null`

4591 4605 

4592 Specifies the processing type used for serving the request.4606 Specifies the processing type used for serving the request.

4593 4607 


4595 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.4609 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.

4596 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.4610 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.

4597 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.4611 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.

4612 - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`.

4598 - When not set, the default behavior is 'auto'.4613 - When not set, the default behavior is 'auto'.

4599 4614 

4600 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.4615 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.


4611 4626 

4612 - `"fast"`4627 - `"fast"`

4613 4628 

4629 - `"ultrafast"`

4630 

4614- `store: optional boolean or null`4631- `store: optional boolean or null`

4615 4632 

4616 Whether to store the generated model response for later retrieval via4633 Whether to store the generated model response for later retrieval via


5068 5085 

5069 - `"computer_use_preview"`5086 - `"computer_use_preview"`

5070 5087 

5071 - `WebSearch object { type, filters, search_context_size, user_location }`5088 - `WebSearch object { type, external_web_access, filters, 2 more }`

5072 5089 

5073 Search the Internet for sources related to the prompt. Learn more about the5090 Search the Internet for sources related to the prompt. Learn more about the

5074 [web search tool](/docs/guides/tools-web-search).5091 [web search tool](/docs/guides/tools-web-search).


5081 5098 

5082 - `"web_search_2025_08_26"`5099 - `"web_search_2025_08_26"`

5083 5100 

5101 - `external_web_access: optional boolean`

5102 

5103 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

5104 

5084 - `filters: optional object { allowed_domains } or null`5105 - `filters: optional object { allowed_domains } or null`

5085 5106 

5086 Filters for the search.5107 Filters for the search.


7259 7280 

7260 - `"computer_use_preview"`7281 - `"computer_use_preview"`

7261 7282 

7262 - `WebSearch object { type, filters, search_context_size, user_location }`7283 - `WebSearch object { type, external_web_access, filters, 2 more }`

7263 7284 

7264 Search the Internet for sources related to the prompt. Learn more about the7285 Search the Internet for sources related to the prompt. Learn more about the

7265 [web search tool](/docs/guides/tools-web-search).7286 [web search tool](/docs/guides/tools-web-search).


7272 7293 

7273 - `"web_search_2025_08_26"`7294 - `"web_search_2025_08_26"`

7274 7295 

7296 - `external_web_access: optional boolean`

7297 

7298 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

7299 

7275 - `filters: optional object { allowed_domains } or null`7300 - `filters: optional object { allowed_domains } or null`

7276 7301 

7277 Filters for the search.7302 Filters for the search.


8294 8319 

8295 - `"computer_use_preview"`8320 - `"computer_use_preview"`

8296 8321 

8297 - `WebSearch object { type, filters, search_context_size, user_location }`8322 - `WebSearch object { type, external_web_access, filters, 2 more }`

8298 8323 

8299 Search the Internet for sources related to the prompt. Learn more about the8324 Search the Internet for sources related to the prompt. Learn more about the

8300 [web search tool](/docs/guides/tools-web-search).8325 [web search tool](/docs/guides/tools-web-search).


8307 8332 

8308 - `"web_search_2025_08_26"`8333 - `"web_search_2025_08_26"`

8309 8334 

8335 - `external_web_access: optional boolean`

8336 

8337 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

8338 

8310 - `filters: optional object { allowed_domains } or null`8339 - `filters: optional object { allowed_domains } or null`

8311 8340 

8312 Filters for the search.8341 Filters for the search.


9924 9953 

9925 - `string`9954 - `string`

9926 9955 

9927 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more`9956 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`

9928 9957 

9929 - `"gpt-5.6-sol"`9958 - `"gpt-5.6-sol"`

9930 9959 


9934 9963 

9935 - `"gpt-5.5"`9964 - `"gpt-5.5"`

9936 9965 

9966 - `"gpt-5.5-2026-04-23"`

9967 

9937 - `"gpt-5.4"`9968 - `"gpt-5.4"`

9938 9969 

9939 - `"gpt-5.4-mini"`9970 - `"gpt-5.4-mini"`


10090 10121 

10091 - `"gpt-3.5-turbo-16k-0613"`10122 - `"gpt-3.5-turbo-16k-0613"`

10092 10123 

10093 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more`10124 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`

10094 10125 

10095 - `"o1-pro"`10126 - `"o1-pro"`

10096 10127 


10112 10143 

10113 - `"computer-use-preview-2025-03-11"`10144 - `"computer-use-preview-2025-03-11"`

10114 10145 

10146 - `"gpt-5.5-pro"`

10147 

10148 - `"gpt-5.5-pro-2026-04-23"`

10149 

10115 - `"gpt-5-codex"`10150 - `"gpt-5-codex"`

10116 10151 

10117 - `"gpt-5-pro"`10152 - `"gpt-5-pro"`


10898 10933 

10899 - `"computer_use_preview"`10934 - `"computer_use_preview"`

10900 10935 

10901 - `WebSearch object { type, filters, search_context_size, user_location }`10936 - `WebSearch object { type, external_web_access, filters, 2 more }`

10902 10937 

10903 Search the Internet for sources related to the prompt. Learn more about the10938 Search the Internet for sources related to the prompt. Learn more about the

10904 [web search tool](/docs/guides/tools-web-search).10939 [web search tool](/docs/guides/tools-web-search).


10911 10946 

10912 - `"web_search_2025_08_26"`10947 - `"web_search_2025_08_26"`

10913 10948 

10949 - `external_web_access: optional boolean`

10950 

10951 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

10952 

10914 - `filters: optional object { allowed_domains } or null`10953 - `filters: optional object { allowed_domains } or null`

10915 10954 

10916 Filters for the search.10955 Filters for the search.


11747 11786 

11748 - `"computer_use_preview"`11787 - `"computer_use_preview"`

11749 11788 

11750 - `WebSearch object { type, filters, search_context_size, user_location }`11789 - `WebSearch object { type, external_web_access, filters, 2 more }`

11751 11790 

11752 Search the Internet for sources related to the prompt. Learn more about the11791 Search the Internet for sources related to the prompt. Learn more about the

11753 [web search tool](/docs/guides/tools-web-search).11792 [web search tool](/docs/guides/tools-web-search).


11760 11799 

11761 - `"web_search_2025_08_26"`11800 - `"web_search_2025_08_26"`

11762 11801 

11802 - `external_web_access: optional boolean`

11803 

11804 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

11805 

11763 - `filters: optional object { allowed_domains } or null`11806 - `filters: optional object { allowed_domains } or null`

11764 11807 

11765 Filters for the search.11808 Filters for the search.


13595 13638 

13596 - `"computer_use_preview"`13639 - `"computer_use_preview"`

13597 13640 

13598 - `WebSearch object { type, filters, search_context_size, user_location }`13641 - `WebSearch object { type, external_web_access, filters, 2 more }`

13599 13642 

13600 Search the Internet for sources related to the prompt. Learn more about the13643 Search the Internet for sources related to the prompt. Learn more about the

13601 [web search tool](/docs/guides/tools-web-search).13644 [web search tool](/docs/guides/tools-web-search).


13608 13651 

13609 - `"web_search_2025_08_26"`13652 - `"web_search_2025_08_26"`

13610 13653 

13654 - `external_web_access: optional boolean`

13655 

13656 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

13657 

13611 - `filters: optional object { allowed_domains } or null`13658 - `filters: optional object { allowed_domains } or null`

13612 13659 

13613 Filters for the search.13660 Filters for the search.


14597 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.14644 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.

14598 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).14645 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).

14599 14646 

14600 - `service_tier: optional "auto" or "default" or "flex" or 3 more or null`14647 - `service_tier: optional "auto" or "default" or "flex" or 4 more or null`

14601 14648 

14602 Specifies the processing type used for serving the request.14649 Specifies the processing type used for serving the request.

14603 14650 


14605 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.14652 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.

14606 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.14653 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.

14607 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.14654 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.

14655 - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`.

14608 - When not set, the default behavior is 'auto'.14656 - When not set, the default behavior is 'auto'.

14609 14657 

14610 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.14658 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.


14621 14669 

14622 - `"fast"`14670 - `"fast"`

14623 14671 

14672 - `"ultrafast"`

14673 

14624 - `status: optional ResponseStatus`14674 - `status: optional ResponseStatus`

14625 14675 

14626 The status of the response generation. One of `completed`, `failed`,14676 The status of the response generation. One of `completed`, `failed`,

Details

1542 1542 

1543 - `"computer_use_preview"`1543 - `"computer_use_preview"`

1544 1544 

1545 - `WebSearch object { type, filters, search_context_size, user_location }`1545 - `WebSearch object { type, external_web_access, filters, 2 more }`

1546 1546 

1547 Search the Internet for sources related to the prompt. Learn more about the1547 Search the Internet for sources related to the prompt. Learn more about the

1548 [web search tool](/docs/guides/tools-web-search).1548 [web search tool](/docs/guides/tools-web-search).


1555 1555 

1556 - `"web_search_2025_08_26"`1556 - `"web_search_2025_08_26"`

1557 1557 

1558 - `external_web_access: optional boolean`

1559 

1560 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1561 

1558 - `filters: optional object { allowed_domains } or null`1562 - `filters: optional object { allowed_domains } or null`

1559 1563 

1560 Filters for the search.1564 Filters for the search.


2577 2581 

2578 - `"computer_use_preview"`2582 - `"computer_use_preview"`

2579 2583 

2580 - `WebSearch object { type, filters, search_context_size, user_location }`2584 - `WebSearch object { type, external_web_access, filters, 2 more }`

2581 2585 

2582 Search the Internet for sources related to the prompt. Learn more about the2586 Search the Internet for sources related to the prompt. Learn more about the

2583 [web search tool](/docs/guides/tools-web-search).2587 [web search tool](/docs/guides/tools-web-search).


2590 2594 

2591 - `"web_search_2025_08_26"`2595 - `"web_search_2025_08_26"`

2592 2596 

2597 - `external_web_access: optional boolean`

2598 

2599 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2600 

2593 - `filters: optional object { allowed_domains } or null`2601 - `filters: optional object { allowed_domains } or null`

2594 2602 

2595 Filters for the search.2603 Filters for the search.


4207 4215 

4208 - `string`4216 - `string`

4209 4217 

4210 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more`4218 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`

4211 4219 

4212 - `"gpt-5.6-sol"`4220 - `"gpt-5.6-sol"`

4213 4221 


4217 4225 

4218 - `"gpt-5.5"`4226 - `"gpt-5.5"`

4219 4227 

4228 - `"gpt-5.5-2026-04-23"`

4229 

4220 - `"gpt-5.4"`4230 - `"gpt-5.4"`

4221 4231 

4222 - `"gpt-5.4-mini"`4232 - `"gpt-5.4-mini"`


4373 4383 

4374 - `"gpt-3.5-turbo-16k-0613"`4384 - `"gpt-3.5-turbo-16k-0613"`

4375 4385 

4376 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more`4386 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`

4377 4387 

4378 - `"o1-pro"`4388 - `"o1-pro"`

4379 4389 


4395 4405 

4396 - `"computer-use-preview-2025-03-11"`4406 - `"computer-use-preview-2025-03-11"`

4397 4407 

4408 - `"gpt-5.5-pro"`

4409 

4410 - `"gpt-5.5-pro-2026-04-23"`

4411 

4398 - `"gpt-5-codex"`4412 - `"gpt-5-codex"`

4399 4413 

4400 - `"gpt-5-pro"`4414 - `"gpt-5-pro"`


5181 5195 

5182 - `"computer_use_preview"`5196 - `"computer_use_preview"`

5183 5197 

5184 - `WebSearch object { type, filters, search_context_size, user_location }`5198 - `WebSearch object { type, external_web_access, filters, 2 more }`

5185 5199 

5186 Search the Internet for sources related to the prompt. Learn more about the5200 Search the Internet for sources related to the prompt. Learn more about the

5187 [web search tool](/docs/guides/tools-web-search).5201 [web search tool](/docs/guides/tools-web-search).


5194 5208 

5195 - `"web_search_2025_08_26"`5209 - `"web_search_2025_08_26"`

5196 5210 

5211 - `external_web_access: optional boolean`

5212 

5213 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

5214 

5197 - `filters: optional object { allowed_domains } or null`5215 - `filters: optional object { allowed_domains } or null`

5198 5216 

5199 Filters for the search.5217 Filters for the search.


6030 6048 

6031 - `"computer_use_preview"`6049 - `"computer_use_preview"`

6032 6050 

6033 - `WebSearch object { type, filters, search_context_size, user_location }`6051 - `WebSearch object { type, external_web_access, filters, 2 more }`

6034 6052 

6035 Search the Internet for sources related to the prompt. Learn more about the6053 Search the Internet for sources related to the prompt. Learn more about the

6036 [web search tool](/docs/guides/tools-web-search).6054 [web search tool](/docs/guides/tools-web-search).


6043 6061 

6044 - `"web_search_2025_08_26"`6062 - `"web_search_2025_08_26"`

6045 6063 

6064 - `external_web_access: optional boolean`

6065 

6066 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

6067 

6046 - `filters: optional object { allowed_domains } or null`6068 - `filters: optional object { allowed_domains } or null`

6047 6069 

6048 Filters for the search.6070 Filters for the search.


7878 7900 

7879 - `"computer_use_preview"`7901 - `"computer_use_preview"`

7880 7902 

7881 - `WebSearch object { type, filters, search_context_size, user_location }`7903 - `WebSearch object { type, external_web_access, filters, 2 more }`

7882 7904 

7883 Search the Internet for sources related to the prompt. Learn more about the7905 Search the Internet for sources related to the prompt. Learn more about the

7884 [web search tool](/docs/guides/tools-web-search).7906 [web search tool](/docs/guides/tools-web-search).


7891 7913 

7892 - `"web_search_2025_08_26"`7914 - `"web_search_2025_08_26"`

7893 7915 

7916 - `external_web_access: optional boolean`

7917 

7918 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

7919 

7894 - `filters: optional object { allowed_domains } or null`7920 - `filters: optional object { allowed_domains } or null`

7895 7921 

7896 Filters for the search.7922 Filters for the search.


8880 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.8906 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.

8881 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).8907 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).

8882 8908 

8883 - `service_tier: optional "auto" or "default" or "flex" or 3 more or null`8909 - `service_tier: optional "auto" or "default" or "flex" or 4 more or null`

8884 8910 

8885 Specifies the processing type used for serving the request.8911 Specifies the processing type used for serving the request.

8886 8912 


8888 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.8914 - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.

8889 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.8915 - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.

8890 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.8916 - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.

8917 - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`.

8891 - When not set, the default behavior is 'auto'.8918 - When not set, the default behavior is 'auto'.

8892 8919 

8893 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.8920 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.


8904 8931 

8905 - `"fast"`8932 - `"fast"`

8906 8933 

8934 - `"ultrafast"`

8935 

8907 - `status: optional ResponseStatus`8936 - `status: optional ResponseStatus`

8908 8937 

8909 The status of the response generation. One of `completed`, `failed`,8938 The status of the response generation. One of `completed`, `failed`,

Details

1349 1349 

1350 - `"computer_use_preview"`1350 - `"computer_use_preview"`

1351 1351 

1352 - `WebSearch object { type, filters, search_context_size, user_location }`1352 - `WebSearch object { type, external_web_access, filters, 2 more }`

1353 1353 

1354 Search the Internet for sources related to the prompt. Learn more about the1354 Search the Internet for sources related to the prompt. Learn more about the

1355 [web search tool](/docs/guides/tools-web-search).1355 [web search tool](/docs/guides/tools-web-search).


1362 1362 

1363 - `"web_search_2025_08_26"`1363 - `"web_search_2025_08_26"`

1364 1364 

1365 - `external_web_access: optional boolean`

1366 

1367 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1368 

1365 - `filters: optional object { allowed_domains } or null`1369 - `filters: optional object { allowed_domains } or null`

1366 1370 

1367 Filters for the search.1371 Filters for the search.


2380 2384 

2381 - `"computer_use_preview"`2385 - `"computer_use_preview"`

2382 2386 

2383 - `WebSearch object { type, filters, search_context_size, user_location }`2387 - `WebSearch object { type, external_web_access, filters, 2 more }`

2384 2388 

2385 Search the Internet for sources related to the prompt. Learn more about the2389 Search the Internet for sources related to the prompt. Learn more about the

2386 [web search tool](/docs/guides/tools-web-search).2390 [web search tool](/docs/guides/tools-web-search).


2393 2397 

2394 - `"web_search_2025_08_26"`2398 - `"web_search_2025_08_26"`

2395 2399 

2400 - `external_web_access: optional boolean`

2401 

2402 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2403 

2396 - `filters: optional object { allowed_domains } or null`2404 - `filters: optional object { allowed_domains } or null`

2397 2405 

2398 Filters for the search.2406 Filters for the search.


5397 5405 

5398 - `"computer_use_preview"`5406 - `"computer_use_preview"`

5399 5407 

5400 - `WebSearch object { type, filters, search_context_size, user_location }`5408 - `WebSearch object { type, external_web_access, filters, 2 more }`

5401 5409 

5402 Search the Internet for sources related to the prompt. Learn more about the5410 Search the Internet for sources related to the prompt. Learn more about the

5403 [web search tool](/docs/guides/tools-web-search).5411 [web search tool](/docs/guides/tools-web-search).


5410 5418 

5411 - `"web_search_2025_08_26"`5419 - `"web_search_2025_08_26"`

5412 5420 

5421 - `external_web_access: optional boolean`

5422 

5423 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

5424 

5413 - `filters: optional object { allowed_domains } or null`5425 - `filters: optional object { allowed_domains } or null`

5414 5426 

5415 Filters for the search.5427 Filters for the search.


6428 6440 

6429 - `"computer_use_preview"`6441 - `"computer_use_preview"`

6430 6442 

6431 - `WebSearch object { type, filters, search_context_size, user_location }`6443 - `WebSearch object { type, external_web_access, filters, 2 more }`

6432 6444 

6433 Search the Internet for sources related to the prompt. Learn more about the6445 Search the Internet for sources related to the prompt. Learn more about the

6434 [web search tool](/docs/guides/tools-web-search).6446 [web search tool](/docs/guides/tools-web-search).


6441 6453 

6442 - `"web_search_2025_08_26"`6454 - `"web_search_2025_08_26"`

6443 6455 

6456 - `external_web_access: optional boolean`

6457 

6458 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

6459 

6444 - `filters: optional object { allowed_domains } or null`6460 - `filters: optional object { allowed_domains } or null`

6445 6461 

6446 Filters for the search.6462 Filters for the search.

Details

1347 1347 

1348 - `"computer_use_preview"`1348 - `"computer_use_preview"`

1349 1349 

1350 - `WebSearch object { type, filters, search_context_size, user_location }`1350 - `WebSearch object { type, external_web_access, filters, 2 more }`

1351 1351 

1352 Search the Internet for sources related to the prompt. Learn more about the1352 Search the Internet for sources related to the prompt. Learn more about the

1353 [web search tool](/docs/guides/tools-web-search).1353 [web search tool](/docs/guides/tools-web-search).


1360 1360 

1361 - `"web_search_2025_08_26"`1361 - `"web_search_2025_08_26"`

1362 1362 

1363 - `external_web_access: optional boolean`

1364 

1365 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1366 

1363 - `filters: optional object { allowed_domains } or null`1367 - `filters: optional object { allowed_domains } or null`

1364 1368 

1365 Filters for the search.1369 Filters for the search.


2378 2382 

2379 - `"computer_use_preview"`2383 - `"computer_use_preview"`

2380 2384 

2381 - `WebSearch object { type, filters, search_context_size, user_location }`2385 - `WebSearch object { type, external_web_access, filters, 2 more }`

2382 2386 

2383 Search the Internet for sources related to the prompt. Learn more about the2387 Search the Internet for sources related to the prompt. Learn more about the

2384 [web search tool](/docs/guides/tools-web-search).2388 [web search tool](/docs/guides/tools-web-search).


2391 2395 

2392 - `"web_search_2025_08_26"`2396 - `"web_search_2025_08_26"`

2393 2397 

2398 - `external_web_access: optional boolean`

2399 

2400 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2401 

2394 - `filters: optional object { allowed_domains } or null`2402 - `filters: optional object { allowed_domains } or null`

2395 2403 

2396 Filters for the search.2404 Filters for the search.

Details

1433 1433 

1434 - `"computer_use_preview"`1434 - `"computer_use_preview"`

1435 1435 

1436 - `WebSearch object { type, filters, search_context_size, user_location }`1436 - `WebSearch object { type, external_web_access, filters, 2 more }`

1437 1437 

1438 Search the Internet for sources related to the prompt. Learn more about the1438 Search the Internet for sources related to the prompt. Learn more about the

1439 [web search tool](/docs/guides/tools-web-search).1439 [web search tool](/docs/guides/tools-web-search).


1446 1446 

1447 - `"web_search_2025_08_26"`1447 - `"web_search_2025_08_26"`

1448 1448 

1449 - `external_web_access: optional boolean`

1450 

1451 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1452 

1449 - `filters: optional object { allowed_domains } or null`1453 - `filters: optional object { allowed_domains } or null`

1450 1454 

1451 Filters for the search.1455 Filters for the search.


2468 2472 

2469 - `"computer_use_preview"`2473 - `"computer_use_preview"`

2470 2474 

2471 - `WebSearch object { type, filters, search_context_size, user_location }`2475 - `WebSearch object { type, external_web_access, filters, 2 more }`

2472 2476 

2473 Search the Internet for sources related to the prompt. Learn more about the2477 Search the Internet for sources related to the prompt. Learn more about the

2474 [web search tool](/docs/guides/tools-web-search).2478 [web search tool](/docs/guides/tools-web-search).


2481 2485 

2482 - `"web_search_2025_08_26"`2486 - `"web_search_2025_08_26"`

2483 2487 

2488 - `external_web_access: optional boolean`

2489 

2490 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2491 

2484 - `filters: optional object { allowed_domains } or null`2492 - `filters: optional object { allowed_domains } or null`

2485 2493 

2486 Filters for the search.2494 Filters for the search.


4609 4617 

4610 - `"computer_use_preview"`4618 - `"computer_use_preview"`

4611 4619 

4612 - `WebSearch object { type, filters, search_context_size, user_location }`4620 - `WebSearch object { type, external_web_access, filters, 2 more }`

4613 4621 

4614 Search the Internet for sources related to the prompt. Learn more about the4622 Search the Internet for sources related to the prompt. Learn more about the

4615 [web search tool](/docs/guides/tools-web-search).4623 [web search tool](/docs/guides/tools-web-search).


4622 4630 

4623 - `"web_search_2025_08_26"`4631 - `"web_search_2025_08_26"`

4624 4632 

4633 - `external_web_access: optional boolean`

4634 

4635 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

4636 

4625 - `filters: optional object { allowed_domains } or null`4637 - `filters: optional object { allowed_domains } or null`

4626 4638 

4627 Filters for the search.4639 Filters for the search.

Details

1431 1431 

1432 - `"computer_use_preview"`1432 - `"computer_use_preview"`

1433 1433 

1434 - `WebSearch object { type, filters, search_context_size, user_location }`1434 - `WebSearch object { type, external_web_access, filters, 2 more }`

1435 1435 

1436 Search the Internet for sources related to the prompt. Learn more about the1436 Search the Internet for sources related to the prompt. Learn more about the

1437 [web search tool](/docs/guides/tools-web-search).1437 [web search tool](/docs/guides/tools-web-search).


1444 1444 

1445 - `"web_search_2025_08_26"`1445 - `"web_search_2025_08_26"`

1446 1446 

1447 - `external_web_access: optional boolean`

1448 

1449 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

1450 

1447 - `filters: optional object { allowed_domains } or null`1451 - `filters: optional object { allowed_domains } or null`

1448 1452 

1449 Filters for the search.1453 Filters for the search.


2466 2470 

2467 - `"computer_use_preview"`2471 - `"computer_use_preview"`

2468 2472 

2469 - `WebSearch object { type, filters, search_context_size, user_location }`2473 - `WebSearch object { type, external_web_access, filters, 2 more }`

2470 2474 

2471 Search the Internet for sources related to the prompt. Learn more about the2475 Search the Internet for sources related to the prompt. Learn more about the

2472 [web search tool](/docs/guides/tools-web-search).2476 [web search tool](/docs/guides/tools-web-search).


2479 2483 

2480 - `"web_search_2025_08_26"`2484 - `"web_search_2025_08_26"`

2481 2485 

2486 - `external_web_access: optional boolean`

2487 

2488 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

2489 

2482 - `filters: optional object { allowed_domains } or null`2490 - `filters: optional object { allowed_domains } or null`

2483 2491 

2484 Filters for the search.2492 Filters for the search.


4607 4615 

4608 - `"computer_use_preview"`4616 - `"computer_use_preview"`

4609 4617 

4610 - `WebSearch object { type, filters, search_context_size, user_location }`4618 - `WebSearch object { type, external_web_access, filters, 2 more }`

4611 4619 

4612 Search the Internet for sources related to the prompt. Learn more about the4620 Search the Internet for sources related to the prompt. Learn more about the

4613 [web search tool](/docs/guides/tools-web-search).4621 [web search tool](/docs/guides/tools-web-search).


4620 4628 

4621 - `"web_search_2025_08_26"`4629 - `"web_search_2025_08_26"`

4622 4630 

4631 - `external_web_access: optional boolean`

4632 

4633 Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

4634 

4623 - `filters: optional object { allowed_domains } or null`4635 - `filters: optional object { allowed_domains } or null`

4624 4636 

4625 Filters for the search.4637 Filters for the search.

ruby/index.md +10 −24

Details

423require 'sinatra'423require 'sinatra'

424require 'openai'424require 'openai'

425 425 

426# Set up the client with webhook secret from environment variable426# Set up the client with API credentials and the webhook secret

427client = OpenAI::Client.new(webhook_secret: ENV['OPENAI_WEBHOOK_SECRET'])427client = OpenAI::Client.new(

428 api_key: ENV.fetch('OPENAI_API_KEY'),

429 webhook_secret: ENV.fetch('OPENAI_WEBHOOK_SECRET')

430)

428 431 

429post '/webhook' do432post '/webhook' do

430 request_body = request.body.read433 request_body = request.body.read


462require 'json'465require 'json'

463require 'openai'466require 'openai'

464 467 

465# Set up the client with webhook secret from environment variable468# Set up the client with API credentials and the webhook secret

466client = OpenAI::Client.new(webhook_secret: ENV['OPENAI_WEBHOOK_SECRET'])469client = OpenAI::Client.new(

470 api_key: ENV.fetch('OPENAI_API_KEY'),

471 webhook_secret: ENV.fetch('OPENAI_WEBHOOK_SECRET')

472)

467 473 

468post '/webhook' do474post '/webhook' do

469 request_body = request.body.read475 request_body = request.body.read


928openai.chat.completions.create(**params)934openai.chat.completions.create(**params)

929```935```

930 936 

931### Structured output models

932 

933The SDK includes a Tapioca DSL compiler for application-defined subclasses of

934`OpenAI::BaseModel`. When Tapioca loads your application, running

935`bundle exec tapioca dsl` generates typed readers for fields declared with

936`required`, including nested models, arrays, enums, unions, and fields declared

937with `nil?: true`.

938 

939Response `parsed` fields can contain different application-defined models, so

940their generated SDK type remains broad. Cast a parsed value to the structured

941output model supplied with the request before accessing its generated readers:

942 

943```ruby

944event = T.cast(content.parsed, CalendarEvent)

945puts(event.name)

946```

947 

948The compiler is only loaded by Tapioca; using the SDK normally still does not

949require `sorbet-runtime`.

950 

951### Enums937### Enums

952 938 

953Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:939Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime: