OpenAI Responses API built-in web search

[growler]

Now that codecompanion supports the OpenAI Responses API, it could also take advantage of the built-in web search tool.

I’m not sure what the best way to expose this in the configuration would be (never had to dig into confiuration, since codecompanion “just works” with almost no setup, which is one of the things I love about it), but in principle it should be fairly simple to translate the @search_web into a request such as:

curl "https://api.openai.com/v1/responses" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
        "model": "gpt-5",
        "tools": [{"type": "web_search"}],
        "input": "what was a positive news story from today?"
    }'

Apologies if this feature is already available and I just missed it!

[olimorris]

I haven't added support for built-in tools yet across any adapter. It's on my todo list but for now I'd recommend extending your chosen adapter and updating the handlers.form_parameters function to include the tool.

[growler]

Thanks for the hint, works for me just fine. There’s a gpt-5-search-api model for the Chat API that I’ve used before, but I noticed that the built-in search tool in the Responses API tends to give better results, so this is a win.

I dug a bit into the sources and realized how much effort it would take to design a decent API for the built-in tools. The only idea that came to mind was to let the adapter expose a table of built-in named tools and use it instead of supplied extensions when the names match, but even that feels a bit ugly.

Thanks again for your work.

[olimorris]

#2307 has now added this. See the docs for more information.

[petobens]

@olimorris Is there a way to use taviliy rather than the builtin web_search tool? I set

['reasoning.effort'] = { default = 'minimal' },

in my openai_response adapter config and get

[ERROR] 2025-11-01 09:32:43
Error: {
  "error": {
    "message": "The following tools cannot be used with reasoning.effort 'minimal': web_search.",
    "type": "invalid_request_error",
    "param": "tools",
    "code": null
  }
}
[ERROR] 2025-11-01 09:32:43
[chat::_submit_http] Error: {
  body = "{\n  \"error\": {\n    \"message\": \"The following tools cannot be used with reasoning.effort 'minimal': web_search.\",\n    \"type\": \"invalid_request_error\",\n    \"param\": \"tools\",\n    \"code\": null\n  }\n}",
  exit = 0,
  headers = { "date: Sat, 01 Nov 2025 12:32:43 GMT", "content-type: application/json", "content-length: 194", "openai-version: 2020-10-01", "openai-organization: user-uhn60voa5bxpdxm3yf44mwqe", "openai-project: proj_44rEkkjY8FDI4k8cXh86CW4n", "x-request-id: req_c1cbb6a3ea494559934d5e81dd0f7a7f", "openai-processing-ms: 40", "x-envoy-upstream-service-time: 45", "cf-cache-status: DYNAMIC", "set-cookie: __cf_bm=FsUgXxpX6bisL3V9HuucSb40O2mDhAqPADzntoh.5J0-1762000363-1.0.1.1-eJTS.5hR0nWUqBK7KXV3asHXxB0YABeWJdBjzg.ZLUztZyZPfWTg1F4JZ745xgA4_x.yTRSzczEUq88wKIn2xQUkTNI4fT1F2ekbQ4iJlpE; path=/; expires=Sat, 01-Nov-25 13:02:43 GMT; domain=.api.openai.com; HttpOnly; Secure; SameSite=None", "strict-transport-security: max-age=31536000; includeSubDomains; preload", "x-content-type-options: nosniff", "set-cookie: _cfuvid=oyr4zVURfBqhThEIUb3iM578Q7sU2n0qEE_QbIwdN14-1762000363751-0.0.1.1-604800000; path=/; domain=.api.openai.com; HttpOnly; Secure; SameSite=None", "server: cloudflare", "cf-ray: 997b6a961861dea7-EZE", 'alt-svc: h3=":443"; ma=86400' },
  status = 400
}

[olimorris]

You can disable the tool by setting enabled = false on the adapter's available_tools