エージェントの実行

エージェントはそれ自体では何もしません。Runner クラスまたは run() ユーティリティで実行します。

import { Agent, run } from '@openai/agents';

const agent = new Agent({
  name: 'Assistant',
  instructions: 'You are a helpful assistant',
});

const result = await run(
  agent,
  'Write a haiku about recursion in programming.',
);
console.log(result.finalOutput);

// Code within the code,
// Functions calling themselves,
// Infinite loop's dance.

カスタム runner が不要な場合は、run() ユーティリティも使えます。これはシングルトンのデフォルト Runner インスタンスを実行します。

または、独自の runner インスタンスを作成することもできます。

import { Agent, Runner } from '@openai/agents';

const agent = new Agent({
  name: 'Assistant',
  instructions: 'You are a helpful assistant',
});

// You can pass custom configuration to the runner
const runner = new Runner();

const result = await runner.run(
  agent,
  'Write a haiku about recursion in programming.',
);
console.log(result.finalOutput);

// Code within the code,
// Functions calling themselves,
// Infinite loop's dance.

エージェントを実行すると、最終出力と実行の完全な履歴を含む実行結果オブジェクトを受け取ります。

Runner のライフサイクルと設定

エージェントループ

Runner の run メソッドを使うときは、開始エージェントと入力を渡します。入力は文字列（ユーザーメッセージとして扱われます）か、OpenAI Responses API の項目である入力項目のリストです。

その後、runner は次のループを実行します。

現在の入力で現在のエージェントのモデルを呼び出す
LLM 応答を検査する
- 最終出力 → return
- ハンドオフ → 新しいエージェントに切り替え、蓄積した会話履歴を維持し、1 へ
- ツール呼び出し → ツールを実行し、その結果を会話に追加し、1 へ
maxTurns に達したら MaxTurnsExceededError を throw する

Runner のライフサイクル

アプリ起動時に Runner を作成し、リクエスト間で再利用してください。インスタンスには、モデルプロバイダーやトレーシングオプションなどのグローバル設定が保存されます。まったく異なる構成が必要な場合のみ、別の Runner を作成してください。単純なスクリプトなら、内部でデフォルト runner を使う run() も呼び出せます。

実行引数

run() メソッドへの入力は、実行開始に使う初期エージェント、実行用入力、オプションセットです。

入力は、文字列（ユーザーメッセージとして扱われます）、input items のリスト、または human-in-the-loop エージェントを構築している場合の RunState オブジェクトのいずれかです。

追加オプションは次のとおりです。

Option	Default	Description
`stream`	`false`	`true` の場合、呼び出しは `StreamedRunResult` を返し、モデルから到着したイベントを順次発行します
`context`	–	すべてのツール / ガードレール / ハンドオフに渡されるコンテキストオブジェクトです。詳細はコンテキスト管理ガイドを参照してください
`maxTurns`	`10`	安全上の上限です。到達時に `MaxTurnsExceededError` を throw します
`signal`	–	キャンセル用の `AbortSignal`
`session`	–	セッション永続化実装です。セッションガイドを参照してください
`sessionInputCallback`	–	セッション履歴と新規入力をマージするカスタムロジックです。モデル呼び出し前に実行されます。セッションを参照してください
`callModelInputFilter`	–	モデル呼び出し直前にモデル入力（項目 + 任意の instructions）を編集する hook です。Call model input filter を参照してください
`toolErrorFormatter`	–	モデルに返すツール承認拒否メッセージをカスタマイズする hook です。Tool error formatter を参照してください
`reasoningItemIdPolicy`	–	以前の実行項目をモデル入力に戻すときに reasoning-item の `id` を保持するか省略するかを制御します。Reasoning item ID policy を参照してください
`tracing`	–	実行単位のトレーシング設定上書き（例: export API key）
`errorHandlers`	–	サポートされる実行時エラー用のハンドラーです（現在は `maxTurns`）。Error handlers を参照してください
`conversationId`	–	サーバー側会話を再利用します（OpenAI Responses API + Conversations API のみ）
`previousResponseId`	–	会話を作成せずに前回の Responses API 呼び出しから継続します（OpenAI Responses API のみ）

