1. 插件调用
OpenAI-Hub接口文档
  • AI模型接口
    • 序言
    • 聊天(Chat)
      • 原生OpenAI格式
        • 创建聊天对话
        • 创建响应 (OpenAI Responses API)
        • 压缩对话 (OpenAI Responses API)
      • 原生Claude格式
        • Claude 聊天
      • 原生Gemini格式
        • Gemini 聊天 (generateContent)
    • 图像(Images)
      • 原生OpenAI格式
        • 创建图像
        • 编辑图像
      • 原生Gemini格式
        • Gemini 图片(Nano Banana)
      • 通义千问OpenAI格式
        • 编辑图像(qwen-image-edit)
        • 生成图像(qwen-image)
    • 视频(Videos)
      • Sora格式
        • 报错示例
          • Inpaint image must match the requested width and height
        • 创建视频
        • 获取视频任务状态
        • 获取视频内容
      • 可灵格式
        • Kling 图生视频
        • 获取 Kling 图生视频任务状态
        • Kling 文生视频
        • 获取 Kling 文生视频任务状态
      • 即梦格式
        • 即梦视频生成
      • veo格式
        • 创建视频
        • 获取视频任务状态
        • 获取视频内容
      • 创建视频生成任务
      • 获取视频生成任务状态
    • 音频(Audio)
      • 原生OpenAI格式
        • 文本转语音
        • 音频转录
        • 音频翻译
    • 补全(Completions)
      • 原生OpenAI格式
        • 创建文本补全
    • 实时语音(Realtime)
      • 原生OpenAI格式
        • 实时 WebSocket 连接
    • 重排序(Rerank)
      • 文档重排序
        • 文档重排序
    • 审查(Moderations)
      • 原生OpenAI格式
        • 内容审核
    • 嵌入(Embeddings)
      • 原生OpenAI格式
        • 创建文本嵌入
      • 原生Gemini格式
        • Gemini 嵌入(Embeddings)
    • 模型(Models)
      • 列出模型
        • 获取模型列表
        • Gemini 格式获取
    • 插件调用
      • 百度搜索插件 (web_search_baidu)
        POST
      • OpenAI 内置联网搜索 (web_search_preview)
        POST
      • Claude 内置联网搜索 (web_search_20250305)
        POST
      • Gemini 内置联网搜索 (google_search)
        POST
    • 未实现(Unimplemented)
      • 微调(Fine-tuning)
        • 列出微调任务 (未实现)
        • 创建微调任务 (未实现)
        • 获取微调任务详情 (未实现)
        • 取消微调任务 (未实现)
        • 获取微调任务事件 (未实现)
      • 文件(Files)
        • 列出文件 (未实现)
        • 上传文件 (未实现)
        • 获取文件信息 (未实现)
        • 删除文件 (未实现)
        • 获取文件内容 (未实现)
  • 后台管理接口
    • 对接说明
    • APIkey
      • 获取 API Key 列表
      • 搜索 API Key
      • 获取 API Key 详情
      • 获取 API Key 明文
      • 新建 API Key
      • 修改 API Key
      • 删除 API Key
      • 批量删除 API Key
      • 批量获取 API Key 明文
    • 消费日志
      • 获取消费日志
      • 获取消费统计
  • 数据模型
    • Schemas
      • Blend提交参数
      • Describe提交参数
      • Discord账号
      • Imagine提交参数
      • 任务
      • 任务查询参数
      • 变化任务提交参数
      • 变化任务提交参数-simple
      • 提交结果
    • ErrorResponse
    • CreateImageRequest
    • CreateImageEditMultipartRequest
    • CreateImageEditWithImageReferencesRequest
    • Usage
    • ImagesResponse
    • CreateImageEditJsonRequest
    • CreateImageEditWithUploadedFilesRequest
    • Model
    • Image
    • ImageUrlInput
    • CreateImageEditCommonRequest
    • ModelsResponse
    • ImageUsage
    • FileIdInput
    • ImageInput
    • GeminiModelsResponse
    • ImageTokenDetails
    • ImageBackground
    • Message
    • ImageEditModel
    • MessageContent
    • ImageCount
    • ToolCall
    • ImageOutputCompression
    • Tool
    • ImageOutputFormat
    • ResponseFormat
    • ImagePartialImages
    • ChatCompletionRequest
    • ImageQuality
    • ChatCompletionResponse
    • ImageResponseFormat
    • ChatCompletionStreamResponse
    • ImageEditSize
    • CompletionRequest
    • ImageStream
    • CompletionResponse
    • ImageUser
    • ResponsesRequest
    • ResponsesResponse
    • ResponsesCompactionResponse
    • ResponsesCompactionRequest
    • ResponsesStreamResponse
    • ClaudeRequest
    • ClaudeMessage
    • ClaudeResponse
    • EmbeddingRequest
    • EmbeddingResponse
    • ImageGenerationRequest
    • ImageEditRequest
    • ImageResponse
    • AudioTranscriptionRequest
    • AudioTranslationRequest
    • AudioTranscriptionResponse
    • SpeechRequest
    • RerankRequest
    • RerankResponse
    • ModerationRequest
    • ModerationResponse
    • GeminiRequest
    • GeminiResponse
    • VideoRequest
    • VideoResponse
    • VideoTaskResponse
    • VideoTaskMetadata
    • VideoTaskError
    • OpenAIVideo
    • OpenAIVideoError
    • ApiResponse
    • PageInfo
    • User
    • Channel
    • Token
    • Redemption
    • Log
  1. 插件调用

