@openai/agents-core
Namespaces
Section titled “Namespaces”Classes
Section titled “Classes”- Agent
- AgentHooks
- AgentsError
- BatchTraceProcessor
- ConsoleSpanExporter
- GuardrailExecutionError
- Handoff
- InputGuardrailTripwireTriggered
- MaxTurnsExceededError
- 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
- Trace
- TraceProvider
- Usage
- UserError
Interfaces
Section titled “Interfaces”- AgentConfiguration
- Editor
- GuardrailFunctionOutput
- InputGuardrail
- InputGuardrailFunctionArgs
- InputGuardrailMetadata
- InputGuardrailResult
- MCPServer
- MCPToolFilterContext
- MCPToolFilterStatic
- Model
- ModelProvider
- OpenAIResponsesCompactionAwareSession
- OutputGuardrail
- OutputGuardrailDefinition
- OutputGuardrailFunctionArgs
- OutputGuardrailMetadata
- OutputGuardrailResult
- Session
- Shell
- TracingExporter
- TracingProcessor
Type Aliases
Section titled “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
- MCPToolCacheKeyGenerator
- MCPToolFilterCallable
- ModelInputData
- ModelRequest
- ModelResponse
- ModelSettings
- ModelSettingsToolChoice
- NonStreamRunOptions
- OpenAIResponsesCompactionArgs
- OpenAIResponsesCompactionResult
- OutputGuardrailFunction
- ReasoningItem
- ReasoningItem
- ResponseSpanData
- ResponseStreamEvent
- RunConfig
- 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
- ToolInputParameters
- ToolOptions
- ToolOutputFileContent
- ToolOutputFileContent
- ToolOutputImage
- ToolOutputImage
- ToolOutputText
- ToolOutputText
- ToolsToFinalOutputResult
- ToolToFinalOutputFunction
- ToolUseBehavior
- ToolUseBehaviorFlags
- TranscriptionSpanData
- UnknownContext
- UnknownItem
- UnknownItem
- UserMessageItem
- UserMessageItem
Variables
Section titled “Variables”- ApplyPatchOperation
- OPENAI_DEFAULT_MODEL_ENV_VARIABLE_NAME
- withAgentSpan
- withCustomSpan
- withFunctionSpan
- withGenerationSpan
- withGuardrailSpan
- withHandoffSpan
- withMCPListToolsSpan
- withResponseSpan
- withSpeechGroupSpan
- withSpeechSpan
- withTranscriptionSpan
Functions
Section titled “Functions”- addTraceProcessor
- applyDiff
- applyPatchTool
- assistant
- computerTool
- createAgentSpan
- createCustomSpan
- createFunctionSpan
- createGenerationSpan
- createGuardrailSpan
- createHandoffSpan
- createMCPListToolsSpan
- createMCPToolStaticFilter
- createResponseSpan
- createSpeechGroupSpan
- createSpeechSpan
- createTranscriptionSpan
- defineOutputGuardrail
- extractAllTextOutput
- generateGroupId
- generateSpanId
- generateTraceId
- getAllMcpTools
- getCurrentSpan
- getCurrentTrace
- getDefaultModel
- getDefaultModelSettings
- getGlobalTraceProvider
- getHandoff
- getLogger
- getOrCreateTrace
- getTransferMessage
- gpt5ReasoningSettingsRequired
- handoff
- hostedMcpTool
- invalidateServerToolsCache
- isGpt5Default
- isOpenAIResponsesCompactionAwareSession
- mcpToFunctionTool
- resetCurrentSpan
- run
- setCurrentSpan
- setDefaultModelProvider
- setTraceProcessors
- setTracingDisabled
- shellTool
- startTraceExportLoop
- system
- tool
- user
- withTrace