カスタムAPIルート

デフォルトでは、Mastraは登録されたエージェントとワークフローをサーバー経由で自動的に公開します。追加の動作が必要な場合は、独自のHTTPルートを定義できます。

ルートは@mastra/core/serverのregisterApiRouteヘルパーで提供されます。ルートはMastraインスタンスと同じファイルに配置できますが、分離することで設定を簡潔に保つことができます。

src/mastra/index.ts


import { Mastra } from "@mastra/core/mastra";
import { registerApiRoute } from "@mastra/core/server";
 
export const mastra = new Mastra({
  // ...
  server: {
    apiRoutes: [
      registerApiRoute("/my-custom-route", {
        method: "GET",
        handler: async (c) => {
          const mastra = c.get("mastra");
          const agents = await mastra.getAgent("my-agent");
 
          return c.json({ message: "Custom route" });
        },
      }),
    ],
  },
});

登録されると、カスタムルートはサーバーのルートからアクセス可能になります。例えば：


curl http://localhost:4111/my-custom-route

各ルートのハンドラーはHonoのContextを受け取ります。ハンドラー内ではMastraインスタンスにアクセスして、エージェントやワークフローを取得または呼び出すことができます。

ルート固有のミドルウェアを追加するには、registerApiRouteを呼び出す際にmiddleware配列を渡します。

src/mastra/index.ts


import { Mastra } from "@mastra/core/mastra";
import { registerApiRoute } from "@mastra/core/server";
 
export const mastra = new Mastra({
  // ...
  server: {
    apiRoutes: [
      registerApiRoute("/my-custom-route", {
        method: "GET",
        middleware: [
          async (c, next) => {
            console.log(`${c.req.method} ${c.req.url}`);
            await next();
          }
        ],
        handler: async (c) => {
          return c.json({ message: "Custom route with middleware" });
        }
      })
    ]
  }
});

カスタムAPIルート

src/mastra/index.ts


import { Mastra } from "@mastra/core/mastra";
import { registerApiRoute } from "@mastra/core/server";
 
export const mastra = new Mastra({
  // ...
  server: {
    apiRoutes: [
      registerApiRoute("/my-custom-route", {
        method: "GET",
        handler: async (c) => {
          const mastra = c.get("mastra");
          const agents = await mastra.getAgent("my-agent");
 
          return c.json({ message: "Custom route" });
        },
      }),
    ],
  },
});

登録されると、カスタムルートはサーバーのルートからアクセス可能になります。例えば：


curl http://localhost:4111/my-custom-route

ルート固有のミドルウェアを追加するには、registerApiRouteを呼び出す際にmiddleware配列を渡します。

src/mastra/index.ts


import { Mastra } from "@mastra/core/mastra";
import { registerApiRoute } from "@mastra/core/server";
 
export const mastra = new Mastra({
  // ...
  server: {
    apiRoutes: [
      registerApiRoute("/my-custom-route", {
        method: "GET",
        middleware: [
          async (c, next) => {
            console.log(`${c.req.method} ${c.req.url}`);
            await next();
          }
        ],
        handler: async (c) => {
          return c.json({ message: "Custom route with middleware" });
        }
      })
    ]
  }
});