Reference

The Reference section provides documentation of Mastra's API, including parameters, types and usage examples.

AcpAgentcreateACPTool()

AgentController ClassSession Class

Agent ClassChannelscreateInngestAgent()createSkill()DurableAgent.generate().generateLegacy().getDefaultGenerateOptionsLegacy().getDefaultOptions().getDefaultStreamOptionsLegacy().getDescription().getInstructions().getLLM().getMemory().getMetadata().getModel().getSkill().getVoice().listAgents().listScorers().listSkills().listSuspendedRuns().listTools().listWorkflows().network()

OverviewchatRoute()handleChatStream()handleNetworkStream()handleWorkflowStream()networkRoute()toAISdkMessages()toAISdkStream()toAISdkV4Messages()toAISdkV5Messages()withMastra()withSseHeartbeat()workflowRoute()workflowSnapshotToStream()

Auth0Better AuthClerkFine-Grained AuthorizationFirebaseGoogleJSON Web TokenNeonOktaSupabaseWorkOS

AgentBrowserBrowserViewerFirecrawlBrowserMastraBrowser ClassStagehandBrowser

ChannelProviderSlackProviderTeamsProviderTelegramProvider

Classifier

create-mastramastra

Agent Controller APIAgents APIConversations APIDatasets APIError HandlingLogs APIMastra Client SDKMemory APIObservability APIResponses APITools APIVectors APIWorkflows API

ACP servermountAgentControllerOnMastra()

buildBasePrompt()createCodingAgent()

channels()credential()Provider toolsetstools()

Mastra ClassMastraModelGateway.addDynamicWorkflow().addDynamicWorkflows().addGateway().getAgent().getAgentById().getClassifier().getClassifierById().getDeployer().getEditor().getGateway().getGatewayById().getLogger().getMCPServer().getMCPServerById().getMemory().getScorer().getScorerById().getServer().getStorage().getTool().getToolById().getVector().getWorkflow().listAgents().listClassifiers().listGateways().listLogs().listLogsByRunId().listMCPServers().listMemory().listScorers().listTools().listVectors().listWorkflows().removeWorkspace().setLogger().setStorage()

CloudflareDeployerNetlifyVercel

BlobStoreProviderMastraEditor ClassProcessorProviderPrompt blocksTool configurationToolProviderVersioningBrowserProviderStorageBrowserRefFilesystemProviderSandboxProviderStorageWorkspaceRef

createClassifierScorer()createScorer()filterRun()MastraScorernotScorable()Quick ChecksrunEvals()Scorer UtilsAnswer Relevancy ScorerAnswer Similarity ScorerBiasCompletenessContent Similarity ScorerContext Precision ScorerContext Recall ScorerContext Relevance ScorerFaithfulnessHallucinationKeyword Coverage ScorerMulti-turn Judge ScorerNoise Sensitivity ScorerPrompt Alignment ScorerRubric ScorerSummarization ScorerTextual Difference ScorerTone Consistency ScorerTool Call Accuracy ScorersToxicityTrajectory Accuracy ScorersDataset ClassDatasetsManager Class.addItem().addItems().compareExperiments().create().createExperiment().delete().deleteExperiment().deleteItem().deleteItems().finalizeExperiment().get().getDetails().getExperiment().getItem().getItemHistory().list().listExperimentResults().listExperiments().listItems().listVersions().purgeItem().runExperimentItem().startExperiment().startExperimentAsync().submitExperimentResult().update().updateExperiment().updateItem()

config.tsInstructionsLoggerMemoryObservabilityProcessorsSchedulesScorersServerSkillsStorageStudioSubagentsToolsWorkflowsWorkspace

Cloned Thread UtilitiesMemory ClassObservational MemorySerializedMemoryConfigsummarizeConversation().cloneThread().copyThread().createThread().deleteMessages().getThreadById().listThreads().recall().settled().summarizeThread().updateThreadResourceId()

@mastra/mcp v1 to v2AgentNetwork to .network()AI SDK v4 to v5Mastra Cloud to Mastra platformVNext to Standard APIs.network() to Supervisor AgentsOverviewAgentsCLIClient SDKDeploymentEvalsMastraMCPMemoryProcessorsRAGStorageToolsTracingVectorsVoiceWorkflows

FeedbackPinoLoggerAutomatic MetricsMetric queriesConfigurationInstancesInterfacesQuery traces and spansSpan filteringSpans

AgentsMDInjectorBatchPartsProcessorClassifierProcessorCyberRefusalHandlerFileUploadProcessorLanguageDetectorMemoryInputFilterMessageHistoryModelSelectionProcessorModerationProcessorPIIDetectorPrefillErrorHandlerProcessor InterfacePromptInjectionDetectorProviderHistoryCompatRegexFilterProcessorResponseCacheSemanticRecallSkillSearchProcessorStreamErrorRetryProcessorSystemPromptScrubberTokenCostControlTokenLimiterProcessorToolCallFilterToolSearchProcessorUnicodeNormalizerUnsupportedFileHandlerWorkingMemory

CachingPubSubEventEmitterPubSubGoogleCloudPubSubLeaseProviderPubSubRedisStreamsPubSubUnixSocketPubSubValkeyStreamsPubSub

OverviewChunking and EmbeddingDatabaseConfigEmbedExtractParamsGraphRAGGraphRAG GuideMDocumentMetadata Filtersrerank()rerankWithScorer()RetrievalVector Databases.chunk()

Overview

createRoute()Elysia AdapterExpress AdapterFastify AdapterHono AdapterKoa AdapterMastraServerNestJS AdapterNext.js AdapterregisterApiRoute()Server RoutesTanStack Start Adapter

createNotificationInboxTool()NotificationsSignalProviderTaskSignalProviderThread eventsWebhookSignalProvider

OverviewComposite StorageRetention (prune)Turso Storage

ChunkTypesmoothStream()MastraModelOutput.stream().streamLegacy().streamUntilIdle().observeStream().resumeStream().stream().timeTravelStream()

Overview

askUserToolcreateBedrockKBTool()createCodeMode()createDocumentChunkerTool()createGraphRAGTool()createTool()createVectorQueryTool()IsolatedVmCodeModeTransportMCPClientMCPServerQuickJsCodeModeTransportsubmitPlanToolTask tools

OverviewComposite VoiceEventsMastra VoiceSpeech to SpeechSpeech to TextText to Speech.addInstructions().addTools().answer().close().connect().getSpeakers().listen().off().on().send().speak().updateConfig()

Overview

Dynamic Workflow DefinitionRun ClassStep ClassWorkflow ClassWorkflow State Reader.agent().branch().classifier().commit().createRun().dountil().dowhile().foreach().map().parallel().sleep().sleepUntil().then().tool().cancel().restart().resume().start().startAsync().timeTravel()

FactorySandboxLocalFilesystemLocalSandboxPlatformFilesystemPlatformSandboxSandboxProcessManagerWorkspace ClassWorkspaceFilesystemWorkspaceSandbox