參考文件

參考文件章節提供 Mastra API 的說明，包括參數、型別與使用範例。

AcpAgentcreateACPTool()

AgentController ClassSession Class

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

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

Auth0Better AuthClerkFine-Grained AuthorizationFirebaseGoogleJSON Web TokenOktaSupabaseWorkOS

AgentBrowserBrowserViewerFirecrawlBrowserMastraBrowser ClassStagehandBrowser

ChannelProviderSlackProvider

create-mastramastra

Agents APIConversations APIError HandlingLogs APIMastra Client SDKMemory APIObservability APIResponses APITelemetry APITools APIVectors APIWorkflows API

mountAgentControllerOnMastra()

buildBasePrompt()createCodingAgent()

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

CloudflareDeployerNetlifyVercel

BlobStoreProviderMastraEditor ClassProcessorProviderPrompt blocksTool configurationToolProviderVersioningBrowserProviderStorageBrowserRefFilesystemProviderSandboxProviderStorageWorkspaceRef

createScorer()filterRun()MastraScorerQuick ChecksrunEvals()Scorer UtilsAnswer Relevancy ScorerAnswer Similarity ScorerBiasCompletenessContent Similarity ScorerContext Precision ScorerContext Recall ScorerContext Relevance ScorerFaithfulnessHallucinationKeyword Coverage ScorerNoise Sensitivity ScorerPrompt Alignment ScorerRubric ScorerSummarization 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()

config.tsInstructionsLoggerMemoryObservabilityProcessorsSchedulesScorersServerSkillsStorageStudioSubagentsToolsWorkflowsWorkspace

API Reference

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

FeedbackPinoLoggerAutomatic MetricsConfigurationInstancesInterfacesSpan filteringSpans

BatchPartsProcessorCostGuardProcessorLanguageDetectorMessageHistoryModerationProcessorPIIDetectorPrefillErrorHandlerProcessor InterfacePromptInjectionDetectorProviderHistoryCompatRegexFilterProcessorResponseCacheSemanticRecallSkillSearchProcessorStreamErrorRetryProcessorSystemPromptScrubberTokenLimiterProcessorToolCallFilterToolSearchProcessorUnicodeNormalizerWorkingMemory

CachingPubSubEventEmitterPubSubGoogleCloudPubSubLeaseProviderPubSubRedisStreamsPubSubUnixSocketPubSub

DatabaseConfigEmbedExtractParamsGraphRAGMDocumentMetadata Filtersrerank()rerankWithScorer().chunk()

Overview

createRoute()Express AdapterFastify AdapterHono AdapterKoa AdapterMastraServerNestJS AdapterregisterApiRoute()Server Routes

createNotificationInboxTool()SignalProviderTaskSignalProviderWebhookSignalProvider

OverviewAurora DSQL StorageClickHouse StorageCloudflare D1 StorageCloudflare KV StorageComposite StorageConvex StorageDuckDB StorageDynamoDB StorageGoogle Cloud Spanner StorageLanceDB StoragelibSQL StorageMongoDB StorageMSSQL StorageOracleDB StoragePostgreSQL StorageRedis StorageRetention (prune)Upstash Storage

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

Overview

askUserToolBright Data ToolscreateBedrockKBTool()createCodeMode()createDocumentChunkerTool()createGraphRAGTool()createTool()createVectorQueryTool()IsolatedVmCodeModeTransportMCPClientMCPServerPerplexity ToolssubmitPlanToolTask 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 StoreOracleDB Vector StorePG Vector StorePinecone Vector StoreQdrant Vector StoreTurbopuffer Vector StoreUpstash Vector Store

AWS Nova SonicAzureCloudflareComposite VoiceDeepgramElevenLabsEventsGoogleGoogle Gemini LiveInworldInworld RealtimeLiveKitMastra VoiceMistralMurfOpenAIOpenAI RealtimePlayAISarvamSpeechifyxAI Realtime.addInstructions().addTools().answer().close().connect().getSpeakers().listen().off().on().send().speak().updateConfig()

Overview

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

AgentCoreRuntimeSandboxAgentFSFilesystemAppleContainerSandboxArchilFilesystemAzureBlobFilesystemBlaxelSandboxDaytonaSandboxDockerSandboxE2BSandboxFilesSDKFilesystemGCSFilesystemGoogleDriveFilesystemLocalFilesystemLocalSandboxMesaFilesystemModalSandboxPlatformFilesystemPlatformSandboxRailwaySandboxS3FilesystemSandboxProcessManagerVercelSandboxVercelServerlessSandboxWorkspace ClassWorkspaceFilesystemWorkspaceSandbox