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
@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
@openai/agents-openai
API
Classes
OpenAIChatCompletionsModel
OpenAIConversationsSession
OpenAIProvider
OpenAIResponsesModel
OpenAITracingExporter
Type Aliases
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
setTracingExportApiKey
function
setTracingExportApiKey
(
key
)
:
void
;
Parameters
Section titled “Parameters”
Parameter
Type
key
string
Returns
Section titled “Returns”
void