@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 { Computer } from './computer';
export { AgentsError, GuardrailExecutionError, InputGuardrailTripwireTriggered, MaxTurnsExceededError, ModelBehaviorError, OutputGuardrailTripwireTriggered, ToolCallError, UserError, SystemError, } 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 { getHandoff, getTransferMessage, Handoff, handoff, HandoffInputData, HandoffEnabledFunction, } from './handoff';
export { assistant, system, user } from './helpers/message';
export { extractAllTextOutput, RunHandoffCallItem, RunHandoffOutputItem, RunItem, RunMessageOutputItem, RunReasoningItem, RunToolApprovalItem, RunToolCallItem, RunToolCallOutputItem, } from './items';
export { AgentHooks } from './lifecycle';
export { getLogger } from './logger';
export { getAllMcpTools, invalidateServerToolsCache, mcpToFunctionTool, MCPServer, MCPServerStdio, MCPServerStreamableHttp, MCPServerSSE, GetAllMcpToolsOptions, } from './mcp';
export { MCPToolFilterCallable, MCPToolFilterContext, MCPToolFilterStatic, createMCPToolStaticFilter, } from './mcpUtil';
export { Model, ModelProvider, ModelRequest, ModelResponse, ModelSettings, ModelSettingsToolChoice, SerializedHandoff, SerializedTool, SerializedOutputType, } from './model';
export { OPENAI_DEFAULT_MODEL_ENV_VARIABLE_NAME, gpt5ReasoningSettingsRequired, getDefaultModel, getDefaultModelSettings, isGpt5Default, } from './defaultModel';
export { setDefaultModelProvider } from './providers';
export { RunResult, StreamedRunResult } from './result';
export { IndividualRunOptions, NonStreamRunOptions, run, RunConfig, Runner, StreamRunOptions, } from './run';
export type { ModelInputData, CallModelInputFilter, CallModelInputFilterArgs, } from './run';
export { RunContext } from './runContext';
export { RunState } from './runState';
export { HostedTool, ComputerTool, computerTool, HostedMCPTool, hostedMcpTool, FunctionTool, FunctionToolResult, Tool, tool, ToolExecuteArgument, ToolEnabledFunction, } from './tool';
export type { ToolOutputText, ToolOutputImage, ToolOutputFileContent, ToolCallStructuredOutput, ToolCallOutputContent, } from './types/protocol';
export * from './tracing';
export { getGlobalTraceProvider, TraceProvider } from './tracing/provider';
export type { AgentInputItem, AgentOutputItem, AssistantMessageItem, HostedToolCallItem, ComputerCallResultItem, ComputerUseCallItem, FunctionCallItem, FunctionCallResultItem, JsonSchemaDefinition, ReasoningItem, ResponseStreamEvent, SystemMessageItem, TextOutput, UnknownContext, UnknownItem, UserMessageItem, StreamEvent, StreamEventTextStream, StreamEventResponseCompleted, StreamEventResponseStarted, StreamEventGenericItem, } from './types';
export { Usage } from './usage';
export type { Session, SessionInputCallback } from './memory/session';
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';