StartServerOptions interface

Optional custom authentication configuration. If not provided, configuration will be loaded from environment variables using loadAuthConfigFromEnv().

authConfig?: AuthConfiguration

Property Value

A callback invoked with the Express app before listen() is called. Use this to add custom routes, middleware, or static file serving.

Note: The agent messages route is registered after this callback. Avoid adding catch-all routes (e.g., app.all('*', ...) or app.use('*', ...)) here, as they will shadow the messages endpoint.

Example

startServer(agent, {
  beforeListen: (app) => {
    app.get('/health', (req, res) => res.json({ status: 'ok' }));
  }
});

beforeListen?: (app: Express) => void

Property Value

The port to listen on. Defaults to process.env.PORT or 3978.

port?: string | number

Property Value

Optional rate limiting configuration for the messages endpoint. If not provided, no rate limiting is applied. Specify windowMs (in milliseconds) and max (number of requests) to enable rate limiting.

Example

startServer(agent, {
  rateLimitOptions: {
    windowMs: 15 * 60 * 1000, // 15 minutes
    max: 1000 // limit each IP to 1000 requests per windowMs
  }
});

rateLimitOptions?: { max: number, windowMs: number }

Property Value

The route path for the agent messages endpoint. Defaults to '/api/messages'.

routePath?: string

Property Value