agents.exceptions.UserError: Hosted tools are not supported with the ChatCompletions API. FGot tool type: <class 'agents.tool.WebSearchTool'>, tool: WebSearchTool(user_location={'type': 'approximate', 'city': '西安'}, search_context_size='medium')

[ai-srcflow]

Question

inner tools used error :

agents.exceptions.UserError: Hosted tools are not supported with the ChatCompletions API. FGot tool type: <class 'agents.tool.WebSearchTool'>, tool: WebSearchTool(user_location={'type': 'approximate', 'city': '西安'}, search_context_size='medium')

it seems ChatCompletions API compared Response API is incompatible,how to resolve this matter？ thx

[DanieleMorotti]

Hi, to use web search with the ChatCompletions API, you should adopt the specific model.
Both using the openai-agents package:

import asyncio
from agents import OpenAIChatCompletionsModel, AsyncOpenAI, Agent, Runner

async def main():
    agent = Agent(
        name="Assistant",
        instructions="You are a helpful assistant.",
        model=OpenAIChatCompletionsModel( 
            model="gpt-4o-search-preview-2025-03-11",
            openai_client=AsyncOpenAI()
        )
    )

    result = await Runner.run(agent, "What is the news in the world today?")
    print(result.final_output)

if __name__ == "__main__":
    asyncio.run(main())

or directly with the ChatCompletions API, as you can see on their website:

from openai import OpenAI
client = OpenAI()

completion = client.chat.completions.create(
    model="gpt-4o-search-preview",
    web_search_options={},
    messages=[
        {
            "role": "user",
            "content": "What was a positive news story from today?",
        }
    ],
)

print(completion.choices[0].message.content)

[hovofn]

from agents import set_default_openai_api

set_default_openai_api("chat_completions")

it will be use ChatCompletions API

[rm-openai]

Thank you @DanieleMorotti and @hovofn! More info here as well: https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat

[ai-srcflow]

my code :

import asyncio
from agents import Agent, Runner, WebSearchTool, trace, OpenAIChatCompletionsModel, set_default_openai_api
from openai import AsyncOpenAI

client = AsyncOpenAI(api_key="fxxxxx",base_url="https://api.360.cn/v1")
set_default_openai_api("chat_completions")

async def main():
agent = Agent(
name="Web searcher",
instructions="You are a helpful agent.",
model=OpenAIChatCompletionsModel(
openai_client=client,
model="gpt-4"
),
tools=[WebSearchTool(user_location={"type": "approximate", "city": "西安"})],
)

with trace("Web search example"):
    result = await Runner.run(
        agent,
        "search the web for 'local sports news' and give me 1 interesting update in a sentence.",
    )
    print(result.final_output)

if name == "main":
asyncio.run(main())

it looks like right ,but error always

Hosted tools are not supported with the ChatCompletions API. FGot tool type: <class 'agents.tool.WebSearchTool'>

why....

[ai-srcflow]

the api and key to compute chatting with openai sdk is normal。only use inner tools is abnormal

[DanieleMorotti]

my code :

import asyncio from agents import Agent, Runner, WebSearchTool, trace, OpenAIChatCompletionsModel, set_default_openai_api from openai import AsyncOpenAI

client = AsyncOpenAI(api_key="fxxxxx",base_url="https://api.360.cn/v1") set_default_openai_api("chat_completions")

async def main(): agent = Agent( name="Web searcher", instructions="You are a helpful agent.", model=OpenAIChatCompletionsModel( openai_client=client, model="gpt-4" ), tools=[WebSearchTool(user_location={"type": "approximate", "city": "西安"})], )

with trace("Web search example"):
    result = await Runner.run(
        agent,
        "search the web for 'local sports news' and give me 1 interesting update in a sentence.",
    )
    print(result.final_output)

if name == "main": asyncio.run(main())

it looks like right ,but error always

Hosted tools are not supported with the ChatCompletions API. FGot tool type: <class 'agents.tool.WebSearchTool'>

why....

Yes, you can't use WebSearchTool with ChatCompletionsAPI. If you check my previous example, you can see that you should use gpt-4o-search-preview or gpt-4o-mini-search-preview instead of passing the tool.