Reference
The Reference section provides documentation of Mastra's API, including parameters, types and usage examples.
Agent Class.generate().generateLegacy().getDefaultGenerateOptionsLegacy().getDefaultOptions().getDefaultStreamOptionsLegacy().getDescription().getInstructions().getLLM().getMemory().getModel().getTools().getVoice().listAgents().listScorers().listTools().listWorkflows().network()
chatRoute()handleChatStream()handleNetworkStream()handleWorkflowStream()networkRoute()toAISdkStream()toAISdkV4Messages()toAISdkV5Messages()withMastra()workflowRoute()
Agents APIError HandlingLogs APIMastra Client SDKMemory APIObservability APITelemetry APITools APIVectors APIWorkflows API
Mastra ClassMastraModelGateway.addGateway().getAgent().getAgentById().getDeployer().getGateway().getGatewayById().getLogger().getMCPServer().getMCPServerById().getMemory().getScorer().getScorerById().getServer().getStorage().getStoredAgentById().getTelemetry().getVector().getWorkflow().listAgents().listGateways().listLogs().listLogsByRunId().listMCPServers().listMemory().listScorers().listStoredAgents().listVectors().listWorkflows().setLogger().setStorage()
Answer Relevancy ScorerAnswer Similarity ScorerBiasCompletenessContent Similarity ScorerContext Precision ScorerContext Relevance ScorercreateScorer()FaithfulnessHallucinationKeyword Coverage ScorerMastraScorerNoise Sensitivity ScorerPrompt Alignment ScorerrunEvals()Scorer UtilsTextual Difference ScorerTone Consistency ScorerTool Call Accuracy ScorersToxicity
Cloned Thread UtilitiesMemory ClassObservational Memory.cloneThread().createThread().deleteMessages().getThreadById().listThreads().recall()
Dataset ClassDatasetsManager Class.addItem().addItems().compareExperiments().create().delete().deleteExperiment().deleteItem().deleteItems().get().getDetails().getExperiment().getItem().getItemHistory().list().listExperimentResults().listExperiments().listItems().listVersions().startExperiment().startExperimentAsync().update().updateItem()PinoLoggerConfigurationInstancesInterfacesSpans
BatchPartsProcessorLanguageDetectorMessageHistoryModerationProcessorPIIDetectorProcessor InterfacePromptInjectionDetectorSemanticRecallSystemPromptScrubberTokenLimiterProcessorToolCallFilterToolSearchProcessorUnicodeNormalizerWorkingMemory
createRoute()Express AdapterFastify AdapterHono AdapterKoa AdapterMastraServerregisterApiRoute()Server Routes
OverviewCloudflare D1 StorageCloudflare KV StorageComposite StorageConvex StorageDynamoDB StorageLanceDB StoragelibSQL StorageMongoDB StorageMSSQL StoragePostgreSQL StorageUpstash Storage
ChunkTypeMastraModelOutput.stream().streamLegacy().observeStream().resumeStream().stream().timeTravelStream()
createDocumentChunkerTool()createGraphRAGTool()createTool()createVectorQueryTool()MCPClientMCPServer
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
AzureCloudflareComposite VoiceDeepgramElevenLabsEventsGoogleGoogle Gemini LiveMastra VoiceMurfOpenAIOpenAI RealtimePlayAISarvamSpeechify.addInstructions().addTools().answer().close().connect().getSpeakers().listen().off().on().send().speak().updateConfig()