Documentation — Spybara

guides/tools-web-search.md +43 −0

Details

11import {11import {

12 customUserLocationExampleCoarse,12 customUserLocationExampleCoarse,

13 customUserLocationExampleCoarseChat,13 customUserLocationExampleCoarseChat,

14 imageSearchResultsExample,

14 listSourcesExample,15 listSourcesExample,

15 returnTokenBudgetExample,16 returnTokenBudgetExample,

16 searchContextSize,17 searchContextSize,

135To view all URLs retrieved during a web search, use the `sources` field. Unlike inline citations, which show only the most relevant references, sources returns the complete list of URLs the model consulted when forming its response.136To view all URLs retrieved during a web search, use the `sources` field. Unlike inline citations, which show only the most relevant references, sources returns the complete list of URLs the model consulted when forming its response.

136The number of sources is often greater than the number of citations. Real-time third-party feeds are also surfaced here and are labeled as `oai-sports`, `oai-weather`, or `oai-finance`. The sources field is available with both the `web_search` and `web_search_preview` tools.137The number of sources is often greater than the number of citations. Real-time third-party feeds are also surfaced here and are labeled as `oai-sports`, `oai-weather`, or `oai-finance`. The sources field is available with both the `web_search` and `web_search_preview` tools.

137 138

139## Image search results

140

141Web search can return image results alongside regular text results. Use image search when your application needs current or web-grounded visuals, such as product photos, landmarks, places, events, or visual references.

142

143To use image search, set `search_content_types` to include `image`. Add `text` when you also want supporting text results that help the model summarize, rank, or explain the retrieved images.

144

145Use `image_settings` to control image-specific behavior:

146

147- `max_results`: Request a positive number of image results.

148- `caption`: Ask for short image descriptions when available.

149

150To inspect raw image results, include `web_search_call.results` in the request and read `web_search_call.results[]` from the response. Image results are returned separately from the assistant message, so parse the `web_search_call` item directly when your application needs the URLs or metadata.

151

152Each `image_result` includes:

153

154- `image_url`: The canonical image URL for the result.

155- `source_website_url`: The page where the image was found.

156- `thumbnail_url`: A thumbnail URL when available.

157- `caption`: A short caption or description when available.

158

159```json

160{

161 "output": [

162 {

163 "type": "web_search_call",

164 "status": "completed",

165 "results": [

166 {

167 "type": "image_result",

168 "image_url": "https://cdn.example/golden-gate-sunset.jpg",

169 "thumbnail_url": "https://cdn.example/golden-gate-sunset-thumb.jpg",

170 "source_website_url": "https://example.com/source-page",

171 "caption": "Golden Gate Bridge at sunset"

172 }

173 ]

174 }

175 ]

176}

177```

178

179

180

138## User location181## User location

139 182

140To refine search results based on geography, you can specify an approximate user location using country, city, region, and/or timezone.183To refine search results based on geography, you can specify an approximate user location using country, city, region, and/or timezone.

guides/your-data.md +54 −43

Details

1# Data controls in the OpenAI platform1# Data controls in the OpenAI platform

2 2

3import {

4 dataResidencyRegions,

5 dataResidencyServices,

6} from "./your-data-support";

3Understand how OpenAI uses your data, and how you can control it.8Understand how OpenAI uses your data, and how you can control it.

4 9

5Your data is your data. As of March 1, 2023, data sent to the OpenAI API is not used to train or improve OpenAI models (unless you explicitly opt in to share data with us).10Your data is your data. As of March 1, 2023, data sent to the OpenAI API is not used to train or improve OpenAI models (unless you explicitly opt in to share data with us).

161 166

162The following models and API services are eligible for data residency today for the regions specified below.167The following models and API services are eligible for data residency today for the regions specified below.

163 168

164**Table 1: Regional data residency capabilities**169Use **Support by region** to compare regional capabilities and expand the services available in each region. Use **API Endpoint, tool and model support** for complete model lists and a detailed service view. Support for regional storage does not imply support for regional processing.

~~165~~ 170

167| --------------------------- | ---------------- | ------------------- | ----------------------------------------- | --------------------------- | ----------------- |172

168| US | ✅ | ✅ | ❌ | Text, Audio, Voice, Image | us.api.openai.com |173The complete, unfiltered regional support table follows. Model snapshots for each service are listed in **API Endpoint, tool and model support**. When regional processing supports only a subset of snapshots, that subset is included in the processing-services cell.

169| Europe (EEA \+ Switzerland) | ✅ | ✅ | ✅ | Text, Audio, Voice, Image\* | eu.api.openai.com |174

171| Canada | ✅ | ❌ | ✅ | Text, Audio, Voice, Image\* | ca.api.openai.com |176| ---------------------------- | ------------------- | :--------------: | :-----------------: | :-----------------: | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

172| Japan | ✅ | ❌ | ✅ | Text, Audio, Voice, Image\* | jp.api.openai.com |177| United States | `us.api.openai.com` | Yes | Yes | No | Text, Audio, Voice, Image | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` `/v1/batches` `/v1/chat/completions` `/v1/embeddings` `/v1/evals` `/v1/files` `/v1/fine_tuning/jobs` `/v1/images/edits` `/v1/images/generations` `/v1/moderations` `/v1/realtime` `/v1/realtime/transcription_sessions` `/v1/realtime/translations` `/v1/realtime (legacy previews)` `/v1/responses` `/v1/responses File Search` `/v1/responses Web Search` `/v1/vector_stores` `Code Interpreter tool` `File Search` `File Uploads` `Remote MCP server tool` `Scale Tier` `Structured Outputs (excluding schema)` `Supported input modalities` | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` `/v1/batches` `/v1/chat/completions` `/v1/embeddings` `/v1/evals` `/v1/fine_tuning/jobs` `/v1/images/edits` `/v1/images/generations` `/v1/moderations` `/v1/realtime` `/v1/realtime/transcription_sessions` `/v1/realtime/translations` `/v1/realtime (legacy previews)` `/v1/responses` `/v1/responses File Search` `/v1/responses Web Search` `Code Interpreter tool` `File Search` `Remote MCP server tool` `Scale Tier` `Structured Outputs (excluding schema)` `Supported input modalities` |

173| India | ✅ | ❌ | ✅ | Text, Audio, Voice, Image\* | in.api.openai.com |178| Europe (EEA + Switzerland)\* | `eu.api.openai.com` | Yes | Yes | Yes | Text, Audio, Voice, Image | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` `/v1/batches` `/v1/chat/completions` `/v1/embeddings` `/v1/evals` `/v1/files` `/v1/fine_tuning/jobs` `/v1/images/edits` `/v1/images/generations` `/v1/moderations` `/v1/realtime` `/v1/realtime/transcription_sessions` `/v1/realtime/translations` `/v1/responses` `/v1/responses File Search` `/v1/responses Web Search` `/v1/vector_stores` `Code Interpreter tool` `File Search` `File Uploads` `Remote MCP server tool` `Scale Tier` `Structured Outputs (excluding schema)` `Supported input modalities` | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` `/v1/batches` `/v1/chat/completions` `/v1/embeddings` `/v1/evals` `/v1/fine_tuning/jobs` `/v1/images/edits` `/v1/images/generations` `/v1/moderations` `/v1/realtime` `/v1/realtime/transcription_sessions` `/v1/realtime/translations` `/v1/responses` `/v1/responses File Search` `/v1/responses Web Search` `Code Interpreter tool` `File Search` `Remote MCP server tool` `Scale Tier` `Structured Outputs (excluding schema)` `Supported input modalities` |

174| Singapore | ✅ | ❌ | ✅ | Text, Audio, Voice, Image\* | sg.api.openai.com |179| Australia\* | `au.api.openai.com` | Yes | No | Yes | Text, Audio, Voice, Image | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` `/v1/batches` `/v1/chat/completions` `/v1/embeddings` `/v1/files` `/v1/fine_tuning/jobs` `/v1/images/edits` `/v1/images/generations` `/v1/moderations` `/v1/responses` `/v1/responses File Search` `/v1/responses Web Search` `/v1/vector_stores` `Code Interpreter tool` `File Search` `File Uploads` `Remote MCP server tool` `Scale Tier` `Structured Outputs (excluding schema)` `Supported input modalities` | None |

175| South Korea | ✅ | ❌ | ✅ | Text, Audio, Voice, Image\* | kr.api.openai.com |180| Canada\* | `ca.api.openai.com` | Yes | No | Yes | Text, Audio, Voice, Image | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` `/v1/batches` `/v1/chat/completions` `/v1/embeddings` `/v1/files` `/v1/fine_tuning/jobs` `/v1/images/edits` `/v1/images/generations` `/v1/moderations` `/v1/responses` `/v1/responses File Search` `/v1/responses Web Search` `/v1/vector_stores` `Code Interpreter tool` `File Search` `File Uploads` `Remote MCP server tool` `Scale Tier` `Structured Outputs (excluding schema)` `Supported input modalities` | None |

176| United Kingdom | ✅ | ❌ | ✅ | Text, Audio, Voice, Image\* | gb.api.openai.com |181| Japan\* | `jp.api.openai.com` | Yes | No | Yes | Text, Audio, Voice, Image | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` `/v1/batches` `/v1/chat/completions` `/v1/embeddings` `/v1/files` `/v1/fine_tuning/jobs` `/v1/images/edits` `/v1/images/generations` `/v1/moderations` `/v1/responses` `/v1/responses File Search` `/v1/responses Web Search` `/v1/vector_stores` `Code Interpreter tool` `File Search` `File Uploads` `Remote MCP server tool` `Scale Tier` `Structured Outputs (excluding schema)` `Supported input modalities` | None |

177| United Arab Emirates | ✅ | ❌ | ✅ | Text, Audio, Voice, Image\* | ae.api.openai.com |182| India\* | `in.api.openai.com` | Yes | No | Yes | Text, Audio, Voice, Image | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` `/v1/batches` `/v1/chat/completions` `/v1/embeddings` `/v1/files` `/v1/fine_tuning/jobs` `/v1/images/edits` `/v1/images/generations` `/v1/moderations` `/v1/responses` `/v1/responses File Search` `/v1/responses Web Search` `/v1/vector_stores` `Code Interpreter tool` `File Search` `File Uploads` `Remote MCP server tool` `Scale Tier` `Structured Outputs (excluding schema)` `Supported input modalities` | None |

183| Singapore\* | `sg.api.openai.com` | Yes | No | Yes | Text, Audio, Voice, Image | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` `/v1/batches` `/v1/chat/completions` `/v1/embeddings` `/v1/files` `/v1/fine_tuning/jobs` `/v1/images/edits` `/v1/images/generations` `/v1/moderations` `/v1/responses` `/v1/responses File Search` `/v1/responses Web Search` `/v1/vector_stores` `Code Interpreter tool` `File Search` `File Uploads` `Remote MCP server tool` `Scale Tier` `Structured Outputs (excluding schema)` `Supported input modalities` | None |

184| South Korea\* | `kr.api.openai.com` | Yes | No | Yes | Text, Audio, Voice, Image | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` `/v1/batches` `/v1/chat/completions` `/v1/embeddings` `/v1/files` `/v1/fine_tuning/jobs` `/v1/images/edits` `/v1/images/generations` `/v1/moderations` `/v1/responses` `/v1/responses File Search` `/v1/responses Web Search` `/v1/vector_stores` `Code Interpreter tool` `File Search` `File Uploads` `Remote MCP server tool` `Scale Tier` `Structured Outputs (excluding schema)` `Supported input modalities` | None |

185| United Kingdom\* | `gb.api.openai.com` | Yes | No | Yes | Text, Audio, Voice, Image | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` `/v1/batches` `/v1/chat/completions` `/v1/embeddings` `/v1/files` `/v1/fine_tuning/jobs` `/v1/images/edits` `/v1/images/generations` `/v1/moderations` `/v1/responses` `/v1/responses File Search` `/v1/responses Web Search` `/v1/vector_stores` `Code Interpreter tool` `File Search` `File Uploads` `Remote MCP server tool` `Scale Tier` `Structured Outputs (excluding schema)` `Supported input modalities` | None |

186| United Arab Emirates\* | `ae.api.openai.com` | Yes | Yes | Yes | Text, Audio, Voice, Image | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` `/v1/batches` `/v1/chat/completions` `/v1/embeddings` `/v1/files` `/v1/fine_tuning/jobs` `/v1/images/edits` `/v1/images/generations` `/v1/moderations` `/v1/responses` `/v1/responses File Search` `/v1/responses Web Search` `/v1/vector_stores` `Code Interpreter tool` `File Search` `File Uploads` `Remote MCP server tool` `Scale Tier` `Structured Outputs (excluding schema)` `Supported input modalities` | `/v1/chat/completions` (`gpt-5.2-2025-12-11`, `gpt-4.1-2025-04-14`) `/v1/embeddings` (`text-embedding-3-small`, `text-embedding-3-large`) `/v1/responses` (`gpt-5.2-2025-12-11`, `gpt-4.1-2025-04-14`) |

178 187

179\* Image support in these regions requires approval for enhanced Zero Data Retention or enhanced Modified Abuse Monitoring.188\* Image support in these regions requires approval for enhanced Zero Data Retention or enhanced Modified Abuse Monitoring.

180 189

181**Table 2: API endpoint and tool support**190#### API Endpoint, tool and model support

~~182~~ 191

184| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |193| -------------------------------------------------------------------- | ---------------- | ----------------------------------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- |

186| /v1/batches | gpt-5.5-pro-2026-04-23 gpt-5.4-pro-2026-03-05 gpt-5.2-pro-2025-12-11 gpt-5-pro-2025-10-06 gpt-5.5-2026-04-23 gpt-5.4-2026-03-05 gpt-5-2025-08-07 gpt-5.4-mini-2026-03-17 gpt-5.4-nano-2026-03-17 gpt-5.2-2025-12-11 gpt-5.1-2025-11-13 gpt-5-mini-2025-08-07 gpt-5-nano-2025-08-07 gpt-4.1-2025-04-14 gpt-4.1-mini-2025-04-14 gpt-4.1-nano-2025-04-14 o3-2025-04-16 o4-mini-2025-04-16 o1-pro o1-pro-2025-03-19 o3-mini-2025-01-31 o1-2024-12-17 o1-mini-2024-09-12 o1-preview gpt-4o-2024-11-20 gpt-4o-2024-08-06 gpt-4o-mini-2024-07-18 gpt-4-turbo-2024-04-09 gpt-4-0613 gpt-3.5-turbo-0125 | All |195| `/v1/batches` | Batches | All listed regions | United States, Europe (EEA + Switzerland) | `gpt-5.5-pro-2026-04-23`, `gpt-5.4-pro-2026-03-05`, `gpt-5.2-pro-2025-12-11`, `gpt-5-pro-2025-10-06`, `gpt-5.5-2026-04-23`, `gpt-5.4-2026-03-05`, `gpt-5-2025-08-07`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.2-2025-12-11`, `gpt-5.1-2025-11-13`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `o3-2025-04-16`, `o4-mini-2025-04-16`, `o1-pro`, `o1-pro-2025-03-19`, `o3-mini-2025-01-31`, `o1-2024-12-17`, `o1-mini-2024-09-12`, `o1-preview`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `gpt-4-turbo-2024-04-09`, `gpt-4-0613`, `gpt-3.5-turbo-0125` | None | — |

187| /v1/chat/completions | gpt-5.5-2026-04-23 gpt-5.4-2026-03-05 gpt-5.4-mini-2026-03-17 gpt-5.4-nano-2026-03-17 gpt-5.2-2025-12-11 gpt-5.1-2025-11-13 gpt-5-2025-08-07 gpt-5-mini-2025-08-07 gpt-5-nano-2025-08-07 gpt-5-chat-latest-2025-08-07 gpt-4.1-2025-04-14 gpt-4.1-mini-2025-04-14 gpt-4.1-nano-2025-04-14 o3-mini-2025-01-31 o3-2025-04-16 o4-mini-2025-04-16 o1-2024-12-17 o1-mini-2024-09-12 o1-preview gpt-4o-2024-11-20 gpt-4o-2024-08-06 gpt-4o-mini-2024-07-18 gpt-4-turbo-2024-04-09 gpt-4-0613 gpt-3.5-turbo-0125 | All |196| `/v1/chat/completions` | Chat Completions | All listed regions | United States, Europe (EEA + Switzerland), United Arab Emirates | `gpt-5.5-2026-04-23`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.2-2025-12-11`, `gpt-5.1-2025-11-13`, `gpt-5-2025-08-07`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-5-chat-latest-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `o3-mini-2025-01-31`, `o3-2025-04-16`, `o4-mini-2025-04-16`, `o1-2024-12-17`, `o1-mini-2024-09-12`, `o1-preview`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `gpt-4-turbo-2024-04-09`, `gpt-4-0613`, `gpt-3.5-turbo-0125` | United Arab Emirates: `gpt-5.2-2025-12-11`, `gpt-4.1-2025-04-14` | — |

199| /v1/responses | gpt-5.5-pro-2026-04-23 gpt-5.4-pro-2026-03-05 gpt-5.2-pro-2025-12-11 gpt-5-pro-2025-10-06 gpt-5.5-2026-04-23 gpt-5.4-2026-03-05 gpt-5-2025-08-07 gpt-5.4-mini-2026-03-17 gpt-5.4-nano-2026-03-17 gpt-5.2-2025-12-11 gpt-5.1-2025-11-13 gpt-5-mini-2025-08-07 gpt-5-nano-2025-08-07 gpt-5-chat-latest-2025-08-07 gpt-4.1-2025-04-14 gpt-4.1-mini-2025-04-14 gpt-4.1-nano-2025-04-14 o3-2025-04-16 o4-mini-2025-04-16 o1-pro o1-pro-2025-03-19 computer-use-preview\* o3-mini-2025-01-31 o1-2024-12-17 o1-mini-2024-09-12 o1-preview gpt-4o-2024-11-20 gpt-4o-2024-08-06 gpt-4o-mini-2024-07-18 gpt-4-turbo-2024-04-09 gpt-4-0613 gpt-3.5-turbo-0125 | All |208| `/v1/responses` | Responses | All listed regions | United States, Europe (EEA + Switzerland), United Arab Emirates | `gpt-5.5-pro-2026-04-23`, `gpt-5.4-pro-2026-03-05`, `gpt-5.2-pro-2025-12-11`, `gpt-5-pro-2025-10-06`, `gpt-5.5-2026-04-23`, `gpt-5.4-2026-03-05`, `gpt-5-2025-08-07`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.2-2025-12-11`, `gpt-5.1-2025-11-13`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-5-chat-latest-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `o3-2025-04-16`, `o4-mini-2025-04-16`, `o1-pro`, `o1-pro-2025-03-19`, `computer-use-preview`, `o3-mini-2025-01-31`, `o1-2024-12-17`, `o1-mini-2024-09-12`, `o1-preview`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `gpt-4-turbo-2024-04-09`, `gpt-4-0613`, `gpt-3.5-turbo-0125` | United Arab Emirates: `gpt-5.2-2025-12-11`, `gpt-4.1-2025-04-14` | computer-use-preview is supported only in the US and Europe. |

219

220

210 221

211### Endpoint limitations222### Endpoint limitations

212 223

Documentation 2026-06-09 06:34 UTC to 2026-06-10 15:48 UTC