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
      • BedrockAgent
      • CLI Tools
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions
      • LiveWire
      • MCP Gateway
      • PomBuilder
      • Prefabs
      • Search
      • SkillBase
      • Skills
      • SWAIGFunction
      • SWMLBuilder
      • SWMLService
        • add_section
        • add_verb
        • add_verb_to_section
        • as_router
        • get_basic_auth_credentials
        • get_document
        • manual_set_proxy_url
        • on_request
        • register_routing_callback
        • register_verb_handler
        • render_document
        • reset_document
        • serve
        • stop
      • WebService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • Chat
      • Compat
      • Datasphere
      • Fabric
      • Imported Numbers
      • Logs
      • Lookup
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSub
      • Queues
      • Recordings
      • Registry
      • RestClient
      • Short Codes
      • SignalWireRestError
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Returns
  • Example
AgentsSWMLService

render_document

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

reset_document

Next
Built with

Render the current SWML document as a JSON string. This is the serialized form that gets returned to SignalWire when a call requests SWML.

Returns

str — The SWML document serialized as a JSON string.

Example

1from signalwire import SWMLService
2
3service = SWMLService(name="my-service")
4service.add_verb("answer", {})
5service.add_verb("hangup", {})
6
7json_str = service.render_document()
8print(json_str)
9# '{"version": "1.0.0", "sections": {"main": [{"answer": {}}, {"hangup": {}}]}}'