serveStaticFiles

Serve static files (HTML, CSS, JS, images) from a local directory. Includes path traversal protection, MIME type detection, and security headers (Cache-Control, X-Content-Type-Options).

This method is useful for serving a web frontend alongside your agents — for example, an admin dashboard or a configuration UI.

Parameters

route

stringDefaults to /

URL path prefix for static files. Trailing slashes are stripped; '/' serves from the root.

Returns

void

Example

1 import { AgentBase, AgentServer } from '@signalwire/sdk';
2 
3 const support = new AgentBase({ name: 'support', route: '/support' });
4 support.setPromptText('You are a helpful assistant.');
5 
6 const server = new AgentServer({ port: 3000 });
7 server.register(support);
8 server.serveStaticFiles('./web', '/static');
9 await server.run();

With this configuration:

Request Path	Served By
`/support`	SupportAgent
`/support/swaig`	SupportAgent SWAIG endpoint
`/static/style.css`	`./web/style.css`
`/static/logo.png`	`./web/logo.png`

Path traversal attempts (e.g., /../etc/passwd) are blocked. The resolved file path must remain within the configured static directory.

1	import { AgentBase, AgentServer } from '@signalwire/sdk';
2
3	const support = new AgentBase({ name: 'support', route: '/support' });
4	support.setPromptText('You are a helpful assistant.');
5
6	const server = new AgentServer({ port: 3000 });
7	server.register(support);
8	server.serveStaticFiles('./web', '/static');
9	await server.run();