AgentServer | SignalWire

AgentServer hosts multiple AgentBase instances on a single Hono HTTP server. Each agent registers at its own URL route, and the server provides unified health monitoring, SIP-based routing, and static file serving. Use AgentServer when you have several related agents (sales, support, billing) that share the same deployment.

For a single agent, use AgentBase.serve() or AgentBase.run() instead.

Constructor

1 import { AgentServer } from '@signalwire/sdk';
2 
3 const server = new AgentServer({ host: '0.0.0.0', port: 3000 });

Constructor Parameters

opts

object

Optional server configuration.

opts.host

stringDefaults to 0.0.0.0

Hostname the server binds to.

opts.port

numberDefaults to 3000

Port the server listens on. Also reads from the PORT environment variable.

opts.logLevel

stringDefaults to info

Logging level: 'debug', 'info', 'warn', or 'error'. Lowercased and applied globally via setGlobalLogLevel.

Properties

host

string

The hostname the server binds to.

port

number

The port the server listens on.

logLevel

string

The logging level for the server (read-only).

Methods

getAgent

Retrieve a specific registered agent by its route.

getAgents

Return all registered agents as a Map.

getApp

Get the fully configured Hono application.

registerGlobalRoutingCallback

run

Start the multi-agent HTTP server.

serveStaticFiles

Serve static files from a directory alongside agent routes.

setupSipRouting

Configure SIP-based routing to direct calls to specific agents by username.

unregister

Remove an agent from the server’s registry by route.

Example

1 import { AgentBase, AgentServer } from '@signalwire/sdk';
2 
3 const salesAgent = new AgentBase({ name: 'sales-agent', route: '/sales' });
4 salesAgent.addLanguage({ name: 'English', code: 'en-US', voice: 'rime.spore' });
5 salesAgent.promptAddSection('Role', { body: 'You are a sales representative.' });
6 
7 const supportAgent = new AgentBase({ name: 'support-agent', route: '/support' });
8 supportAgent.addLanguage({ name: 'English', code: 'en-US', voice: 'rime.spore' });
9 supportAgent.promptAddSection('Role', { body: 'You are a support specialist.' });
10 
11 const server = new AgentServer({ host: '0.0.0.0', port: 3000 });
12 server.register(salesAgent, '/sales');
13 server.register(supportAgent, '/support');
14 await server.run();

After starting, agents are available at:

Endpoint	Description
`http://localhost:3000/sales`	Sales agent
`http://localhost:3000/support`	Support agent
`http://localhost:3000/health`	Health check
`http://localhost:3000/ready`	Readiness check