unregister | SignalWire

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

Because FastAPI does not support unmounting routers, the agent’s HTTP routes may still respond until the server restarts. This method primarily removes the agent from the internal registry used by get_agents(), SIP routing, and the health endpoint.

Parameters

route

strRequired

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

Returns

bool — True if the agent was found and removed, False if no agent exists at that route.

Example

1 from signalwire import AgentServer
2 from signalwire import AgentBase
3 
4 server = AgentServer(port=3000)
5 server.register(AgentBase(name="sales", route="/sales"))
6 
7 removed = server.unregister("/sales")
8 print(removed)  # True