OpenAI 内置联网搜索 (web_search_preview)

POST
/v1/responses

概述#

OpenAI 在 Responses API 中提供原生内置联网工具 web_search_preview。OpenAI-Hub 完全透传,无需任何额外配置,只要在 tools[] 里加一项即可。
支持模型:gpt-4o、gpt-4o-mini、gpt-5、gpt-5-mini 等开启 search 的型号。Responses API 是 OpenAI 官方推荐路径;Chat Completions 也支持等价的 web_search 工具。

请求示例#

1. 最小用法(非流式)#

2. 流式 + 控制搜索深度 + 地理位置#

3. Chat Completions 兼容写法#

如果你的客户端只支持 /v1/chat/completions:
{
  "model": "gpt-4o",
  "messages": [{ "role": "user", "content": "…" }],
  "tools": [{ "type": "web_search" }]
}
行为等价,引用以 tool_calls / tool_results 角色返回。

字段说明#

字段类型默认说明
typestring—固定 web_search_preview
search_context_sizeenummediumlow / medium / high,越大越贵越准
user_locationobject—地理位置提示,决定本地化语料
user_location.typestring—固定 approximate
user_location.countrystring—ISO 3166-1 alpha-2 国家代码(CN / US / JP)
user_location.citystring—城市英文名
user_location.regionstring—省/州英文名

响应(非流式)#

{
  "id": "resp_xxx",
  "object": "response",
  "model": "gpt-4o",
  "output": [
    {
      "type": "web_search_call",
      "id": "ws_xxx",
      "status": "completed"
    },
    {
      "type": "message",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "根据彭博社 2025 年 11 月发布的财报,苹果公司 Q4 营收达 949 亿美元...",
          "annotations": [
            {
              "type": "url_citation",
              "url": "https://www.bloomberg.com/...",
              "title": "Apple Q4 Earnings",
              "start_index": 0,
              "end_index": 25
            }
          ]
        }
      ]
    }
  ],
  "usage": { "input_tokens": 80, "output_tokens": 320, "total_tokens": 400 }
}

流式输出(关键事件序列)#

event: response.created
event: response.output_item.added         # type=web_search_call status=in_progress
event: response.web_search_call.searching
event: response.web_search_call.completed
event: response.output_item.done          # web_search_call 完成
event: response.output_item.added         # type=message
event: response.content_part.added
event: response.output_text.delta         # 模型回答文字流式 delta
event: response.output_text.annotation.added  # 引用注解(url_citation)
event: response.output_text.done
event: response.content_part.done
event: response.output_item.done
event: response.completed
前端可监听 response.web_search_call.searching 显示「正在搜索」spinner,response.output_text.annotation.added 实时挂引用气泡。

同时使用自定义函数#

web_search_preview 与 function 工具可以并行:
{
  "model": "gpt-4o",
  "input": "...",
  "tools": [
    { "type": "web_search_preview" },
    {
      "type": "function",
      "function": {
        "name": "get_weather",
        "description": "获取实时天气",
        "parameters": { "type": "object", "properties": { "city": { "type": "string" } } }
      }
    }
  ]
}
模型自主决定调哪个或两个都调。

请求参数

Header 参数

返回响应

🟢200成功
application/json
Bodyapplication/json

请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.openai-hub.com/v1/responses' \
--header 'Authorization: Bearer sk-0ABIEXVjh9****Qckjy'
响应示例响应示例
{}
上一页
百度搜索插件 (web_search_baidu)
下一页
Claude 内置联网搜索 (web_search_20250305)
Built with