ストリーミング

ストリーミングを使うと、LLM 実行中のストリーミングイベントも受け取れます。ストリーム開始後、StreamedRunResult には実行に関する完全な情報（生成されたすべての新規出力を含む）が入ります。for await ループでストリーミングイベントを反復できます。詳細はストリーミングガイドを参照してください。

実行設定

独自の Runner インスタンスを作成する場合は、RunConfig オブジェクトを渡して runner を設定できます。

Field	Type	Purpose
`model`	`string \| Model`	実行内のすべてのエージェントで特定モデルを強制します
`modelProvider`	`ModelProvider`	モデル名を解決します。デフォルトは OpenAI provider です
`modelSettings`	`ModelSettings`	エージェント単位設定を上書きするグローバル調整パラメーターです
`handoffInputFilter`	`HandoffInputFilter`	ハンドオフ時に入力項目を変更します（ハンドオフ自体に未定義の場合）
`inputGuardrails`	`InputGuardrail[]`	初期ユーザー入力に適用されるガードレール
`outputGuardrails`	`OutputGuardrail[]`	最終出力に適用されるガードレール
`tracingDisabled`	`boolean`	OpenAI Tracing を完全に無効化します
`traceIncludeSensitiveData`	`boolean`	span は発行しつつ、トレースから LLM / ツールの入出力を除外します
`workflowName`	`string`	Traces ダッシュボードに表示され、関連実行のグループ化に役立ちます
`traceId` / `groupId`	`string`	SDK 自動生成ではなく trace または group ID を手動指定します
`traceMetadata`	`Record<string, string>`	任意メタデータをすべての span に付与します
`tracing`	`TracingConfig`	実行単位のトレーシング上書き（例: export API key）
`sessionInputCallback`	`SessionInputCallback`	この runner 上の全実行に対するデフォルト履歴マージ戦略です
`callModelInputFilter`	`CallModelInputFilter`	各モデル呼び出し前にモデル入力を編集するグローバル hook です
`toolErrorFormatter`	`ToolErrorFormatter`	モデルに返すツール承認拒否メッセージをカスタマイズするグローバル hook です
`reasoningItemIdPolicy`	`ReasoningItemIdPolicy`	生成済み項目を後続モデル呼び出しに再投入する際、reasoning-item の `id` を保持/省略するデフォルトポリシーです

状態と会話管理

Conversations / チャットスレッド

runner.run()（または run() ユーティリティ）の各呼び出しは、アプリケーションレベル会話の 1 turn を表します。エンドユーザーに RunResult のどこまで見せるかは選べます。finalOutput のみの場合もあれば、生成された全項目を見せる場合もあります。

import { Agent, run } from '@openai/agents';
import type { AgentInputItem } from '@openai/agents';

let thread: AgentInputItem[] = [];

const agent = new Agent({
  name: 'Assistant',
});

async function userSays(text: string) {
  const result = await run(
    agent,
    thread.concat({ role: 'user', content: text }),
  );

  thread = result.history; // Carry over history + newly generated items
  return result.finalOutput;
}

await userSays('What city is the Golden Gate Bridge in?');
// -> "San Francisco"

await userSays('What state is it in?');
// -> "California"

対話型版は chat example を参照してください。

サーバー管理会話

各 turn でローカルの全文トランスクリプトを送る代わりに、OpenAI Responses API に会話履歴を永続化させることができます。長い会話や複数サービスの調整時に有用です。詳細は Conversation state guide を参照してください。

OpenAI はサーバー側状態を再利用する 2 つの方法を提供しています。

1. 会話全体の `conversationId`

Conversations API で会話を 1 回作成し、以降すべての turn でその ID を再利用できます。SDK は新規生成項目のみを自動的に含めます。

