@mastra/core
Version:
Mastra is a framework for building AI-powered applications and agents with a modern TypeScript stack.
32 lines (20 loc) • 1.2 kB
Markdown
# 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
**options** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
## Returns
**defaultOptions** (`AgentExecutionOptions<Output> | Promise<AgentExecutionOptions<Output>>`): 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(),
})
```
## Related
- [Streaming with agents](https://mastra.ai/docs/streaming/overview)
- [Request Context](https://mastra.ai/docs/server/request-context)