ContextQMD
Back to Mastra

Reference: Agent.getDefaultOptions() | Agents

docs/src/content/en/reference/agents/getDefaultOptions.mdx

2025-12-181.6 KB
Original Source

Agent.getDefaultOptions()

Agents can be configured with default options for memory usage, output format, and iteration steps. The .getDefaultOptions() method returns these defaults, resolving them if they're functions. These options apply to all stream() and generate() calls unless overridden and are useful for inspecting an agent’s unknown defaults.

Usage example

typescript
await agent.getDefaultOptions()

Parameters

<PropertiesTable content={[ { name: 'options', type: '{ requestContext?: RequestContext }', isOptional: true, defaultValue: '{}', description: 'Optional configuration object containing request context.', properties: [ { type: '{ requestContext?: RequestContext }', parameters: [ { name: 'requestContext', type: 'RequestContext', isOptional: true, defaultValue: 'new RequestContext()', description: 'Request Context for dependency injection and contextual information.', }, ], }, ], }, ]} />

Returns

<PropertiesTable content={[ { name: 'defaultOptions', type: 'AgentExecutionOptions<Output> | Promise<AgentExecutionOptions<Output>>', description: 'The default streaming options configured for the agent, either as a direct object or a promise that resolves to the options.', }, ]} />

Extended usage example

typescript
await agent.getDefaultOptions({
  requestContext: new RequestContext(),
})