import { Agent, run } from '@openai/agents';
import { OpenAI } from 'openai';

const agent = new Agent({
  name: 'Assistant',
  instructions: 'Reply very concisely.',
});

async function main() {
  // Create a server-managed conversation:
  const client = new OpenAI();
  const { id: conversationId } = await client.conversations.create({});

  const first = await run(agent, 'What city is the Golden Gate Bridge in?', {
    conversationId,
  });
  console.log(first.finalOutput);
  // -> "San Francisco"

  const second = await run(agent, 'What state is it in?', { conversationId });
  console.log(second.finalOutput);
  // -> "California"
}

main().catch(console.error);

2. 最終 turn から継続する `previousResponseId`

まず Responses API だけで始めたい場合でも、前回レスポンスで返った ID を使って各リクエストを連結できます。これにより、完全な conversation リソースを作らずに turn 間のコンテキストを維持できます。

import { Agent, run } from '@openai/agents';

const agent = new Agent({
  name: 'Assistant',
  instructions: 'Reply very concisely.',
});

async function main() {
  const first = await run(agent, 'What city is the Golden Gate Bridge in?');
  console.log(first.finalOutput);
  // -> "San Francisco"

  const previousResponseId = first.lastResponseId;
  const second = await run(agent, 'What state is it in?', {
    previousResponseId,
  });
  console.log(second.finalOutput);
  // -> "California"
}

main().catch(console.error);

Hooks とカスタマイズ

Call model input filter

callModelInputFilter は、モデル呼び出しの直前にモデル入力を編集するために使います。この hook は、現在のエージェント、コンテキスト、結合済み入力項目（存在する場合はセッション履歴を含む）を受け取ります。更新後の input 配列と任意の instructions を返し、機密データのマスキング、古いメッセージの削除、追加のシステムガイダンス注入を行えます。

runner.run(..., { callModelInputFilter }) で実行単位に設定するか、Runner 設定（RunConfig の callModelInputFilter）でデフォルト設定できます。

Tool error formatter

toolErrorFormatter は、ツール呼び出しが拒否された際にモデルへ返す承認拒否メッセージをカスタマイズするために使います。これにより、SDK デフォルトメッセージではなく、ドメイン固有の文言（例: コンプライアンスガイダンス）を返せます。

formatter は実行単位（runner.run(..., { toolErrorFormatter })）または RunConfig 全体（new Runner(...) の toolErrorFormatter）で設定できます。

formatter は現在 approval_rejected イベントで実行され、以下を受け取ります。

kind（現在は常に 'approval_rejected'）
toolType（'function'、'computer'、'shell'、または 'apply_patch'）
toolName
callId
defaultMessage（SDK フォールバックメッセージ）
runContext

文字列を返すとメッセージを上書きし、undefined を返すと SDK デフォルトを維持します。formatter が throw した場合（または非文字列を返した場合）、SDK は警告を記録し、デフォルトの承認拒否メッセージにフォールバックします。

Reasoning item ID ポリシー

reasoningItemIdPolicy は、SDK が以前生成した実行項目を後続モデル入力用 AgentInputItem[] に変換する際、reasoning items が id フィールドを保持するかどうかを制御します。

これは、SDK が生成済みモデル項目を入力として再利用する次の箇所に影響します。

同一実行内のフォローアップモデル呼び出し（例: ツール実行後）
生成済み項目を入力/履歴として再利用する後続 turn
保存済み RunState から再開した実行
result.history / result.output のような派生結果ビュー（モデル入力形状の配列）
'preserve'（デフォルト）は reasoning-item ID を保持します
'omit' は入力として送り返す前に reasoning items から id フィールドを除去します
reasoning 以外の項目は影響を受けません

これで 変更されない もの:

元のモデル応答（result.rawResponses）
実行項目（result.newItems）
provider が返す現在 turn のモデル出力

