@openai/agents-core/dist/index.d.ts

The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows.

export { RuntimeEventEmitter } from '@openai/agents-core/_shims';
export { Agent, AgentConfiguration, AgentConfigWithHandoffs, AgentOptions, AgentOutputType, ToolsToFinalOutputResult, ToolToFinalOutputFunction, ToolUseBehavior, ToolUseBehaviorFlags, } from './agent';
export type { AgentTool, AgentToolOptions, AgentToolOptionsWithDefault, AgentToolOptionsWithParameters, CompletedAgentToolInvocationRunResult, } from './agent';
export { Computer } from './computer';
export { ShellAction, ShellResult, ShellOutputResult, Shell } from './shell';
export { ApplyPatchOperation, ApplyPatchResult, Editor, EditorInvocationContext, } from './editor';
export { AgentsError, GuardrailExecutionError, InputGuardrailTripwireTriggered, InvalidToolOutputError, MaxTurnsExceededError, ModelBehaviorError, ModelRefusalError, ModelTimeoutError, OutputGuardrailTripwireTriggered, ToolInputGuardrailTripwireTriggered, ToolOutputGuardrailTripwireTriggered, ToolCallError, ToolTimeoutError, UserError, SystemError, } from './errors';
export type { ToolOutputErrorContext } from './errors';
export { RunAgentUpdatedStreamEvent, RunRawModelStreamEvent, RunItemStreamEvent, RunStreamEvent, } from './events';
export { defineOutputGuardrail, GuardrailFunctionOutput, InputGuardrail, InputGuardrailFunction, InputGuardrailFunctionArgs, InputGuardrailMetadata, InputGuardrailResult, OutputGuardrail, OutputGuardrailDefinition, OutputGuardrailFunction, OutputGuardrailFunctionArgs, OutputGuardrailMetadata, OutputGuardrailResult, } from './guardrail';
export { ToolGuardrailBehavior, ToolGuardrailFunctionOutput, ToolGuardrailMetadata, ToolInputGuardrailData, ToolInputGuardrailDefinition, ToolInputGuardrailFunction, ToolInputGuardrailResult, ToolOutputGuardrailData, ToolOutputGuardrailDefinition, ToolOutputGuardrailFunction, ToolOutputGuardrailResult, ToolGuardrailFunctionOutputFactory, defineToolInputGuardrail, defineToolOutputGuardrail, resolveToolInputGuardrails, resolveToolOutputGuardrails, } from './toolGuardrail';
export { getHandoff, getTransferMessage, Handoff, HandoffCloneOptions, handoff, HandoffInputData, HandoffEnabledFunction, } from './handoff';
export { assistant, system, user } from './helpers/message';
export { extractAllTextOutput, RunCompactionItem, RunInputItem, RunHandoffCallItem, RunHandoffOutputItem, RunItem, RunMessageOutputItem, RunReasoningItem, RunToolApprovalItem, RunToolCallItem, RunToolCallOutputItem, RunToolSearchCallItem, RunToolSearchOutputItem, } from './items';
export { AgentHooks } from './lifecycle';
export type { AgentHookEvents, RunHookEvents } from './lifecycle';
export { getLogger } from './logger';
export { setSensitiveDataLoggingEnabled } from './config';
export { applyDiff } from './utils/applyDiff';
export { getAllMcpTools, invalidateServerToolsCache, mcpToFunctionTool, MCPCallToolOptions, MCPBlobResourceContent, CallToolResult, CallToolResultContent, MCPListResourcesParams, MCPListResourcesResult, MCPListResourceTemplatesResult, MCPReadResourceResult, MCPResource, MCPResourceContent, MCPResourceTemplate, MCPServer, MCPServerWithResources, MCPServerStdio, MCPServerStreamableHttp, MCPServerSSE, MCPTextResourceContent, GetAllMcpToolsOptions, MCPToolCacheKeyGenerator, MCPToolErrorFunction, } from './mcp';
export { MCPServers, MCPServersOptions, MCPServersReconnectOptions, connectMcpServers, } from './mcpServers';
export { MCPToolFilterCallable, MCPToolFilterContext, MCPToolFilterStatic, MCPToolCustomDataContext, MCPToolCustomDataExtractor, MCPToolMetaContext, MCPToolMetaResolver, createMCPToolStaticFilter, } from './mcpUtil';
export { Model, ModelProvider, ModelRetryAdvice, ModelRetryAdviceRequest, ModelRetryBackoffSettings, ModelRetryNormalizedError, ModelRetrySettings, ModelRequest, ModelResponse, ModelSettings, ModelSettingsContextManagement, ModelSettingsToolChoice, RetryDecision, RetryPolicy, RetryPolicyContext, SerializedHandoff, SerializedTool, SerializedOutputType, } from './model';
export { OPENAI_DEFAULT_MODEL_ENV_VARIABLE_NAME, gpt5ReasoningSettingsRequired, getDefaultModel, getDefaultModelSettings, isGpt5Default, } from './defaultModel';
export { setDefaultModelProvider } from './providers';
export { retryPolicies } from './runner/modelRetry';
export { RunResult, StreamedRunResult } from './result';
export { IndividualRunOptions, NonStreamRunOptions, run, RunConfig, Runner, StreamRunOptions, } from './run';
export type { ModelInputData, CallModelInputFilter, CallModelInputFilterArgs, ToolErrorFormatter, ToolErrorFormatterArgs, OutputGuardrailBlockedMessageArgs, OutputGuardrailBlockedMessageFormatter, ToolExecutionConfig, ToolNameCollisionPolicy, ToolNotFoundBehavior, ToolErrorKind, ReasoningItemIdPolicy, RunErrorData, RunErrorHandler, RunErrorHandlerInput, RunErrorHandlerResult, RunErrorHandlers, RunErrorKind, } from './run';
export { RunContext } from './runContext';
export type { AgentToolInvocation } from './agentToolInvocation';
export { RunState } from './runState';
export type { TracingConfig } from './tracing';
export { HostedTool, attachClientToolSearchExecutor, ComputerTool, computerTool, ShellTool, shellTool, ApplyPatchTool, applyPatchTool, HostedMCPTool, hostedMcpTool, FunctionTool, FunctionToolResult, FunctionToolTimeoutBehavior, ToolTimeoutErrorFunction, Tool, tool, toolNamespace, invokeFunctionTool, getClientToolSearchExecutor, getToolSearchRuntimeToolKey, ToolExecuteArgument, ToolEnabledFunction, ToolOptionsWithGuardrails, ToolAllowedCaller, ToolAllowedCallers, } from './tool';
export type { StandardSchemaWithJSON } from './utils/standardSchema';
export type { ClientToolSearchExecutor, ClientToolSearchExecutorArgs, ClientToolSearchExecutorResult, ComputerOnSafetyCheckFunction, ComputerSafetyCheck, ComputerSafetyCheckResult, ShellToolEnvironment, ShellToolLocalEnvironment, ShellToolLocalSkill, ShellToolHostedEnvironment, ShellToolContainerAutoEnvironment, ShellToolContainerReferenceEnvironment, ShellToolContainerSkill, ShellToolSkillReference, ShellToolInlineSkill, ShellToolInlineSkillSource, ShellToolContainerNetworkPolicy, ShellToolContainerNetworkPolicyAllowlist, ShellToolContainerNetworkPolicyDisabled, ShellToolContainerNetworkPolicyDomainSecret, ToolInputParameters, ToolOutputSchema, ToolOptions, ToolNamespaceOptions, ToolOutputCustomData, FunctionToolCustomDataContext, FunctionToolCustomDataExtractor, ComputerToolCustomDataContext, ComputerToolCustomDataExtractor, ApplyPatchToolCustomDataContext, ApplyPatchToolCustomDataExtractor, } from './tool';
export type { ToolOutputText, ToolOutputImage, ToolOutputFileContent, ToolCallStructuredOutput, ToolCallOutputContent, } from './types/protocol';
export * from './tracing';
export { getGlobalTraceProvider, TraceProvider } from './tracing/provider';
export { runToolInputGuardrails, runToolOutputGuardrails, } from './utils/toolGuardrails';
export type { AgentInputItem, AgentOutputItem, AssistantMessageItem, HostedToolCallItem, ComputerCallResultItem, ComputerUseCallItem, ShellCallItem, ShellCallResultItem, ApplyPatchCallItem, ApplyPatchCallResultItem, ProgramCallItem, ProgramCallResultItem, ToolCaller, FunctionCallItem, FunctionCallResultItem, JsonSchemaDefinition, ReasoningItem, ToolReference, ToolSearchOutputTool, ToolSearchCallArguments, ToolSearchCallItem, ToolSearchOutputItem, ResponseStreamEvent, SystemMessageItem, TextOutput, UnknownContext, UnknownItem, UserMessageItem, StreamEvent, StreamEventTextStream, StreamEventResponseCompleted, StreamEventResponseStarted, StreamEventGenericItem, } from './types';
export { RequestUsage, Usage } from './usage';
export type { TokenDetails } from './types/protocol';
export type { RequestUsageInput, UsageInput } from './usage';
export type { Session, RunContextAwareSession, SessionInputCallback, SessionHistoryMutation, SessionHistoryRewriteArgs, SessionHistoryRewriteAwareSession, SessionHistoryAppendItemsTransaction, SessionHistoryReplaceSuffixTransaction, SessionHistoryTransaction, SessionHistoryTransactionArgs, SessionHistoryTransactionAwareSession, OpenAIResponsesCompactionArgs, OpenAIResponsesCompactionAwareSession, OpenAIResponsesCompactionOwnershipAwareSession, OpenAIResponsesCompactionResult, } from './memory/session';
export { isOpenAIResponsesCompactionAwareSession, isOpenAIResponsesCompactionOwnershipAwareSession, isRunContextAwareSession, isSessionHistoryRewriteAwareSession, isSessionHistoryTransactionAwareSession, } from './memory/session';
export { applySessionHistoryMutations } from './memory/historyMutations';
export { MemorySession } from './memory/memorySession';
/**
 * Exporting the whole protocol as an object here. This contains both the types
 * and the zod schemas for parsing the protocol.
 */
export * as protocol from './types/protocol';