Skip to content

Items

TResponse module-attribute 

TResponse = Response

A type alias for the Response type from the OpenAI SDK.

TResponseInputItem module-attribute 

TResponseInputItem = ResponseInputItemParam

A type alias for the ResponseInputItemParam type from the OpenAI SDK.

TResponseOutputItem module-attribute 

TResponseOutputItem = ResponseOutputItem

A type alias for the ResponseOutputItem type from the OpenAI SDK.

TResponseStreamEvent module-attribute 

TResponseStreamEvent = ResponseStreamEvent

A type alias for the ResponseStreamEvent type from the OpenAI SDK.

ToolCallItemTypes module-attribute 

ToolCallItemTypes: TypeAlias = Union[
    ResponseFunctionToolCall,
    ResponseComputerToolCall,
    ResponseFileSearchToolCall,
    ResponseFunctionWebSearch,
    McpCall,
    ResponseCodeInterpreterToolCall,
    ImageGenerationCall,
    LocalShellCall,
    dict[str, Any],
]

A type that represents a tool call item.

RunItem module-attribute 

RunItem: TypeAlias = Union[
    MessageOutputItem,
    HandoffCallItem,
    HandoffOutputItem,
    ToolCallItem,
    ToolCallOutputItem,
    CompactionItem,
    ReasoningItem,
    MCPListToolsItem,
    MCPApprovalRequestItem,
    MCPApprovalResponseItem,
    CompactionItem,
    ToolApprovalItem,
]

An item generated by an agent.

RunItemBase dataclass

Bases: Generic[T], ABC

Source code in src/agents/items.py 
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
@dataclass
class RunItemBase(Generic[T], abc.ABC):
    agent: Agent[Any]
    """The agent whose run caused this item to be generated."""

    raw_item: T
    """The raw Responses item from the run. This will always be either an output item (i.e.
    `openai.types.responses.ResponseOutputItem` or an input item
    (i.e. `openai.types.responses.ResponseInputItemParam`).
    """

    _agent_ref: weakref.ReferenceType[Agent[Any]] | None = field(
        init=False,
        repr=False,
        default=None,
    )

    def __post_init__(self) -> None:
        # Store a weak reference so we can release the strong reference later if desired.
        self._agent_ref = weakref.ref(self.agent)

    def __getattribute__(self, name: str) -> Any:
        if name == "agent":
            return self._get_agent_via_weakref("agent", "_agent_ref")
        return super().__getattribute__(name)

    def release_agent(self) -> None:
        """Release the strong reference to the agent while keeping a weak reference."""
        if "agent" not in self.__dict__:
            return
        agent = self.__dict__["agent"]
        if agent is None:
            return
        self._agent_ref = weakref.ref(agent) if agent is not None else None
        # Set to None instead of deleting so dataclass repr/asdict keep working.
        self.__dict__["agent"] = None

    def _get_agent_via_weakref(self, attr_name: str, ref_name: str) -> Any:
        # Preserve the dataclass field so repr/asdict still read it, but lazily resolve the weakref
        # when the stored value is None (meaning release_agent already dropped the strong ref).
        # If the attribute was never overridden we fall back to the default descriptor chain.
        data = object.__getattribute__(self, "__dict__")
        value = data.get(attr_name, _MISSING_ATTR_SENTINEL)
        if value is _MISSING_ATTR_SENTINEL:
            return object.__getattribute__(self, attr_name)
        if value is not None:
            return value
        ref = object.__getattribute__(self, ref_name)
        if ref is not None:
            agent = ref()
            if agent is not None:
                return agent
        return None

    def to_input_item(self) -> TResponseInputItem:
        """Converts this item into an input item suitable for passing to the model."""
        if isinstance(self.raw_item, dict):
            # We know that input items are dicts, so we can ignore the type error
            return self.raw_item  # type: ignore
        elif isinstance(self.raw_item, BaseModel):
            # All output items are Pydantic models that can be converted to input items.
            return self.raw_item.model_dump(exclude_unset=True)  # type: ignore
        else:
            raise AgentsException(f"Unexpected raw item type: {type(self.raw_item)}")

agent instance-attribute 

agent: Agent[Any]

The agent whose run caused this item to be generated.

raw_item instance-attribute 

raw_item: T

