serve | SignalWire

Start a Hono web server (via @hono/node-server) to serve this agent. The server exposes endpoints for SWML document delivery, SWAIG function execution, post-prompt summary handling, and health checks.

The server automatically includes:

SWML document endpoint at the agent’s route
SWAIG function dispatch at {route}/swaig
Post-prompt handler at {route}/post_prompt
/health and /ready health check endpoints
Security headers middleware
Basic Auth middleware

run() is an alias for serve(). Both methods are equivalent in the TypeScript SDK.

Parameters

None.

Returns

Promise<void> — Resolves once the server is running.

Example

1 import { AgentBase } from '@signalwire/sdk';
2 
3 const agent = new AgentBase({ name: 'my-agent', host: '0.0.0.0', port: 3000 });
4 agent.setPromptText('You are a helpful assistant.');
5 await agent.serve(); // Blocks here, serving at http://0.0.0.0:3000/