つまり、このポリシーは SDK が以前の生成項目から 次の入力 を構築するときに適用されます。

ポリシーは実行単位（runner.run(..., { reasoningItemIdPolicy: 'omit' })）または runner デフォルト（new Runner({ reasoningItemIdPolicy: 'omit', ... })）で設定できます。保存済み RunState から再開する場合、上書きしない限り以前解決済みのポリシーが再利用されます。

`callModelInputFilter` との相互作用

reasoningItemIdPolicy は callModelInputFilter より前に適用されます。カスタム動作が必要な場合、callModelInputFilter で準備済み入力を検査し、モデル呼び出し前に reasoning ID を手動で再追加または削除できます。

`'omit'` を使うタイミング

'omit' は、再投入される reasoning items を ID なしで正規化したい場合（例: 転送/再生されるモデル入力を単純化したい、またはアプリパイプラインの連携要件に合わせたい場合）に使います。

また、バックエンド / provider が再投入 reasoning items をリクエスト検証エラーで拒否する場合（例: フォローアップ入力の reasoning item ID 関連 HTTP 400）のトラブルシューティングにも有効です。その場合、'omit' で再投入 reasoning ID を除去すると、新規リクエストで無効と扱われる ID の送信を避けられます。

再投入入力でも reasoning-item ID を保持したく、連携先が受け入れる場合は 'preserve' を維持してください。

エラーと復旧

エラーハンドラー

errorHandlers を使うと、サポート対象の実行時エラーを throw せず最終出力に変換できます。現在は maxTurns のみ対応です。

errorHandlers.maxTurns は max-turn エラーのみ処理します
errorHandlers.default はサポート対象種別のフォールバックに使われます
ハンドラーは { error, context, runData } を受け取り、{ finalOutput, includeInHistory? } を返せます

例外

SDK は catch 可能な少数のエラーを throw します。

MaxTurnsExceededError – maxTurns 到達
ModelBehaviorError – モデルが無効出力を生成（例: 不正な JSON、未知ツール）
InputGuardrailTripwireTriggered / OutputGuardrailTripwireTriggered – ガードレール違反
ToolInputGuardrailTripwireTriggered / ToolOutputGuardrailTripwireTriggered – ツールガードレール違反
GuardrailExecutionError – ガードレール実行の完了失敗
ToolTimeoutError – 関数ツールが timeoutMs を超過し、timeoutBehavior: 'raise_exception' を使用
ToolCallError – 関数ツール実行がタイムアウト以外で失敗
UserError – 設定またはユーザー入力に基づいて throw された任意エラー

すべて基底 AgentsError クラスを継承しており、現在の実行状態へアクセスするための state プロパティを提供する場合があります。

以下は GuardrailExecutionError を処理するコード例です。入力ガードレールは最初のユーザー入力でのみ実行されるため、この例では元の入力とコンテキストで実行を再開始します。さらに、保存済み状態を再利用して、モデルを再呼び出しせずに出力ガードレールを再試行する方法も示します。

import {
  Agent,
  GuardrailExecutionError,
  InputGuardrail,
  InputGuardrailTripwireTriggered,
  OutputGuardrail,
  OutputGuardrailTripwireTriggered,
  run,
} from '@openai/agents';
import { z } from 'zod';

// Shared guardrail agent to avoid re-creating it on every fallback run.
const guardrailAgent = new Agent({
  name: 'Guardrail check',
  instructions: 'Check if the user is asking you to do their math homework.',
  outputType: z.object({
    isMathHomework: z.boolean(),
    reasoning: z.string(),
  }),
});

