Mastra.getAgentById()

La méthode .getAgentById() récupère un Agent enregistré à partir de son id. Elle recherche d’abord les Agents enregistrés par agent.id. Si aucun Agent ne correspond, elle utilise Mastra.getAgent() et traite la valeur fournie comme la clé de registre de l’Agent.

Utilisez mastra.getAgentById(id) pour récupérer l’Agent défini dans le code. Utilisez await mastra.getAgentById(id, version) pour récupérer un Agent versionné.

Exemple d’utilisation

L’exemple suivant enregistre un Agent, le récupère par son ID et utilise l’Agent renvoyé.

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?')

Paramètres

id:

string

ID de l’Agent à récupérer. Mastra recherche d’abord les Agents enregistrés par agent.id. Si aucun ne correspond, il utilise cette valeur comme clé de registre de l’Agent et appelle getAgent().

version?:

{ versionId: string } | { status?: 'draft' | 'published' }

Sélecteur de version facultatif pour récupérer un Agent versionné. Lorsqu’il est fourni, la méthode renvoie une promesse.

VersionSelector

versionId:

string

ID d’une version spécifique de l’Agent à récupérer.

status?:

'draft' | 'published'

Sélectionne la dernière version de l’Agent avec ce statut de publication.

Valeur renvoyée

agent:

TAgents[TAgentName]

Instance d’Agent avec l’ID spécifié lorsque version est omis.

agent:

Promise<TAgents[TAgentName]>

Promesse qui se résout en instance d’Agent versionnée lorsque version est fourni.

Génère une MastraError lorsqu’aucun Agent n’est trouvé par ID ou clé de registre.

Voir aussi

• Mastra.getAgent()
• Présentation des Agents