メインコンテンツへ移動

Mastra.getAgentById()

.getAgentById() メソッドは、登録済みの Agent を id で取得します。最初に agent.id で登録済み Agent を検索します。一致する Agent がなければ Mastra.getAgent() にフォールバックし、指定された値を Agent の登録キーとして扱います。

コードで定義した Agent を取得するには mastra.getAgentById(id) を使用します。バージョン管理された Agent を取得するには await mastra.getAgentById(id, version) を使用します。

使用例
使用例への直接リンク

次の例では Agent を登録し、ID で取得して、返された Agent を使用します。

src/mastra/index.ts
import { Agent } from '@mastra/core/agent'
import { Mastra } from '@mastra/core/mastra'

const supportAgent = new Agent({
  id: 'support-agent-id',
  name: 'Support Agent',
  instructions: 'Answer support questions clearly and concisely.',
  model: 'openai/gpt-5.6-sol',
})

export const mastra = new Mastra({
  agents: {
    supportAgent,
  },
})

const agent = mastra.getAgentById('support-agent-id')

const response = await agent.generate('How can I reset my password?')

パラメータ
パラメータへの直接リンク

id:

string
取得する Agent の ID。Mastra は最初に agent.id で登録済み Agent を検索します。一致するものがなければ、この値を Agent の登録キーとして getAgent() を呼び出します。

version?:

{ versionId: string } | { status?: 'draft' | 'published' }
バージョン管理された Agent を取得するための任意のバージョンセレクター。指定すると、このメソッドは Promise を返します。
VersionSelector

versionId:

string
取得する特定の Agent バージョンの ID。

status?:

'draft' | 'published'
指定した公開ステータスの最新 Agent バージョンを選択します。

戻り値
戻り値への直接リンク

agent:

TAgents[TAgentName]
version を省略した場合、指定した ID の Agent インスタンス。

agent:

Promise<TAgents[TAgentName]>
version を指定した場合、バージョン管理された Agent インスタンスに解決される Promise。

ID または登録キーで Agent が見つからない場合は MastraError をスローします。

On this page