Skip to content
OpenAI Agents SDK
Search
Ctrl
K
Cancel
Python SDK
Select theme
Dark
Light
Auto
Select language
English
日本語
中文
한국어
Overview
Quickstart
Guides
Agents
Running Agents
Results
Tools
Orchestrating multiple agents
Handoffs
Context management
Sessions
Models
Guardrails
Streaming
Human-in-the-loop
Model Context Protocol (MCP)
Tracing
Configuring the SDK
Troubleshooting
Release process
Voice Agents
Overview
Quickstart
Building Voice Agents
Transport Mechanisms
Extensions
Use any model with the AI SDK
Connect Realtime Agents to Twilio
Cloudflare Workers Transport
API Reference
@openai/agents
Main API
Classes
Agent
AgentHooks
AgentsError
BatchTraceProcessor
ConsoleSpanExporter
GuardrailExecutionError
Handoff
InputGuardrailTripwireTriggered
MaxTurnsExceededError
MCPServers
MCPServerSSE
MCPServerStdio
MCPServerStreamableHttp
MemorySession
ModelBehaviorError
NoopSpan
NoopTrace
OpenAIChatCompletionsModel
OpenAIConversationsSession
OpenAIProvider
OpenAIResponsesCompactionSession
OpenAIResponsesModel
OpenAITracingExporter
OutputGuardrailTripwireTriggered
RequestUsage
RunAgentUpdatedStreamEvent
RunContext
RunHandoffCallItem
RunHandoffOutputItem
RunItemStreamEvent
RunMessageOutputItem
Runner
RunRawModelStreamEvent
RunReasoningItem
RunResult
RunState
RunToolApprovalItem
RunToolCallItem
RunToolCallOutputItem
Span
StreamedRunResult
SystemError
ToolCallError
ToolInputGuardrailTripwireTriggered
ToolOutputGuardrailTripwireTriggered
Trace
TraceProvider
Usage
UserError
Interfaces
AgentConfiguration
Editor
GuardrailFunctionOutput
InputGuardrail
InputGuardrailFunctionArgs
InputGuardrailMetadata
InputGuardrailResult
MCPServer
MCPToolFilterContext
MCPToolFilterStatic
Model
ModelProvider
OpenAIResponsesCompactionAwareSession
OutputGuardrail
OutputGuardrailDefinition
OutputGuardrailFunctionArgs
OutputGuardrailMetadata
OutputGuardrailResult
Session
Shell
ToolGuardrailFunctionOutput
ToolGuardrailMetadata
ToolInputGuardrailData
ToolInputGuardrailDefinition
ToolInputGuardrailResult
ToolOutputGuardrailData
ToolOutputGuardrailDefinition
ToolOutputGuardrailResult
TracingExporter
TracingProcessor
Type Aliases
AgentConfigWithHandoffs
AgentInputItem
AgentOptions
AgentOutputItem
AgentOutputType
AgentSpanData
ApplyPatchCallItem
ApplyPatchCallItem
ApplyPatchCallResultItem
ApplyPatchCallResultItem
ApplyPatchOperation
ApplyPatchOperation
ApplyPatchResult
ApplyPatchTool
AssistantMessageItem
AssistantMessageItem
CallModelInputFilter
CallModelInputFilterArgs
Computer
ComputerCallResultItem
ComputerCallResultItem
ComputerTool
ComputerUseCallItem
ComputerUseCallItem
CustomSpanData
FunctionCallItem
FunctionCallItem
FunctionCallResultItem
FunctionCallResultItem
FunctionSpanData
FunctionTool
FunctionToolResult
GenerationSpanData
GetAllMcpToolsOptions
GuardrailSpanData
HandoffEnabledFunction
HandoffInputData
HandoffSpanData
HostedMCPTool
HostedTool
HostedToolCallItem
HostedToolCallItem
IndividualRunOptions
InputGuardrailFunction
JsonSchemaDefinition
MCPListToolsSpanData
MCPServersOptions
MCPServersReconnectOptions
MCPToolCacheKeyGenerator
MCPToolFilterCallable
ModelInputData
ModelRequest
ModelResponse
ModelSettings
ModelSettingsToolChoice
NonStreamRunOptions
OpenAIConversationsSessionOptions
OpenAIResponsesCompactionArgs
OpenAIResponsesCompactionDecisionContext
OpenAIResponsesCompactionMode
OpenAIResponsesCompactionResult
OpenAIResponsesCompactionSessionOptions
OpenAITracingExporterOptions
OutputGuardrailFunction
ReasoningItem
ReasoningItem
ResponseSpanData
ResponseStreamEvent
RunConfig
RunErrorData
RunErrorHandler
RunErrorHandlerInput
RunErrorHandlerResult
RunErrorHandlers
RunErrorKind
RunItem
RunStreamEvent
SerializedHandoff
SerializedOutputType
SerializedTool
SessionInputCallback
ShellAction
ShellCallItem
ShellCallItem
ShellCallResultItem
ShellCallResultItem
ShellOutputResult
ShellResult
ShellTool
SpanData
SpanError
SpanOptions
SpeechGroupSpanData
SpeechSpanData
StreamEvent
StreamEvent
StreamEventGenericItem
StreamEventGenericItem
StreamEventResponseCompleted
StreamEventResponseCompleted
StreamEventResponseStarted
StreamEventResponseStarted
StreamEventTextStream
StreamEventTextStream
StreamRunOptions
SystemMessageItem
TextOutput
Tool
ToolCallOutputContent
ToolCallOutputContent
ToolCallStructuredOutput
ToolCallStructuredOutput
ToolEnabledFunction
ToolExecuteArgument
ToolGuardrailBehavior
ToolInputGuardrailFunction
ToolInputParameters
ToolOptions
ToolOptionsWithGuardrails
ToolOutputFileContent
ToolOutputFileContent
ToolOutputGuardrailFunction
ToolOutputImage
ToolOutputImage
ToolOutputText
ToolOutputText
ToolsToFinalOutputResult
ToolToFinalOutputFunction
ToolUseBehavior
ToolUseBehaviorFlags
TracingConfig
TranscriptionSpanData
UnknownContext
UnknownItem
UnknownItem
UserMessageItem
UserMessageItem
Variables
OPENAI_DEFAULT_MODEL_ENV_VARIABLE_NAME
RuntimeEventEmitter
ToolGuardrailFunctionOutputFactory
withAgentSpan
withCustomSpan
withFunctionSpan
withGenerationSpan
withGuardrailSpan
withHandoffSpan
withMCPListToolsSpan
withResponseSpan
withSpeechGroupSpan
withSpeechSpan
withTranscriptionSpan
Functions
addTraceProcessor
applyDiff
applyPatchTool
assistant
codeInterpreterTool
computerTool
connectMcpServers
createAgentSpan
createCustomSpan
createFunctionSpan
createGenerationSpan
createGuardrailSpan
createHandoffSpan
createMCPListToolsSpan
createMCPToolStaticFilter
createResponseSpan
createSpeechGroupSpan
createSpeechSpan
createTranscriptionSpan
defineOutputGuardrail
defineToolInputGuardrail
defineToolOutputGuardrail
extractAllTextOutput
fileSearchTool
generateGroupId
generateSpanId
generateTraceId
getAllMcpTools
getCurrentSpan
getCurrentTrace
getDefaultModel
getDefaultModelSettings
getGlobalTraceProvider
getHandoff
getLogger
getOrCreateTrace
getTransferMessage
gpt5ReasoningSettingsRequired
handoff
hostedMcpTool
imageGenerationTool
invalidateServerToolsCache
isGpt5Default
isOpenAIResponsesCompactionAwareSession
mcpToFunctionTool
resetCurrentSpan
resolveToolInputGuardrails
resolveToolOutputGuardrails
run
runToolInputGuardrails
runToolOutputGuardrails
setCurrentSpan
setDefaultModelProvider
setDefaultOpenAIClient
setDefaultOpenAIKey
setDefaultOpenAITracingExporter
setOpenAIAPI
setTraceProcessors
setTracingDisabled
setTracingExportApiKey
shellTool
startOpenAIConversationsSession
startTraceExportLoop
system
tool
user
webSearchTool
withTrace
@openai/agents/realtime
Classes
ModelBehaviorError
OpenAIRealtimeBase
OpenAIRealtimeSIP
OpenAIRealtimeWebRTC
OpenAIRealtimeWebSocket
OutputGuardrailTripwireTriggered
RealtimeAgent
RealtimeSession
UserError
Interfaces
RealtimeOutputGuardrail
RealtimeTransportLayer
Type Aliases
ApiKey
FunctionTool
OpenAIRealtimeBaseOptions
OpenAIRealtimeEventTypes
OpenAIRealtimeModels
OpenAIRealtimeWebRTCOptions
OpenAIRealtimeWebSocketOptions
RealtimeAgentConfiguration
RealtimeAudioFormat
RealtimeBaseItem
RealtimeClientMessage
RealtimeContextData
RealtimeItem
RealtimeMcpCallItem
RealtimeMessageItem
RealtimeSessionConfig
RealtimeSessionConnectOptions
RealtimeSessionEventTypes
RealtimeSessionOptions
RealtimeSessionPayload
RealtimeToolCallItem
RealtimeTransportEventTypes
RealtimeTransportLayerConnectOptions
TransportError
TransportEvent
TransportLayerAudio
TransportLayerResponseCompleted
TransportLayerResponseStarted
TransportLayerTranscriptDelta
TransportToolCallEvent
WebRTCState
WebSocketState
Variables
DEFAULT_OPENAI_REALTIME_MODEL
DEFAULT_OPENAI_REALTIME_SESSION_CONFIG
utils
Functions
backgroundResult
isBackgroundResult
tool
@openai/agents-core
API
Classes
Agent
AgentHooks
AgentsError
BatchTraceProcessor
ConsoleSpanExporter
GuardrailExecutionError
Handoff
InputGuardrailTripwireTriggered
MaxTurnsExceededError
MCPServers
MCPServerSSE
MCPServerStdio
MCPServerStreamableHttp
MemorySession
ModelBehaviorError
NoopSpan
NoopTrace
OutputGuardrailTripwireTriggered
RequestUsage
RunAgentUpdatedStreamEvent
RunContext
RunHandoffCallItem
RunHandoffOutputItem
RunItemStreamEvent
RunMessageOutputItem
Runner
RunRawModelStreamEvent
RunReasoningItem
RunResult
RunState
RuntimeEventEmitter
RunToolApprovalItem
RunToolCallItem
RunToolCallOutputItem
Span
StreamedRunResult
SystemError
ToolCallError
ToolInputGuardrailTripwireTriggered
ToolOutputGuardrailTripwireTriggered
Trace
TraceProvider
Usage
UserError
Interfaces
AgentConfiguration
Editor
GuardrailFunctionOutput
InputGuardrail
InputGuardrailFunctionArgs
InputGuardrailMetadata
InputGuardrailResult
MCPServer
MCPToolFilterContext
MCPToolFilterStatic
Model
ModelProvider
OpenAIResponsesCompactionAwareSession
OutputGuardrail
OutputGuardrailDefinition
OutputGuardrailFunctionArgs
OutputGuardrailMetadata
OutputGuardrailResult
Session
Shell
ToolGuardrailFunctionOutput
ToolGuardrailMetadata
ToolInputGuardrailData
ToolInputGuardrailDefinition
ToolInputGuardrailResult
ToolOutputGuardrailData
ToolOutputGuardrailDefinition
ToolOutputGuardrailResult
TracingExporter
TracingProcessor
Type Aliases
AgentConfigWithHandoffs
AgentInputItem
AgentOptions
AgentOutputItem
AgentOutputType
AgentSpanData
ApplyPatchCallItem
ApplyPatchCallItem
ApplyPatchCallResultItem
ApplyPatchCallResultItem
ApplyPatchOperation
ApplyPatchResult
ApplyPatchTool
AssistantMessageItem
AssistantMessageItem
CallModelInputFilter
CallModelInputFilterArgs
Computer
ComputerCallResultItem
ComputerCallResultItem
ComputerTool
ComputerUseCallItem
ComputerUseCallItem
CustomSpanData
FunctionCallItem
FunctionCallItem
FunctionCallResultItem
FunctionCallResultItem
FunctionSpanData
FunctionTool
FunctionToolResult
GenerationSpanData
GetAllMcpToolsOptions
GuardrailSpanData
HandoffEnabledFunction
HandoffInputData
HandoffSpanData
HostedMCPTool
HostedTool
HostedToolCallItem
HostedToolCallItem
IndividualRunOptions
InputGuardrailFunction
JsonSchemaDefinition
MCPListToolsSpanData
MCPServersOptions
MCPServersReconnectOptions
MCPToolCacheKeyGenerator
MCPToolFilterCallable
ModelInputData
ModelRequest
ModelResponse
ModelSettings
ModelSettingsToolChoice
NonStreamRunOptions
OpenAIResponsesCompactionArgs
OpenAIResponsesCompactionResult
OutputGuardrailFunction
ReasoningItem
ReasoningItem
ResponseSpanData
ResponseStreamEvent
RunConfig
RunErrorData
RunErrorHandler
RunErrorHandlerInput
RunErrorHandlerResult
RunErrorHandlers
RunErrorKind
RunItem
RunStreamEvent
SerializedHandoff
SerializedOutputType
SerializedTool
SessionInputCallback
ShellAction
ShellCallItem
ShellCallItem
ShellCallResultItem
ShellCallResultItem
ShellOutputResult
ShellResult
ShellTool
SpanData
SpanError
SpanOptions
SpeechGroupSpanData
SpeechSpanData
StreamEvent
StreamEvent
StreamEventGenericItem
StreamEventGenericItem
StreamEventResponseCompleted
StreamEventResponseCompleted
StreamEventResponseStarted
StreamEventResponseStarted
StreamEventTextStream
StreamEventTextStream
StreamRunOptions
SystemMessageItem
TextOutput
Tool
ToolCallOutputContent
ToolCallOutputContent
ToolCallStructuredOutput
ToolCallStructuredOutput
ToolEnabledFunction
ToolExecuteArgument
ToolGuardrailBehavior
ToolInputGuardrailFunction
ToolInputParameters
ToolOptions
ToolOptionsWithGuardrails
ToolOutputFileContent
ToolOutputFileContent
ToolOutputGuardrailFunction
ToolOutputImage
ToolOutputImage
ToolOutputText
ToolOutputText
ToolsToFinalOutputResult
ToolToFinalOutputFunction
ToolUseBehavior
ToolUseBehaviorFlags
TracingConfig
TranscriptionSpanData
UnknownContext
UnknownItem
UnknownItem
UserMessageItem
UserMessageItem
Variables
ApplyPatchOperation
OPENAI_DEFAULT_MODEL_ENV_VARIABLE_NAME
ToolGuardrailFunctionOutputFactory
withAgentSpan
withCustomSpan
withFunctionSpan
withGenerationSpan
withGuardrailSpan
withHandoffSpan
withMCPListToolsSpan
withResponseSpan
withSpeechGroupSpan
withSpeechSpan
withTranscriptionSpan
Functions
addTraceProcessor
applyDiff
applyPatchTool
assistant
computerTool
connectMcpServers
createAgentSpan
createCustomSpan
createFunctionSpan
createGenerationSpan
createGuardrailSpan
createHandoffSpan
createMCPListToolsSpan
createMCPToolStaticFilter
createResponseSpan
createSpeechGroupSpan
createSpeechSpan
createTranscriptionSpan
defineOutputGuardrail
defineToolInputGuardrail
defineToolOutputGuardrail
extractAllTextOutput
generateGroupId
generateSpanId
generateTraceId
getAllMcpTools
getCurrentSpan
getCurrentTrace
getDefaultModel
getDefaultModelSettings
getGlobalTraceProvider
getHandoff
getLogger
getOrCreateTrace
getTransferMessage
gpt5ReasoningSettingsRequired
handoff
hostedMcpTool
invalidateServerToolsCache
isGpt5Default
isOpenAIResponsesCompactionAwareSession
mcpToFunctionTool
resetCurrentSpan
resolveToolInputGuardrails
resolveToolOutputGuardrails
run
runToolInputGuardrails
runToolOutputGuardrails
setCurrentSpan
setDefaultModelProvider
setTraceProcessors
setTracingDisabled
shellTool
startTraceExportLoop
system
tool
user
withTrace
@openai/agents-openai
API
Classes
OpenAIChatCompletionsModel
OpenAIConversationsSession
OpenAIProvider
OpenAIResponsesCompactionSession
OpenAIResponsesModel
OpenAITracingExporter
Type Aliases
OpenAIConversationsSessionOptions
OpenAIResponsesCompactionDecisionContext
OpenAIResponsesCompactionMode
OpenAIResponsesCompactionSessionOptions
OpenAITracingExporterOptions
Functions
codeInterpreterTool
fileSearchTool
imageGenerationTool
setDefaultOpenAIClient
setDefaultOpenAIKey
setDefaultOpenAITracingExporter
setOpenAIAPI
setTracingExportApiKey
startOpenAIConversationsSession
webSearchTool
@openai/agents-realtime
API
Classes
ModelBehaviorError
OpenAIRealtimeBase
OpenAIRealtimeSIP
OpenAIRealtimeWebRTC
OpenAIRealtimeWebSocket
OutputGuardrailTripwireTriggered
RealtimeAgent
RealtimeSession
UserError
Interfaces
RealtimeOutputGuardrail
RealtimeTransportLayer
Type Aliases
ApiKey
FunctionTool
OpenAIRealtimeBaseOptions
OpenAIRealtimeEventTypes
OpenAIRealtimeModels
OpenAIRealtimeWebRTCOptions
OpenAIRealtimeWebSocketOptions
RealtimeAgentConfiguration
RealtimeAudioFormat
RealtimeBaseItem
RealtimeClientMessage
RealtimeContextData
RealtimeItem
RealtimeMcpCallItem
RealtimeMessageItem
RealtimeSessionConfig
RealtimeSessionConnectOptions
RealtimeSessionEventTypes
RealtimeSessionOptions
RealtimeSessionPayload
RealtimeToolCallItem
RealtimeTransportEventTypes
RealtimeTransportLayerConnectOptions
TransportError
TransportEvent
TransportLayerAudio
TransportLayerResponseCompleted
TransportLayerResponseStarted
TransportLayerTranscriptDelta
TransportToolCallEvent
WebRTCState
WebSocketState
Variables
DEFAULT_OPENAI_REALTIME_MODEL
DEFAULT_OPENAI_REALTIME_SESSION_CONFIG
utils
Functions
backgroundResult
isBackgroundResult
tool
@openai/agents-extensions
API
Classes
AiSdkModel
CloudflareRealtimeTransportLayer
TwilioRealtimeTransportLayer
Type Aliases
TwilioRealtimeTransportLayerOptions
Functions
aisdk
parseArguments
toolChoiceToLanguageV2Format
Python SDK
View on GitHub
View on npm
Select theme
Dark
Light
Auto
Select language
English
日本語
中文
한국어
View on GitHub
View on npm
RunErrorKind
type
RunErrorKind
=
"maxTurns"
;
Error kinds supported by run error handlers.