Skip to content

Tools

Bases: BaseTools

Tool registry for the OpenAI Realtime API.

This is the user-facing tools class for RealtimeAgent.

action

action(
    description: str,
    name: str | None = None,
    result_instruction: str | None = None,
    holding_instruction: str | None = None,
) -> Callable

Register a function as a realtime tool.

Parameters:

Name Type Description Default
description str

Natural-language description shown to the model.

required
name str | None

Optional tool name override.

None
result_instruction str | None

Optional instruction for result phrasing.

None
holding_instruction str | None

Optional speech instruction while a delegated subagent runs in the background.

None

Bases: BaseTools

Tool registry for non-realtime (text) agents such as SubAgent.