Reference
The Reference section provides documentation of Mastra's API, including parameters, types and usage examples.
Agent ClassChannels.generate().generateLegacy().getDefaultGenerateOptionsLegacy().getDefaultOptions().getDefaultStreamOptionsLegacy().getDescription().getInstructions().getLLM().getMemory().getModel().getTools().getVoice().listAgents().listScorers().listTools().listWorkflows().network()
chatRoute()handleChatStream()handleNetworkStream()handleWorkflowStream()networkRoute()toAISdkMessages()toAISdkStream()toAISdkV4Messages()toAISdkV5Messages()withMastra()workflowRoute()
Agents APIConversations APIError HandlingLogs APIMastra Client SDKMemory APIObservability APIResponses APITelemetry APITools APIVectors APIWorkflows API
Mastra ClassMastraModelGateway.addGateway().getAgent().getAgentById().getDeployer().getEditor().getGateway().getGatewayById().getLogger().getMCPServer().getMCPServerById().getMemory().getScorer().getScorerById().getServer().getStorage().getTelemetry().getVector().getWorkflow().listAgents().listGateways().listLogs().listLogsByRunId().listMCPServers().listMemory().listScorers().listVectors().listWorkflows().setLogger().setStorage()
createScorer()filterRun()MastraScorerrunEvals()Scorer UtilsAnswer Relevancy ScorerAnswer Similarity ScorerBiasCompletenessContent Similarity ScorerContext Precision ScorerContext Relevance ScorerFaithfulnessHallucinationKeyword Coverage ScorerNoise Sensitivity ScorerPrompt Alignment ScorerTextual Difference ScorerTone Consistency ScorerTool Call Accuracy ScorersToxicityTrajectory Accuracy ScorersDataset ClassDatasetsManager Class.addItem().addItems().compareExperiments().create().delete().deleteExperiment().deleteItem().deleteItems().get().getDetails().getExperiment().getItem().getItemHistory().list().listExperimentResults().listExperiments().listItems().listVersions().startExperiment().startExperimentAsync().update().updateItem()
Cloned Thread UtilitiesMemory ClassObservational Memory.cloneThread().createThread().deleteMessages().getThreadById().listThreads().recall()
BatchPartsProcessorCostGuardProcessorLanguageDetectorMessageHistoryModerationProcessorPIIDetectorPrefillErrorHandlerProcessor InterfacePromptInjectionDetectorProviderHistoryCompatRegexFilterProcessorResponseCacheSemanticRecallSkillSearchProcessorStreamErrorRetryProcessorSystemPromptScrubberTokenLimiterProcessorToolCallFilterToolSearchProcessorUnicodeNormalizerWorkingMemory
createRoute()Express AdapterFastify AdapterHono AdapterKoa AdapterMastraServerNestJS AdapterregisterApiRoute()Server Routes
OverviewAurora DSQL StorageClickHouse StorageCloudflare D1 StorageCloudflare KV StorageComposite StorageConvex StorageDuckDB StorageDynamoDB StorageLanceDB StoragelibSQL StorageMongoDB StorageMSSQL StoragePostgreSQL StorageRedis StorageUpstash Storage
ChunkTypeMastraModelOutput.stream().streamLegacy().streamUntilIdle().observeStream().resumeStream().stream().timeTravelStream()
Bright Data ToolscreateDocumentChunkerTool()createGraphRAGTool()createTool()createVectorQueryTool()MCPClientMCPServerPerplexity ToolsTavily Tools
Amazon S3 Vector StoreAstra Vector StoreChroma Vector StoreCloudflare Vector StoreConvex Vector StoreCouchbase Vector StoreDuckDB Vector StoreElasticSearch Vector StoreLance Vector StorelibSQL Vector StoreMongoDB Vector StoreOpenSearch Vector StorePG Vector StorePinecone Vector StoreQdrant Vector StoreTurbopuffer Vector StoreUpstash Vector Store
AWS Nova SonicAzureCloudflareComposite VoiceDeepgramElevenLabsEventsGoogleGoogle Gemini LiveInworldMastra VoiceMurfOpenAIOpenAI RealtimePlayAISarvamSpeechify.addInstructions().addTools().answer().close().connect().getSpeakers().listen().off().on().send().speak().updateConfig()