The raw Responses item from the run. This will always be either an output item (i.e. openai.types.responses.ResponseOutputItem or an input item (i.e. openai.types.responses.ResponseInputItemParam).

release_agent 

release_agent() -> None

Release the strong reference to the agent while keeping a weak reference.

Source code in src/agents/items.py 
107
108
109
110
111
112
113
114
115
116
def release_agent(self) -> None:
    """Release the strong reference to the agent while keeping a weak reference."""
    if "agent" not in self.__dict__:
        return
    agent = self.__dict__["agent"]
    if agent is None:
        return
    self._agent_ref = weakref.ref(agent) if agent is not None else None
    # Set to None instead of deleting so dataclass repr/asdict keep working.
    self.__dict__["agent"] = None

to_input_item 

to_input_item() -> TResponseInputItem

Converts this item into an input item suitable for passing to the model.

Source code in src/agents/items.py 
135
136
137
138
139
140
141
142
143
144
def to_input_item(self) -> TResponseInputItem:
    """Converts this item into an input item suitable for passing to the model."""
    if isinstance(self.raw_item, dict):
        # We know that input items are dicts, so we can ignore the type error
        return self.raw_item  # type: ignore
    elif isinstance(self.raw_item, BaseModel):
        # All output items are Pydantic models that can be converted to input items.
        return self.raw_item.model_dump(exclude_unset=True)  # type: ignore
    else:
        raise AgentsException(f"Unexpected raw item type: {type(self.raw_item)}")

MessageOutputItem dataclass

Bases: RunItemBase[ResponseOutputMessage]

Represents a message from the LLM.

Source code in src/agents/items.py 
147
148
149
150
151
152
153
154
@dataclass
class MessageOutputItem(RunItemBase[ResponseOutputMessage]):
    """Represents a message from the LLM."""

    raw_item: ResponseOutputMessage
    """The raw response output message."""

    type: Literal["message_output_item"] = "message_output_item"

raw_item instance-attribute 

raw_item: ResponseOutputMessage

The raw response output message.

agent instance-attribute 

agent: Agent[Any]

The agent whose run caused this item to be generated.

release_agent 

release_agent() -> None

Release the strong reference to the agent while keeping a weak reference.

Source code in src/agents/items.py 
107
108
109
110
111
112
113
114
115
116
def release_agent(self) -> None:
    """Release the strong reference to the agent while keeping a weak reference."""
    if "agent" not in self.__dict__:
        return
    agent = self.__dict__["agent"]
    if agent is None:
        return
    self._agent_ref = weakref.ref(agent) if agent is not None else None
    # Set to None instead of deleting so dataclass repr/asdict keep working.
    self.__dict__["agent"] = None

to_input_item 

to_input_item() -> TResponseInputItem

Converts this item into an input item suitable for passing to the model.

Source code in src/agents/items.py 
135
136
137
138
139
140
141
142
143
144
def to_input_item(self) -> TResponseInputItem:
    """Converts this item into an input item suitable for passing to the model."""
    if isinstance(self.raw_item, dict):
        # We know that input items are dicts, so we can ignore the type error
        return self.raw_item  # type: ignore
    elif isinstance(self.raw_item, BaseModel):
        # All output items are Pydantic models that can be converted to input items.
        return self.raw_item.model_dump(exclude_unset=True)  # type: ignore
    else:
        raise AgentsException(f"Unexpected raw item type: {type(self.raw_item)}")

HandoffCallItem dataclass

Bases: RunItemBase[ResponseFunctionToolCall]

Represents a tool call for a handoff from one agent to another.

Source code in src/agents/items.py 
157
158
159
160
161
162
163
164
@dataclass
class HandoffCallItem(RunItemBase[ResponseFunctionToolCall]):
    """Represents a tool call for a handoff from one agent to another."""

    raw_item: ResponseFunctionToolCall
    """The raw response function tool call that represents the handoff."""

    type: Literal["handoff_call_item"] = "handoff_call_item"

raw_item instance-attribute 

raw_item: ResponseFunctionToolCall

The raw response function tool call that represents the handoff.

agent instance-attribute 

agent: Agent[Any]

The agent whose run caused this item to be generated.

release_agent 

release_agent() -> None

Release the strong reference to the agent while keeping a weak reference.

Source code in src/agents/items.py 
107
108
109
110
111
112
113
114
115
116
def release_agent(self) -> None:
    """Release the strong reference to the agent while keeping a weak reference."""
    if "agent" not in self.__dict__:
        return
    agent = self.__dict__["agent"]
    if agent is None:
        return
    self._agent_ref = weakref.ref(agent) if agent is not None else None
    # Set to None instead of deleting so dataclass repr/asdict keep working.
    self.__dict__["agent"] = None

to_input_item 

to_input_item() -> TResponseInputItem

Converts this item into an input item suitable for passing to the model.

Source code in src/agents/items.py 
135
136
137
138
139
140
141
142
143
144
def to_input_item(self) -> TResponseInputItem:
    """Converts this item into an input item suitable for passing to the model."""
    if isinstance(self.raw_item, dict):
        # We know that input items are dicts, so we can ignore the type error
        return self.raw_item  # type: ignore
    elif isinstance(self.raw_item, BaseModel):
        # All output items are Pydantic models that can be converted to input items.
        return self.raw_item.model_dump(exclude_unset=True)  # type: ignore
    else:
        raise AgentsException(f"Unexpected raw item type: {type(self.raw_item)}")

HandoffOutputItem dataclass

Bases: RunItemBase[TResponseInputItem]

Represents the output of a handoff.

Source code in src/agents/items.py 
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
@dataclass
class HandoffOutputItem(RunItemBase[TResponseInputItem]):
    """Represents the output of a handoff."""

    raw_item: TResponseInputItem
    """The raw input item that represents the handoff taking place."""

    source_agent: Agent[Any]
    """The agent that made the handoff."""

    target_agent: Agent[Any]
    """The agent that is being handed off to."""

    type: Literal["handoff_output_item"] = "handoff_output_item"

    _source_agent_ref: weakref.ReferenceType[Agent[Any]] | None = field(
        init=False,
        repr=False,
        default=None,
    )
    _target_agent_ref: weakref.ReferenceType[Agent[Any]] | None = field(
        init=False,
        repr=False,
        default=None,
    )

    def __post_init__(self) -> None:
        super().__post_init__()
        # Maintain weak references so downstream code can release the strong references when safe.
        self._source_agent_ref = weakref.ref(self.source_agent)
        self._target_agent_ref = weakref.ref(self.target_agent)

    def __getattribute__(self, name: str) -> Any:
        if name == "source_agent":
            # Provide lazy weakref access like the base `agent` field so HandoffOutputItem
            # callers keep seeing the original agent until GC occurs.
            return self._get_agent_via_weakref("source_agent", "_source_agent_ref")
        if name == "target_agent":
            # Same as above but for the target of the handoff.
            return self._get_agent_via_weakref("target_agent", "_target_agent_ref")
        return super().__getattribute__(name)

    def release_agent(self) -> None:
        super().release_agent()
        if "source_agent" in self.__dict__:
            source_agent = self.__dict__["source_agent"]
            if source_agent is not None:
                self._source_agent_ref = weakref.ref(source_agent)
            # Preserve dataclass fields for repr/asdict while dropping strong refs.
            self.__dict__["source_agent"] = None
        if "target_agent" in self.__dict__:
            target_agent = self.__dict__["target_agent"]
            if target_agent is not None:
                self._target_agent_ref = weakref.ref(target_agent)
            # Preserve dataclass fields for repr/asdict while dropping strong refs.
            self.__dict__["target_agent"] = None

raw_item instance-attribute 

raw_item: TResponseInputItem

The raw input item that represents the handoff taking place.

source_agent instance-attribute 

source_agent: Agent[Any]

The agent that made the handoff.

target_agent instance-attribute 

target_agent: Agent[Any]

The agent that is being handed off to.

agent instance-attribute 

agent: Agent[Any]

The agent whose run caused this item to be generated.

to_input_item 

to_input_item() -> TResponseInputItem

Converts this item into an input item suitable for passing to the model.

Source code in src/agents/items.py 
135
136
137
138
139
140
141
142
143
144
def to_input_item(self) -> TResponseInputItem:
    """Converts this item into an input item suitable for passing to the model."""
    if isinstance(self.raw_item, dict):
        # We know that input items are dicts, so we can ignore the type error
        return self.raw_item  # type: ignore
    elif isinstance(self.raw_item, BaseModel):
        # All output items are Pydantic models that can be converted to input items.
        return self.raw_item.model_dump(exclude_unset=True)  # type: ignore
    else:
        raise AgentsException(f"Unexpected raw item type: {type(self.raw_item)}")

ToolCallItem dataclass

Bases: RunItemBase[Any]

Represents a tool call e.g. a function call or computer action call.

Source code in src/agents/items.py 
239
240
241
242
243
244
245
246
@dataclass
class ToolCallItem(RunItemBase[Any]):
    """Represents a tool call e.g. a function call or computer action call."""

    raw_item: ToolCallItemTypes
    """The raw tool call item."""

    type: Literal["tool_call_item"] = "tool_call_item"

raw_item instance-attribute 

raw_item: ToolCallItemTypes

The raw tool call item.

agent instance-attribute 

agent: Agent[Any]

The agent whose run caused this item to be generated.

release_agent 

release_agent() -> None

Release the strong reference to the agent while keeping a weak reference.

Source code in src/agents/items.py 
107
108
109
110
111
112
113
114
115
116
def release_agent(self) -> None:
    """Release the strong reference to the agent while keeping a weak reference."""
    if "agent" not in self.__dict__:
        return
    agent = self.__dict__["agent"]
    if agent is None:
        return
    self._agent_ref = weakref.ref(agent) if agent is not None else None
    # Set to None instead of deleting so dataclass repr/asdict keep working.
    self.__dict__["agent"] = None

to_input_item 

to_input_item() -> TResponseInputItem

Converts this item into an input item suitable for passing to the model.

Source code in src/agents/items.py 
135
136
137
138
139
140
141
142
143
144
def to_input_item(self) -> TResponseInputItem:
    """Converts this item into an input item suitable for passing to the model."""
    if isinstance(self.raw_item, dict):
        # We know that input items are dicts, so we can ignore the type error
        return self.raw_item  # type: ignore
    elif isinstance(self.raw_item, BaseModel):
        # All output items are Pydantic models that can be converted to input items.
        return self.raw_item.model_dump(exclude_unset=True)  # type: ignore
    else:
        raise AgentsException(f"Unexpected raw item type: {type(self.raw_item)}")

ToolCallOutputItem dataclass

Bases: RunItemBase[Any]

Represents the output of a tool call.

Source code in src/agents/items.py 
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
@dataclass
class ToolCallOutputItem(RunItemBase[Any]):
    """Represents the output of a tool call."""

    raw_item: ToolCallOutputTypes
    """The raw item from the model."""

    output: Any
    """The output of the tool call. This is whatever the tool call returned; the `raw_item`
    contains a string representation of the output.
    """

    type: Literal["tool_call_output_item"] = "tool_call_output_item"

    def to_input_item(self) -> TResponseInputItem:
        """Converts the tool output into an input item for the next model turn.

        Hosted tool outputs (e.g. shell/apply_patch) carry a `status` field for the SDK's
        book-keeping, but the Responses API does not yet accept that parameter. Strip it from the
        payload we send back to the model while keeping the original raw item intact.
        """

        if isinstance(self.raw_item, dict):
            payload = dict(self.raw_item)
            payload_type = payload.get("type")
            if payload_type == "shell_call_output":
                payload = dict(payload)
                payload.pop("status", None)
                payload.pop("shell_output", None)
                payload.pop("provider_data", None)
                outputs = payload.get("output")
                if isinstance(outputs, list):
                    for entry in outputs:
                        if not isinstance(entry, dict):
                            continue
                        outcome = entry.get("outcome")
                        if isinstance(outcome, dict):
                            if outcome.get("type") == "exit":
                                entry["outcome"] = outcome
            return cast(TResponseInputItem, payload)

        return super().to_input_item()

raw_item instance-attribute 

raw_item: ToolCallOutputTypes

The raw item from the model.

output instance-attribute 

output: Any

The output of the tool call. This is whatever the tool call returned; the raw_item contains a string representation of the output.

agent instance-attribute 

agent: Agent[Any]

The agent whose run caused this item to be generated.

to_input_item 

to_input_item() -> TResponseInputItem

Converts the tool output into an input item for the next model turn.

Hosted tool outputs (e.g. shell/apply_patch) carry a status field for the SDK's book-keeping, but the Responses API does not yet accept that parameter. Strip it from the payload we send back to the model while keeping the original raw item intact.

Source code in src/agents/items.py 
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
def to_input_item(self) -> TResponseInputItem:
    """Converts the tool output into an input item for the next model turn.

    Hosted tool outputs (e.g. shell/apply_patch) carry a `status` field for the SDK's
    book-keeping, but the Responses API does not yet accept that parameter. Strip it from the
    payload we send back to the model while keeping the original raw item intact.
    """

    if isinstance(self.raw_item, dict):
        payload = dict(self.raw_item)
        payload_type = payload.get("type")
        if payload_type == "shell_call_output":
            payload = dict(payload)
            payload.pop("status", None)
            payload.pop("shell_output", None)
            payload.pop("provider_data", None)
            outputs = payload.get("output")
            if isinstance(outputs, list):
                for entry in outputs:
                    if not isinstance(entry, dict):
                        continue
                    outcome = entry.get("outcome")
                    if isinstance(outcome, dict):
                        if outcome.get("type") == "exit":
                            entry["outcome"] = outcome
        return cast(TResponseInputItem, payload)

    return super().to_input_item()

release_agent 

release_agent() -> None

Release the strong reference to the agent while keeping a weak reference.

Source code in src/agents/items.py 
107
108
109
110
111
112
113
114
115
116
def release_agent(self) -> None:
    """Release the strong reference to the agent while keeping a weak reference."""
    if "agent" not in self.__dict__:
        return
    agent = self.__dict__["agent"]
    if agent is None:
        return
    self._agent_ref = weakref.ref(agent) if agent is not None else None
    # Set to None instead of deleting so dataclass repr/asdict keep working.
    self.__dict__["agent"] = None

ReasoningItem dataclass

Bases: RunItemBase[ResponseReasoningItem]

Represents a reasoning item.

Source code in src/agents/items.py 
301
302
303
304
305
306
307
308
@dataclass
class ReasoningItem(RunItemBase[ResponseReasoningItem]):
    """Represents a reasoning item."""

    raw_item: ResponseReasoningItem
    """The raw reasoning item."""

    type: Literal["reasoning_item"] = "reasoning_item"

raw_item instance-attribute 

raw_item: ResponseReasoningItem

The raw reasoning item.

agent instance-attribute 

agent: Agent[Any]

The agent whose run caused this item to be generated.

release_agent 

release_agent() -> None

Release the strong reference to the agent while keeping a weak reference.

Source code in src/agents/items.py 
107
108
109
110
111
112
113
114
115
116
def release_agent(self) -> None:
    """Release the strong reference to the agent while keeping a weak reference."""
    if "agent" not in self.__dict__:
        return
    agent = self.__dict__["agent"]
    if agent is None:
        return
    self._agent_ref = weakref.ref(agent) if agent is not None else None
    # Set to None instead of deleting so dataclass repr/asdict keep working.
    self.__dict__["agent"] = None

to_input_item 

to_input_item() -> TResponseInputItem

Converts this item into an input item suitable for passing to the model.

Source code in src/agents/items.py 
135
136
137
138
139
140
141
142
143
144
def to_input_item(self) -> TResponseInputItem:
    """Converts this item into an input item suitable for passing to the model."""
    if isinstance(self.raw_item, dict):
        # We know that input items are dicts, so we can ignore the type error
        return self.raw_item  # type: ignore
    elif isinstance(self.raw_item, BaseModel):
        # All output items are Pydantic models that can be converted to input items.
        return self.raw_item.model_dump(exclude_unset=True)  # type: ignore
    else:
        raise AgentsException(f"Unexpected raw item type: {type(self.raw_item)}")

MCPListToolsItem dataclass

Bases: RunItemBase[McpListTools]

Represents a call to an MCP server to list tools.

Source code in src/agents/items.py 
311
312
313
314
315
316
317
318
@dataclass
class MCPListToolsItem(RunItemBase[McpListTools]):
    """Represents a call to an MCP server to list tools."""

    raw_item: McpListTools
    """The raw MCP list tools call."""

    type: Literal["mcp_list_tools_item"] = "mcp_list_tools_item"

raw_item instance-attribute 

raw_item: McpListTools

The raw MCP list tools call.

agent instance-attribute 

agent: Agent[Any]

The agent whose run caused this item to be generated.

release_agent 

release_agent() -> None

Release the strong reference to the agent while keeping a weak reference.

Source code in src/agents/items.py 
107
108
109
110
111
112
113
114
115
116
def release_agent(self) -> None:
    """Release the strong reference to the agent while keeping a weak reference."""
    if "agent" not in self.__dict__:
        return
    agent = self.__dict__["agent"]
    if agent is None:
        return
    self._agent_ref = weakref.ref(agent) if agent is not None else None
    # Set to None instead of deleting so dataclass repr/asdict keep working.
    self.__dict__["agent"] = None

to_input_item 

to_input_item() -> TResponseInputItem

Converts this item into an input item suitable for passing to the model.

Source code in src/agents/items.py 
135
136
137
138
139
140
141
142
143
144
def to_input_item(self) -> TResponseInputItem:
    """Converts this item into an input item suitable for passing to the model."""
    if isinstance(self.raw_item, dict):
        # We know that input items are dicts, so we can ignore the type error
        return self.raw_item  # type: ignore
    elif isinstance(self.raw_item, BaseModel):
        # All output items are Pydantic models that can be converted to input items.
        return self.raw_item.model_dump(exclude_unset=True)  # type: ignore
    else:
        raise AgentsException(f"Unexpected raw item type: {type(self.raw_item)}")

MCPApprovalRequestItem dataclass

Bases: RunItemBase[McpApprovalRequest]

Represents a request for MCP approval.

Source code in src/agents/items.py 
321
322
323
324
325
326
327
328
@dataclass
class MCPApprovalRequestItem(RunItemBase[McpApprovalRequest]):
    """Represents a request for MCP approval."""

    raw_item: McpApprovalRequest
    """The raw MCP approval request."""

    type: Literal["mcp_approval_request_item"] = "mcp_approval_request_item"

raw_item instance-attribute 

raw_item: McpApprovalRequest

The raw MCP approval request.

agent instance-attribute 

agent: Agent[Any]

The agent whose run caused this item to be generated.

release_agent 

release_agent() -> None

Release the strong reference to the agent while keeping a weak reference.

Source code in src/agents/items.py 
107
108
109
110
111
112
113
114
115
116
def release_agent(self) -> None:
    """Release the strong reference to the agent while keeping a weak reference."""
    if "agent" not in self.__dict__:
        return
    agent = self.__dict__["agent"]
    if agent is None:
        return
    self._agent_ref = weakref.ref(agent) if agent is not None else None
    # Set to None instead of deleting so dataclass repr/asdict keep working.
    self.__dict__["agent"] = None

to_input_item 

to_input_item() -> TResponseInputItem

Converts this item into an input item suitable for passing to the model.

Source code in src/agents/items.py 
135
136
137
138
139
140
141
142
143
144
def to_input_item(self) -> TResponseInputItem:
    """Converts this item into an input item suitable for passing to the model."""
    if isinstance(self.raw_item, dict):
        # We know that input items are dicts, so we can ignore the type error
        return self.raw_item  # type: ignore
    elif isinstance(self.raw_item, BaseModel):
        # All output items are Pydantic models that can be converted to input items.
        return self.raw_item.model_dump(exclude_unset=True)  # type: ignore
    else:
        raise AgentsException(f"Unexpected raw item type: {type(self.raw_item)}")

MCPApprovalResponseItem dataclass

Bases: RunItemBase[McpApprovalResponse]

Represents a response to an MCP approval request.

Source code in src/agents/items.py 
331
332
333
334
335
336
337
338
@dataclass
class MCPApprovalResponseItem(RunItemBase[McpApprovalResponse]):
    """Represents a response to an MCP approval request."""

    raw_item: McpApprovalResponse
    """The raw MCP approval response."""

    type: Literal["mcp_approval_response_item"] = "mcp_approval_response_item"

raw_item instance-attribute 

raw_item: McpApprovalResponse

The raw MCP approval response.

agent instance-attribute 

agent: Agent[Any]

The agent whose run caused this item to be generated.

release_agent 

release_agent() -> None

Release the strong reference to the agent while keeping a weak reference.

Source code in src/agents/items.py 
107
108
109
110
111
112
113
114
115
116
def release_agent(self) -> None:
    """Release the strong reference to the agent while keeping a weak reference."""
    if "agent" not in self.__dict__:
        return
    agent = self.__dict__["agent"]
    if agent is None:
        return
    self._agent_ref = weakref.ref(agent) if agent is not None else None
    # Set to None instead of deleting so dataclass repr/asdict keep working.
    self.__dict__["agent"] = None

to_input_item 

to_input_item() -> TResponseInputItem

Converts this item into an input item suitable for passing to the model.

Source code in src/agents/items.py 
135
136
137
138
139
140
141
142
143
144
def to_input_item(self) -> TResponseInputItem:
    """Converts this item into an input item suitable for passing to the model."""
    if isinstance(self.raw_item, dict):
        # We know that input items are dicts, so we can ignore the type error
        return self.raw_item  # type: ignore
    elif isinstance(self.raw_item, BaseModel):
        # All output items are Pydantic models that can be converted to input items.
        return self.raw_item.model_dump(exclude_unset=True)  # type: ignore
    else:
        raise AgentsException(f"Unexpected raw item type: {type(self.raw_item)}")

CompactionItem dataclass

Bases: RunItemBase[TResponseInputItem]

Represents a compaction item from responses.compact.

Source code in src/agents/items.py 
341
342
343
344
345
346
347
348
349
@dataclass
class CompactionItem(RunItemBase[TResponseInputItem]):
    """Represents a compaction item from responses.compact."""

    type: Literal["compaction_item"] = "compaction_item"

    def to_input_item(self) -> TResponseInputItem:
        """Converts this item into an input item suitable for passing to the model."""
        return self.raw_item

agent instance-attribute 

agent: Agent[Any]

The agent whose run caused this item to be generated.

raw_item instance-attribute 

raw_item: T

The raw Responses item from the run. This will always be either an output item (i.e. openai.types.responses.ResponseOutputItem or an input item (i.e. openai.types.responses.ResponseInputItemParam).

to_input_item 

to_input_item() -> TResponseInputItem

Converts this item into an input item suitable for passing to the model.

Source code in src/agents/items.py 
347
348
349
def to_input_item(self) -> TResponseInputItem:
    """Converts this item into an input item suitable for passing to the model."""
    return self.raw_item

release_agent 

release_agent() -> None

Release the strong reference to the agent while keeping a weak reference.

Source code in src/agents/items.py 
107
108
109
110
111
112
113
114
115
116
def release_agent(self) -> None:
    """Release the strong reference to the agent while keeping a weak reference."""
    if "agent" not in self.__dict__:
        return
    agent = self.__dict__["agent"]
    if agent is None:
        return
    self._agent_ref = weakref.ref(agent) if agent is not None else None
    # Set to None instead of deleting so dataclass repr/asdict keep working.
    self.__dict__["agent"] = None

ToolApprovalItem dataclass

Bases: RunItemBase[Any]

Tool call that requires approval before execution.

Source code in src/agents/items.py 
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
@dataclass
class ToolApprovalItem(RunItemBase[Any]):
    """Tool call that requires approval before execution."""

    raw_item: ToolApprovalRawItem
    """Raw tool call awaiting approval (function, hosted, shell, etc.)."""

    tool_name: str | None = None
    """Tool name for approval tracking; falls back to raw_item.name when absent."""

    type: Literal["tool_approval_item"] = "tool_approval_item"

    def __post_init__(self) -> None:
        """Populate tool_name from the raw item if not provided."""
        if self.tool_name is None:
            # Extract name from raw_item - handle different types
            if isinstance(self.raw_item, dict):
                self.tool_name = self.raw_item.get("name")
            elif hasattr(self.raw_item, "name"):
                self.tool_name = self.raw_item.name
            else:
                self.tool_name = None

    def __hash__(self) -> int:
        """Hash by object identity to keep distinct approvals separate."""
        return object.__hash__(self)

    def __eq__(self, other: object) -> bool:
        """Equality is based on object identity."""
        return self is other

    @property
    def name(self) -> str | None:
        """Return the tool name from tool_name or raw_item (backwards compatible)."""
        if self.tool_name:
            return self.tool_name
        if isinstance(self.raw_item, dict):
            candidate = self.raw_item.get("name") or self.raw_item.get("tool_name")
        else:
            candidate = getattr(self.raw_item, "name", None) or getattr(
                self.raw_item, "tool_name", None
            )
        return str(candidate) if candidate is not None else None

    @property
    def arguments(self) -> str | None:
        """Return tool call arguments if present on the raw item."""
        candidate: Any | None = None
        if isinstance(self.raw_item, dict):
            candidate = self.raw_item.get("arguments")
            if candidate is None:
                candidate = self.raw_item.get("params") or self.raw_item.get("input")
        elif hasattr(self.raw_item, "arguments"):
            candidate = self.raw_item.arguments
        elif hasattr(self.raw_item, "params") or hasattr(self.raw_item, "input"):
            candidate = getattr(self.raw_item, "params", None) or getattr(
                self.raw_item, "input", None
            )
        if candidate is None:
            return None
        if isinstance(candidate, str):
            return candidate
        try:
            return json.dumps(candidate)
        except (TypeError, ValueError):
            return str(candidate)

    def _extract_call_id(self) -> str | None:
        """Return call identifier from the raw item."""
        if isinstance(self.raw_item, dict):
            return self.raw_item.get("call_id") or self.raw_item.get("id")
        return getattr(self.raw_item, "call_id", None) or getattr(self.raw_item, "id", None)

    @property
    def call_id(self) -> str | None:
        """Return call identifier from the raw item."""
        return self._extract_call_id()

    def to_input_item(self) -> TResponseInputItem:
        """ToolApprovalItem should never be sent as input; raise to surface misuse."""
        raise AgentsException(
            "ToolApprovalItem cannot be converted to an input item. "
            "These items should be filtered out before preparing input for the API."
        )

raw_item instance-attribute 

raw_item: ToolApprovalRawItem

Raw tool call awaiting approval (function, hosted, shell, etc.).

tool_name class-attribute instance-attribute 

tool_name: str | None = None

Tool name for approval tracking; falls back to raw_item.name when absent.

name property 

name: str | None

Return the tool name from tool_name or raw_item (backwards compatible).

arguments property 

arguments: str | None

Return tool call arguments if present on the raw item.

call_id property 

call_id: str | None

Return call identifier from the raw item.

agent instance-attribute 

agent: Agent[Any]

The agent whose run caused this item to be generated.

__post_init__ 

__post_init__() -> None

Populate tool_name from the raw item if not provided.

Source code in src/agents/items.py 
374
375
376
377
378
379
380
381
382
383
def __post_init__(self) -> None:
    """Populate tool_name from the raw item if not provided."""
    if self.tool_name is None:
        # Extract name from raw_item - handle different types
        if isinstance(self.raw_item, dict):
            self.tool_name = self.raw_item.get("name")
        elif hasattr(self.raw_item, "name"):
            self.tool_name = self.raw_item.name
        else:
            self.tool_name = None

__hash__ 

__hash__() -> int

Hash by object identity to keep distinct approvals separate.

Source code in src/agents/items.py 
385
386
387
def __hash__(self) -> int:
    """Hash by object identity to keep distinct approvals separate."""
    return object.__hash__(self)

__eq__ 

__eq__(other: object) -> bool

Equality is based on object identity.

Source code in src/agents/items.py 
389
390
391
def __eq__(self, other: object) -> bool:
    """Equality is based on object identity."""
    return self is other

to_input_item 

to_input_item() -> TResponseInputItem

ToolApprovalItem should never be sent as input; raise to surface misuse.

Source code in src/agents/items.py 
440
441
442
443
444
445
def to_input_item(self) -> TResponseInputItem:
    """ToolApprovalItem should never be sent as input; raise to surface misuse."""
    raise AgentsException(
        "ToolApprovalItem cannot be converted to an input item. "
        "These items should be filtered out before preparing input for the API."
    )

release_agent 

release_agent() -> None

Release the strong reference to the agent while keeping a weak reference.

Source code in src/agents/items.py 
107
108
109
110
111
112
113
114
115
116
def release_agent(self) -> None:
    """Release the strong reference to the agent while keeping a weak reference."""
    if "agent" not in self.__dict__:
        return
    agent = self.__dict__["agent"]
    if agent is None:
        return
    self._agent_ref = weakref.ref(agent) if agent is not None else None
    # Set to None instead of deleting so dataclass repr/asdict keep working.
    self.__dict__["agent"] = None

ModelResponse

Source code in src/agents/items.py 
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
@pydantic.dataclasses.dataclass
class ModelResponse:
    output: list[TResponseOutputItem]
    """A list of outputs (messages, tool calls, etc) generated by the model"""

    usage: Usage
    """The usage information for the response."""

    response_id: str | None
    """An ID for the response which can be used to refer to the response in subsequent calls to the
    model. Not supported by all model providers.
    If using OpenAI models via the Responses API, this is the `response_id` parameter, and it can
    be passed to `Runner.run`.
    """

    def to_input_items(self) -> list[TResponseInputItem]:
        """Convert the output into a list of input items suitable for passing to the model."""
        # We happen to know that the shape of the Pydantic output items are the same as the
        # equivalent TypedDict input items, so we can just convert each one.
        # This is also tested via unit tests.
        return [it.model_dump(exclude_unset=True) for it in self.output]  # type: ignore

output instance-attribute 

output: list[TResponseOutputItem]

A list of outputs (messages, tool calls, etc) generated by the model

usage instance-attribute 

usage: Usage

The usage information for the response.

response_id instance-attribute 

response_id: str | None

An ID for the response which can be used to refer to the response in subsequent calls to the model. Not supported by all model providers. If using OpenAI models via the Responses API, this is the response_id parameter, and it can be passed to Runner.run.

to_input_items 

to_input_items() -> list[TResponseInputItem]

Convert the output into a list of input items suitable for passing to the model.

Source code in src/agents/items.py 
480
481
482
483
484
485
def to_input_items(self) -> list[TResponseInputItem]:
    """Convert the output into a list of input items suitable for passing to the model."""
    # We happen to know that the shape of the Pydantic output items are the same as the
    # equivalent TypedDict input items, so we can just convert each one.
    # This is also tested via unit tests.
    return [it.model_dump(exclude_unset=True) for it in self.output]  # type: ignore

ItemHelpers

Source code in src/agents/items.py 
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
class ItemHelpers:
    @classmethod
    def extract_last_content(cls, message: TResponseOutputItem) -> str:
        """Extracts the last text content or refusal from a message."""
        if not isinstance(message, ResponseOutputMessage):
            return ""

        if not message.content:
            return ""
        last_content = message.content[-1]
        if isinstance(last_content, ResponseOutputText):
            return last_content.text
        elif isinstance(last_content, ResponseOutputRefusal):
            return last_content.refusal
        else:
            raise ModelBehaviorError(f"Unexpected content type: {type(last_content)}")

    @classmethod
    def extract_last_text(cls, message: TResponseOutputItem) -> str | None:
        """Extracts the last text content from a message, if any. Ignores refusals."""
        if isinstance(message, ResponseOutputMessage):
            if not message.content:
                return None
            last_content = message.content[-1]
            if isinstance(last_content, ResponseOutputText):
                return last_content.text

        return None

    @classmethod
    def input_to_new_input_list(
        cls, input: str | list[TResponseInputItem]
    ) -> list[TResponseInputItem]:
        """Converts a string or list of input items into a list of input items."""
        if isinstance(input, str):
            return [
                {
                    "content": input,
                    "role": "user",
                }
            ]
        return input.copy()

    @classmethod
    def text_message_outputs(cls, items: list[RunItem]) -> str:
        """Concatenates all the text content from a list of message output items."""
        text = ""
        for item in items:
            if isinstance(item, MessageOutputItem):
                text += cls.text_message_output(item)
        return text

    @classmethod
    def text_message_output(cls, message: MessageOutputItem) -> str:
        """Extracts all the text content from a single message output item."""
        text = ""
        for item in message.raw_item.content:
            if isinstance(item, ResponseOutputText):
                text += item.text
        return text

    @classmethod
    def tool_call_output_item(
        cls, tool_call: ResponseFunctionToolCall, output: Any
    ) -> FunctionCallOutput:
        """Creates a tool call output item from a tool call and its output.

        Accepts either plain values (stringified) or structured outputs using
        input_text/input_image/input_file shapes. Structured outputs may be
        provided as Pydantic models or dicts, or an iterable of such items.
        """

        converted_output = cls._convert_tool_output(output)

        return {
            "call_id": tool_call.call_id,
            "output": converted_output,
            "type": "function_call_output",
        }

    @classmethod
    def _convert_tool_output(cls, output: Any) -> str | ResponseFunctionCallOutputItemListParam:
        """Converts a tool return value into an output acceptable by the Responses API."""

        # If the output is either a single or list of the known structured output types, convert to
        # ResponseFunctionCallOutputItemListParam. Else, just stringify.
        if isinstance(output, (list, tuple)):
            maybe_converted_output_list = [
                cls._maybe_get_output_as_structured_function_output(item) for item in output
            ]
            if all(maybe_converted_output_list):
                return [
                    cls._convert_single_tool_output_pydantic_model(item)
                    for item in maybe_converted_output_list
                    if item is not None
                ]
            else:
                return str(output)
        else:
            maybe_converted_output = cls._maybe_get_output_as_structured_function_output(output)
            if maybe_converted_output:
                return [cls._convert_single_tool_output_pydantic_model(maybe_converted_output)]
            else:
                return str(output)

    @classmethod
    def _maybe_get_output_as_structured_function_output(
        cls, output: Any
    ) -> ValidToolOutputPydanticModels | None:
        if isinstance(output, (ToolOutputText, ToolOutputImage, ToolOutputFileContent)):
            return output
        elif isinstance(output, dict):
            # Require explicit 'type' field in dict to be considered a structured output
            if "type" not in output:
                return None
            try:
                return ValidToolOutputPydanticModelsTypeAdapter.validate_python(output)
            except pydantic.ValidationError:
                logger.debug("dict was not a valid tool output pydantic model")
                return None

        return None

    @classmethod
    def _convert_single_tool_output_pydantic_model(
        cls, output: ValidToolOutputPydanticModels
    ) -> ResponseFunctionCallOutputItemParam:
        if isinstance(output, ToolOutputText):
            return {"type": "input_text", "text": output.text}
        elif isinstance(output, ToolOutputImage):
            # Forward all provided optional fields so the Responses API receives
            # the correct identifiers and settings for the image resource.
            result: ResponseInputImageContentParam = {"type": "input_image"}
            if output.image_url is not None:
                result["image_url"] = output.image_url
            if output.file_id is not None:
                result["file_id"] = output.file_id
            if output.detail is not None:
                result["detail"] = output.detail
            return result
        elif isinstance(output, ToolOutputFileContent):
            # Forward all provided optional fields so the Responses API receives
            # the correct identifiers and metadata for the file resource.
            result_file: ResponseInputFileContentParam = {"type": "input_file"}
            if output.file_data is not None:
                result_file["file_data"] = output.file_data
            if output.file_url is not None:
                result_file["file_url"] = output.file_url
            if output.file_id is not None:
                result_file["file_id"] = output.file_id
            if output.filename is not None:
                result_file["filename"] = output.filename
            return result_file
        else:
            assert_never(output)
            raise ValueError(f"Unexpected tool output type: {output}")

extract_last_content classmethod 

extract_last_content(message: TResponseOutputItem) -> str

Extracts the last text content or refusal from a message.

Source code in src/agents/items.py 
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
@classmethod
def extract_last_content(cls, message: TResponseOutputItem) -> str:
    """Extracts the last text content or refusal from a message."""
    if not isinstance(message, ResponseOutputMessage):
        return ""

    if not message.content:
        return ""
    last_content = message.content[-1]
    if isinstance(last_content, ResponseOutputText):
        return last_content.text
    elif isinstance(last_content, ResponseOutputRefusal):
        return last_content.refusal
    else:
        raise ModelBehaviorError(f"Unexpected content type: {type(last_content)}")

extract_last_text classmethod 

extract_last_text(
    message: TResponseOutputItem,
) -> str | None

Extracts the last text content from a message, if any. Ignores refusals.

Source code in src/agents/items.py 
505
506
507
508
509
510
511
512
513
514
515
@classmethod
def extract_last_text(cls, message: TResponseOutputItem) -> str | None:
    """Extracts the last text content from a message, if any. Ignores refusals."""
    if isinstance(message, ResponseOutputMessage):
        if not message.content:
            return None
        last_content = message.content[-1]
        if isinstance(last_content, ResponseOutputText):
            return last_content.text

    return None

input_to_new_input_list classmethod 

input_to_new_input_list(
    input: str | list[TResponseInputItem],
) -> list[TResponseInputItem]

Converts a string or list of input items into a list of input items.

Source code in src/agents/items.py 
517
518
519
520
521
522
523
524
525
526
527
528
529
@classmethod
def input_to_new_input_list(
    cls, input: str | list[TResponseInputItem]
) -> list[TResponseInputItem]:
    """Converts a string or list of input items into a list of input items."""
    if isinstance(input, str):
        return [
            {
                "content": input,
                "role": "user",
            }
        ]
    return input.copy()

text_message_outputs classmethod 

text_message_outputs(items: list[RunItem]) -> str

Concatenates all the text content from a list of message output items.

Source code in src/agents/items.py 
531
532
533
534
535
536
537
538
@classmethod
def text_message_outputs(cls, items: list[RunItem]) -> str:
    """Concatenates all the text content from a list of message output items."""
    text = ""
    for item in items:
        if isinstance(item, MessageOutputItem):
            text += cls.text_message_output(item)
    return text

text_message_output classmethod 

text_message_output(message: MessageOutputItem) -> str

Extracts all the text content from a single message output item.

Source code in src/agents/items.py 
540
541
542
543
544
545
546
547
@classmethod
def text_message_output(cls, message: MessageOutputItem) -> str:
    """Extracts all the text content from a single message output item."""
    text = ""
    for item in message.raw_item.content:
        if isinstance(item, ResponseOutputText):
            text += item.text
    return text

tool_call_output_item classmethod 

tool_call_output_item(
    tool_call: ResponseFunctionToolCall, output: Any
) -> FunctionCallOutput

Creates a tool call output item from a tool call and its output.

Accepts either plain values (stringified) or structured outputs using input_text/input_image/input_file shapes. Structured outputs may be provided as Pydantic models or dicts, or an iterable of such items.

Source code in src/agents/items.py 
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
@classmethod
def tool_call_output_item(
    cls, tool_call: ResponseFunctionToolCall, output: Any
) -> FunctionCallOutput:
    """Creates a tool call output item from a tool call and its output.

    Accepts either plain values (stringified) or structured outputs using
    input_text/input_image/input_file shapes. Structured outputs may be
    provided as Pydantic models or dicts, or an iterable of such items.
    """

    converted_output = cls._convert_tool_output(output)

    return {
        "call_id": tool_call.call_id,
        "output": converted_output,
        "type": "function_call_output",
    }