For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
        • getAgent
        • getAgents
        • getApp
        • register
        • registerGlobalRoutingCallback
        • run
        • serveStaticFiles
        • setupSipRouting
        • unregister
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
      • Datasphere
      • Fabric
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Parameters
  • Returns
  • Example
AgentsAgentServer

unregister

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

Configuration

Next
Built with

Remove an agent from the server’s registry. The agent’s routes are no longer tracked, though Hono does not fully remove mounted routers at runtime.

Because Hono does not support dynamic route removal, the agent’s HTTP routes may still respond until the server restarts. This method primarily removes the agent from the internal registry used by getAgents() and the root listing endpoint.

Parameters

route
stringRequired

The route of the agent to remove (e.g., "/sales").

Returns

boolean — true if an agent was registered at that route and was removed, false if no agent was found at the route.

Example

1import { AgentBase, AgentServer } from '@signalwire/sdk';
2
3const server = new AgentServer({ port: 3000 });
4const agent = new AgentBase({ name: 'sales', route: '/sales' });
5server.register(agent);
6
7const removed = server.unregister('/sales');
8console.log(removed); // true