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().getVoice().getTools().listAgents().listScorers().listTools().listWorkflows().network()

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

Auth0Better AuthClerkFirebaseJSON Web TokenSupabaseWorkOS

create-mastramastra

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()

CloudflareDeployerNetlifyVercel

Answer Relevancy ScorerAnswer Similarity ScorerBiasCompletenessContent Similarity ScorerContext Precision ScorerContext Relevance ScorercreateScorerFaithfulnessHallucinationKeyword Coverage ScorerMastraScorerNoise Sensitivity ScorerPrompt Alignment ScorerrunEvalsScorer UtilsTextual Difference ScorerTone Consistency ScorerTool Call Accuracy ScorersToxicity

Memory ClassObservational MemoryCloned Thread Utilities.cloneThread().createThread().deleteMessages().getThreadById().listThreads().recall()

PinoLoggerConfigurationInstancesInterfacesSpans

BatchPartsProcessorLanguageDetectorMessageHistoryModerationProcessorPIIDetectorProcessor InterfacePromptInjectionDetectorSemanticRecallSystemPromptScrubberTokenLimiterProcessorToolCallFilterToolSearchProcessorUnicodeNormalizerWorkingMemory

DatabaseConfigEmbedExtractParamsGraphRAGMDocumentMetadata Filters.chunk()rerank()rerankWithScorer()

createRoute()Express AdapterFastify AdapterHono AdapterKoa AdapterMastraServerregisterApiRoute()Server Routes

OverviewComposite StorageCloudflare D1 StorageCloudflare KV StorageConvex StorageDynamoDB StorageLanceDB StoragelibSQL StorageMongoDB StorageMSSQL StoragePostgreSQL StorageUpstash Storage

Workspace ClassLocalFilesystemS3FilesystemGCSFilesystemLocalSandboxE2BSandboxWorkspaceFilesystemWorkspaceSandbox

.stream().streamLegacy()MastraModelOutputChunkType.observeStream().resumeStream().stream().timeTravelStream()

Overview

createDocumentChunkerTool()createGraphRAGTool()createTool()createVectorQueryTool()MCPClientMCPServer

Amazon S3 Vectors 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

.addInstructions().addTools().answer().close().connect().getSpeakers().listen().off().on().send().speak().updateConfig()AzureCloudflareComposite VoiceDeepgramElevenLabsEventsGoogleGoogle Gemini LiveMastra VoiceMurfOpenAIOpenAI RealtimePlayAISarvamSpeechify

.branch().commit().createRun().dountil().dowhile().foreach().map().parallel().sleep().sleepUntil().then()Run Class.cancel().restart().resume().start().startAsync().timeTravel()Step ClassWorkflow Class