Skip to content
OpenAI Agents SDK
Search
Ctrl
K
Cancel
OpenAI on X
Agents SDK on GitHub
Agents SDK for Python
Select theme
Dark
Light
Auto
Select language
English
日本語
Overview
Quickstart
Guides
Agents
Running Agents
Results
Tools
Orchestrating multiple agents
Handoffs
Context management
Models
Guardrails
Streaming
Human-in-the-loop
Tracing
Configuring the SDK
Troubleshooting
Voice Agents
Overview
Quickstart
Building Voice Agents
Transport Mechanisms
Extensions
Use any model with the AI SDK
Connect Realtime Agents to Twilio
API Reference
@openai/agents
Main API
Classes
Agent
AgentHooks
AgentsError
BatchTraceProcessor
ConsoleSpanExporter
GuardrailExecutionError
Handoff
InputGuardrailTripwireTriggered
MaxTurnsExceededError
MCPServerStdio
ModelBehaviorError
NoopSpan
NoopTrace
OpenAIChatCompletionsModel
OpenAIProvider
OpenAIResponsesModel
OpenAITracingExporter
OutputGuardrailTripwireTriggered
RunAgentUpdatedStreamEvent
RunContext
RunHandoffCallItem
RunItemStreamEvent
RunMessageOutputItem
Runner
RunRawModelStreamEvent
RunReasoningItem
RunResult
RunState
RunToolApprovalItem
RunToolCallItem
RunToolCallOutputItem
Span
StreamedRunResult
SystemError
ToolCallError
Trace
TraceProvider
Usage
UserError
Interfaces
AgentConfiguration
GuardrailFunctionOutput
InputGuardrail
InputGuardrailFunctionArgs
InputGuardrailResult
MCPServer
Model
ModelProvider
OutputGuardrail
OutputGuardrailFunctionArgs
OutputGuardrailResult
TracingExporter
TracingProcessor
Type Aliases
AgentConfigWithHandoffs
AgentInputItem
AgentOptions
AgentOutputItem
AgentOutputType
AssistantMessageItem
Computer
ComputerCallResultItem
ComputerTool
ComputerUseCallItem
FunctionCallItem
FunctionCallResultItem
FunctionTool
FunctionToolResult
HandoffInputData
HostedTool
HostedToolCallItem
IndividualRunOptions
InputGuardrailFunction
JsonSchemaDefinition
ModelRequest
ModelResponse
ModelSettings
ModelSettingsToolChoice
NonStreamRunOptions
OpenAITracingExporterOptions
OutputGuardrailFunction
ReasoningItem
ResponseStreamEvent
RunConfig
RunItem
RunStreamEvent
SerializedHandoff
SerializedOutputType
SerializedTool
StreamEvent
StreamEventGenericItem
StreamEventResponseCompleted
StreamEventResponseStarted
StreamEventTextStream
StreamRunOptions
SystemMessageItem
TextOutput
Tool
ToolExecuteArgument
ToolsToFinalOutputResult
ToolToFinalOutputFunction
ToolUseBehavior
ToolUseBehaviorFlags
UnknownContext
UnknownItem
UserMessageItem
Variables
AssistantMessageItem
ComputerCallResultItem
ComputerUseCallItem
FunctionCallItem
FunctionCallResultItem
HostedToolCallItem
ReasoningItem
RuntimeEventEmitter
StreamEvent
StreamEventGenericItem
StreamEventResponseCompleted
StreamEventResponseStarted
StreamEventTextStream
UnknownItem
UserMessageItem
withAgentSpan
withCustomSpan
withFunctionSpan
withGenerationSpan
withGuardrailSpan
withHandoffSpan
withMCPListToolsSpan
withResponseSpan
withSpeechGroupSpan
withSpeechSpan
withTranscriptionSpan
Functions
addTraceProcessor
assistant
codeInterpreterTool
computerTool
createAgentSpan
createCustomSpan
createFunctionSpan
createGenerationSpan
createGuardrailSpan
createHandoffSpan
createMCPListToolsSpan
createResponseSpan
createSpeechGroupSpan
createSpeechSpan
createTranscriptionSpan
extractAllTextOutput
fileSearchTool
generateGroupId
generateSpanId
generateTraceId
getAllMcpTools
getCurrentSpan
getCurrentTrace
getGlobalTraceProvider
getHandoff
getLogger
getOrCreateTrace
getTransferMessage
handoff
imageGenerationTool
invalidateServerToolsCache
resetCurrentSpan
run
setCurrentSpan
setDefaultModelProvider
setDefaultOpenAIClient
setDefaultOpenAIKey
setDefaultOpenAITracingExporter
setOpenAIAPI
setTraceProcessors
setTracingDisabled
setTracingExportApiKey
system
tool
user
webSearchTool
withTrace
References
defineOutputGuardrail
InputGuardrailMetadata
OutputGuardrailDefinition
OutputGuardrailMetadata
@openai/agents/realtime
Classes
ModelBehaviorError
OpenAIRealtimeBase
OpenAIRealtimeWebRTC
OpenAIRealtimeWebSocket
OutputGuardrailTripwireTriggered
RealtimeAgent
RealtimeSession
UserError
Interfaces
RealtimeOutputGuardrail
RealtimeTransportLayer
Type Aliases
ApiKey
FunctionTool
OpenAIRealtimeBaseOptions
OpenAIRealtimeEventTypes
OpenAIRealtimeModels
OpenAIRealtimeWebRTCOptions
OpenAIRealtimeWebSocketOptions
RealtimeAgentConfiguration
RealtimeAudioFormat
RealtimeBaseItem
RealtimeClientMessage
RealtimeContextData
RealtimeItem
RealtimeMessageItem
RealtimeSessionConfig
RealtimeSessionConnectOptions
RealtimeSessionEventTypes
RealtimeSessionOptions
RealtimeToolCallItem
RealtimeTranportEventTypes
RealtimeTransportLayerConnectOptions
TransportError
TransportEvent
TransportLayerAudio
TransportLayerResponseCompleted
TransportLayerResponseStarted
TransportLayerTranscriptDelta
TransportToolCallEvent
WebRTCState
WebSocketState
Variables
DEFAULT_OPENAI_REALTIME_MODEL
DEFAULT_OPENAI_REALTIME_SESSION_CONFIG
utils
Functions
tool
@openai/agents-core
API
Classes
Agent
AgentHooks
AgentsError
BatchTraceProcessor
ConsoleSpanExporter
GuardrailExecutionError
Handoff
InputGuardrailTripwireTriggered
MaxTurnsExceededError
MCPServerStdio
ModelBehaviorError
NoopSpan
NoopTrace
OutputGuardrailTripwireTriggered
RunAgentUpdatedStreamEvent
RunContext
RunHandoffCallItem
RunItemStreamEvent
RunMessageOutputItem
Runner
RunRawModelStreamEvent
RunReasoningItem
RunResult
RunState
RuntimeEventEmitter
RunToolApprovalItem
RunToolCallItem
RunToolCallOutputItem
Span
StreamedRunResult
SystemError
ToolCallError
Trace
TraceProvider
Usage
UserError
Interfaces
AgentConfiguration
GuardrailFunctionOutput
InputGuardrail
InputGuardrailFunctionArgs
InputGuardrailResult
MCPServer
Model
ModelProvider
OutputGuardrail
OutputGuardrailFunctionArgs
OutputGuardrailResult
TracingExporter
TracingProcessor
Type Aliases
AgentConfigWithHandoffs
AgentInputItem
AgentOptions
AgentOutputItem
AgentOutputType
AssistantMessageItem
Computer
ComputerCallResultItem
ComputerTool
ComputerUseCallItem
FunctionCallItem
FunctionCallResultItem
FunctionTool
FunctionToolResult
HandoffInputData
HostedTool
HostedToolCallItem
IndividualRunOptions
InputGuardrailFunction
JsonSchemaDefinition
ModelRequest
ModelResponse
ModelSettings
ModelSettingsToolChoice
NonStreamRunOptions
OutputGuardrailFunction
ReasoningItem
ResponseStreamEvent
RunConfig
RunItem
RunStreamEvent
SerializedHandoff
SerializedOutputType
SerializedTool
StreamEvent
StreamEventGenericItem
StreamEventResponseCompleted
StreamEventResponseStarted
StreamEventTextStream
StreamRunOptions
SystemMessageItem
TextOutput
Tool
ToolExecuteArgument
ToolsToFinalOutputResult
ToolToFinalOutputFunction
ToolUseBehavior
ToolUseBehaviorFlags
UnknownContext
UnknownItem
UserMessageItem
Variables
AssistantMessageItem
ComputerCallResultItem
ComputerUseCallItem
FunctionCallItem
FunctionCallResultItem
HostedToolCallItem
ReasoningItem
StreamEvent
StreamEventGenericItem
StreamEventResponseCompleted
StreamEventResponseStarted
StreamEventTextStream
UnknownItem
UserMessageItem
withAgentSpan
withCustomSpan
withFunctionSpan
withGenerationSpan
withGuardrailSpan
withHandoffSpan
withMCPListToolsSpan
withResponseSpan
withSpeechGroupSpan
withSpeechSpan
withTranscriptionSpan
Functions
addTraceProcessor
assistant
computerTool
createAgentSpan
createCustomSpan
createFunctionSpan
createGenerationSpan
createGuardrailSpan
createHandoffSpan
createMCPListToolsSpan
createResponseSpan
createSpeechGroupSpan
createSpeechSpan
createTranscriptionSpan
extractAllTextOutput
generateGroupId
generateSpanId
generateTraceId
getAllMcpTools
getCurrentSpan
getCurrentTrace
getGlobalTraceProvider
getHandoff
getLogger
getOrCreateTrace
getTransferMessage
handoff
invalidateServerToolsCache
resetCurrentSpan
run
setCurrentSpan
setDefaultModelProvider
setTraceProcessors
setTracingDisabled
system
tool
user
withTrace
@openai/agents-openai
API
Classes
OpenAIChatCompletionsModel
OpenAIProvider
OpenAIResponsesModel
OpenAITracingExporter
Type Aliases
OpenAITracingExporterOptions
Functions
codeInterpreterTool
fileSearchTool
imageGenerationTool
setDefaultOpenAIClient
setDefaultOpenAIKey
setDefaultOpenAITracingExporter
setOpenAIAPI
setTracingExportApiKey
webSearchTool
@openai/agents-realtime
API
Classes
ModelBehaviorError
OpenAIRealtimeBase
OpenAIRealtimeWebRTC
OpenAIRealtimeWebSocket
OutputGuardrailTripwireTriggered
RealtimeAgent
RealtimeSession
UserError
Interfaces
RealtimeOutputGuardrail
RealtimeTransportLayer
Type Aliases
ApiKey
FunctionTool
OpenAIRealtimeBaseOptions
OpenAIRealtimeEventTypes
OpenAIRealtimeModels
OpenAIRealtimeWebRTCOptions
OpenAIRealtimeWebSocketOptions
RealtimeAgentConfiguration
RealtimeAudioFormat
RealtimeBaseItem
RealtimeClientMessage
RealtimeContextData
RealtimeItem
RealtimeMessageItem
RealtimeSessionConfig
RealtimeSessionConnectOptions
RealtimeSessionEventTypes
RealtimeSessionOptions
RealtimeToolCallItem
RealtimeTranportEventTypes
RealtimeTransportLayerConnectOptions
TransportError
TransportEvent
TransportLayerAudio
TransportLayerResponseCompleted
TransportLayerResponseStarted
TransportLayerTranscriptDelta
TransportToolCallEvent
WebRTCState
WebSocketState
Variables
DEFAULT_OPENAI_REALTIME_MODEL
DEFAULT_OPENAI_REALTIME_SESSION_CONFIG
utils
Functions
tool
@openai/agents-extensions
API
Classes
AiSdkModel
TwilioRealtimeTransportLayer
Type Aliases
TwilioRealtimeTransportLayerOptions
Functions
aisdk
OpenAI on X
Agents SDK on GitHub
Agents SDK for Python
Select theme
Dark
Light
Auto
Select language
English
日本語
RealtimeBaseItem
type
RealtimeBaseItem
=
object
;
Type declaration
Section titled “Type declaration”
itemId
Section titled “itemId”
itemId: string;