async function main() {
  const input = 'Hello, can you help me solve for x: 2x + 3 = 11?';
  const context = { customerId: '12345' };

  // Input guardrail example

  const unstableInputGuardrail: InputGuardrail = {
    name: 'Math Homework Guardrail (unstable)',
    execute: async () => {
      throw new Error('Something is wrong!');
    },
  };

  const fallbackInputGuardrail: InputGuardrail = {
    name: 'Math Homework Guardrail (fallback)',
    execute: async ({ input, context }) => {
      const result = await run(guardrailAgent, input, { context });
      const isMathHomework =
        result.finalOutput?.isMathHomework ??
        /solve for x|math homework/i.test(JSON.stringify(input));
      return {
        outputInfo: result.finalOutput,
        tripwireTriggered: isMathHomework,
      };
    },
  };

  const agent = new Agent({
    name: 'Customer support agent',
    instructions:
      'You are a customer support agent. You help customers with their questions.',
    inputGuardrails: [unstableInputGuardrail],
  });

  try {
    // Input guardrails only run on the first turn of a run, so retries must start a fresh run.
    await run(agent, input, { context });
  } catch (e) {
    if (e instanceof GuardrailExecutionError) {
      console.error(`Guardrail execution failed (input): ${e}`);
      try {
        agent.inputGuardrails = [fallbackInputGuardrail];
        // Retry from scratch with the original input and context.
        await run(agent, input, { context });
      } catch (ee) {
        if (ee instanceof InputGuardrailTripwireTriggered) {
          console.log('Math homework input guardrail tripped on retry');
        } else {
          throw ee;
        }
      }
    } else {
      throw e;
    }
  }

  // Output guardrail example

  const replyOutputSchema = z.object({ reply: z.string() });

  const unstableOutputGuardrail: OutputGuardrail<typeof replyOutputSchema> = {
    name: 'Answer review (unstable)',
    execute: async () => {
      throw new Error('Output guardrail crashed.');
    },
  };

  const fallbackOutputGuardrail: OutputGuardrail<typeof replyOutputSchema> = {
    name: 'Answer review (fallback)',
    execute: async ({ agentOutput }) => {
      const outputText =
        typeof agentOutput === 'string'
          ? agentOutput
          : (agentOutput?.reply ?? JSON.stringify(agentOutput));
      const flagged = /math homework|solve for x|x =/i.test(outputText);
      return {
        outputInfo: { flaggedOutput: outputText },
        tripwireTriggered: flagged,
      };
    },
  };

  const agent2 = new Agent<unknown, typeof replyOutputSchema>({
    name: 'Customer support agent (output check)',
    instructions: 'You are a customer support agent. Answer briefly.',
    outputType: replyOutputSchema,
    outputGuardrails: [unstableOutputGuardrail],
  });

  try {
    await run(agent2, input, { context });
  } catch (e) {
    if (e instanceof GuardrailExecutionError && e.state) {
      console.error(`Guardrail execution failed (output): ${e}`);
      try {
        agent2.outputGuardrails = [fallbackOutputGuardrail];
        // Output guardrails can be retried using the saved state without another model call.
        await run(agent2, e.state);
      } catch (ee) {
        if (ee instanceof OutputGuardrailTripwireTriggered) {
          console.log('Output guardrail tripped after retry with saved state');
        } else {
          throw ee;
        }
      }
    } else {
      throw e;
    }
  }
}

main().catch(console.error);

入力と出力の再試行の違い:

入力ガードレールは実行の最初のユーザー入力でのみ実行されるため、再試行には同じ入力/コンテキストで新規実行を開始する必要があります。保存済み state を渡しても入力ガードレールは再トリガーされません
出力ガードレールはモデル応答後に実行されるため、GuardrailExecutionError の保存済み state を再利用すれば、追加のモデル呼び出しなしで再実行できます

上記の例を実行すると、次の出力が表示されます。

Guardrail execution failed (input): Error: Input guardrail failed to complete: Error: Something is wrong!
Math homework input guardrail tripped on retry
Guardrail execution failed (output): Error: Output guardrail failed to complete: Error: Output guardrail crashed.
Output guardrail tripped after retry with saved state

次のステップ

モデルの設定方法を学ぶ
エージェントにツールを提供する
本番運用に向けてガードレールやトレーシングを追加する