OpenAI Responses

OpenAIResponses is a class for interacting with OpenAI models using the Responses API. This class provides a streamlined interface for working with OpenAI’s newer Responses API, which is distinct from the traditional Chat API. It supports advanced features like tool use, file processing, and knowledge retrieval.

Authentication

Set your OPENAI_API_KEY environment variable. You can get one from OpenAI here.

Mac

export OPENAI_API_KEY=sk-***

Example

Use OpenAIResponses with your Agent:

agent.py

from agno.agent import Agent
from agno.media import File
from agno.models.openai.responses import OpenAIResponses

agent = Agent(
    model=OpenAIResponses(id="gpt-4o-mini"),
    tools=[{"type": "file_search"}, {"type": "web_search_preview"}],
    markdown=True,
)

agent.print_response(
    "Summarize the contents of the attached file and search the web for more information.",
    files=[File(url="https://agno-public.s3.amazonaws.com/recipes/ThaiRecipes.pdf")],
)

View more examples here.

Params

For more information, please refer to the OpenAI Responses docs as well.

Name	Type	Default	Description
id	str	"gpt-4o"	The id of the OpenAI model to use.
name	str	"OpenAIResponses"	The name of this response model instance.
provider	str	"OpenAI"	The provider of the model.
include	Optional[List[str]]	None	List of response components to include in the response.
max_output_tokens	Optional[int]	None	The maximum number of tokens to generate in the response output.
metadata	Optional[Dict[str, Any]]	None	Additional metadata to include with the request.
parallel_tool_calls	Optional[bool]	None	Whether to allow parallel tool calls.
reasoning	Optional[Dict[str, Any]]	None	Parameters for enabling and controlling reasoning/thinking in the response.
store	Optional[bool]	None	Whether to store the output of this response request for model distillation or evals.
temperature	Optional[float]	None	Controls randomness in the model's output.
top_p	Optional[float]	None	Controls diversity via nucleus sampling.
truncation	Optional[str]	None	How to handle content that exceeds the token limit.
user	Optional[str]	None	A unique identifier representing your end-user.
response_format	Optional[Any]	None	An object specifying the format that the model must output.
request_params	Optional[Dict[str, Any]]	None	Additional parameters to include in the request.
api_key	Optional[str]	None	The API key for authenticating with OpenAI.
organization	Optional[str]	None	The organization to use for API requests.
base_url	Optional[Union[str, httpx.URL]]	None	The base URL for API requests.
timeout	Optional[float]	None	The timeout for API requests.
max_retries	Optional[int]	None	The maximum number of retries for failed requests.
default_headers	Optional[Dict[str, str]]	None	Default headers to include in all requests.
default_query	Optional[Dict[str, str]]	None	Default query parameters to include in all requests.
http_client	Optional[httpx.Client]	None	An optional pre-configured HTTP client.
client_params	Optional[Dict[str, Any]]	None	Additional parameters for client configuration.
vector_store_name	str	"knowledge_base"	The name of the vector store for file uploads and retrieval.

OpenAIResponses is a subclass of the Model class and has access to the same params.