Skip to main content
Mastra 1.0 is available 🎉 Read announcement

Deploy Mastra to Netlify

Use @mastra/deployer-netlify to deploy your mastra server as serverless functions on Netlify. The deployer bundles your code and generates a .netlify directory conforming to Netlify's frameworks API, ready to deploy.

info

If you're using a server adapter or web framework, deploy the way you normally would for that framework.

Before you begin
Direct link to Before you begin

You'll need a Mastra application and a Netlify account.

Netlify Functions use an ephemeral filesystem, so any storage you configure (including observability storage) must be hosted externally. If you're using LibSQLStore with a file URL, switch to a remotely hosted database.

Installation
Direct link to Installation

Add the @mastra/deployer-netlify package to your project:

npm install @mastra/deployer-netlify@latest

Import NetlifyDeployer and set it as the deployer in your Mastra configuration:

src/mastra/index.ts
import { Mastra } from "@mastra/core";
import { NetlifyDeployer } from "@mastra/deployer-netlify";

export const mastra = new Mastra({
  deployer: new NetlifyDeployer(),
});

Create a netlify.toml file with the following contents in your project root:

[build]
  command = "mastra build"

Usage
Direct link to Usage

After setting up your project, push it to your remote Git provider of choice (e.g. GitHub).

  1. Connect your repository to Netlify. During the setup process, Netlify will detect your netlify.toml file and set the build command to mastra build.

    note

    Remember to set your environment variables needed to run your application (e.g. your model provider API key).

  2. Once you're ready, click the Deploy button and wait for the first deployment to complete. It'll tell you that one function has been deployed.

  3. Try out your newly deployed function by going to https://<random-slug>.netlify.app/api/agents. You should get a JSON response listing all available agents.

    Since the Mastra server prefixes every API endpoint with /api, you have to add it to your URLs when making requests.

    info

    Netlify functions are typically deployed at https://<random-slug>.netlify.app/.netlify/functions/api. The NetlifyDeployer redirects any request from /* to /.netlify/functions/api/:splat, so you don't need to include the .netlify/functions prefix in your URLs.

  4. You can now call your Mastra endpoints over HTTP.

    note

    Set up authentication before exposing your endpoints publicly.

On this page