For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogoSignalWire Docs
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
      • Webhook Signature Validation
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • PromptObjectModel
      • SkillBase
      • SkillManager
      • SkillRegistry
        • addSearchPath
        • addSkillDirectory
        • clear
        • create
        • discoverAll
        • discoverFromDirectory
        • getAllSkillsSchema
        • getExternalPaths
        • getInstance
        • getSearchPaths
        • getSkillClass
        • getSkillSchema
        • has
        • listAllSkillSources
        • listRegistered
        • listSkills
        • lock
        • register
        • resetInstance
        • unregister
      • 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
  • Overview
  • Webhook signature validation
  • make_webhook_validation_dependency
  • validate_request
  • validate_webhook_signature
  • Overview
  • AgentBase
  • add_answer_verb
  • add_function_include
  • add_hint
  • add_hints
  • add_internal_filler
  • add_language
  • add_mcp_server
  • add_pattern_hint
  • add_post_ai_verb
  • add_post_answer_verb
  • add_pre_answer_verb
  • add_pronunciation
  • add_skill
  • add_swaig_query_params
  • as_router
  • auto_map_sip_usernames
  • clear_post_ai_verbs
  • clear_post_answer_verbs
  • clear_pre_answer_verbs
  • clear_swaig_query_params
  • define_contexts
  • define_tool
  • define_tools
  • enable_debug_events
  • enable_debug_routes
  • enable_mcp_server
  • enable_sip_routing
  • get_app
  • get_basic_auth_credentials
  • get_full_url
  • get_language_params
  • get_name
  • get_post_prompt
  • get_prompt
  • handle_serverless_request
  • has_skill
  • list_skills
  • manual_set_proxy_url
  • on_debug_event
  • on_function_call
  • on_summary
  • on_swml_request
  • prompt_add_section
  • prompt_add_subsection
  • prompt_add_to_section
  • prompt_has_section
  • register_routing_callback
  • register_sip_username
  • register_swaig_function
  • remove_skill
  • reset_contexts
  • run
  • serve
  • set_dynamic_config_callback
  • set_function_includes
  • set_global_data
  • set_internal_fillers
  • set_language_params
  • set_languages
  • set_native_functions
  • set_param
  • set_params
  • set_post_prompt
  • set_post_prompt_llm_params
  • set_post_prompt_url
  • set_prompt_llm_params
  • set_prompt_pom
  • set_prompt_text
  • set_pronunciations
  • set_web_hook_url
  • setup_graceful_shutdown
  • update_global_data
  • validate_basic_auth
  • AgentServer
  • get_agent
  • get_agents
  • register
  • register_global_routing_callback
  • run
  • serve_static_files
  • setup_sip_routing
  • unregister
  • BedrockAgent
  • set_inference_params
  • set_voice
  • CLI Tools
  • mcp-gateway
  • sw-agent-dokku
  • sw-agent-init
  • sw-search
  • swaig-test
  • Configuration
  • AuthHandler
  • flask_decorator
  • get_auth_info
  • get_fastapi_dependency
  • verify_api_key
  • verify_basic_auth
  • verify_bearer_token
  • ConfigLoader
  • find_config_file
  • get
  • get_config
  • get_config_file
  • get_section
  • has_config
  • merge_with_env
  • substitute_vars
  • Environment Variables
  • SecurityConfig
  • get_basic_auth
  • get_cors_config
  • get_security_headers
  • get_ssl_context_kwargs
  • get_url_scheme
  • load_from_env
  • log_config
  • should_allow_host
  • validate_ssl_config
  • ContextBuilder
  • add_context
  • Context
  • add_bullets
  • add_enter_filler
  • add_exit_filler
  • add_section
  • add_step
  • add_system_bullets
  • add_system_section
  • get_step
  • move_step
  • remove_step
  • set_consolidate
  • set_enter_fillers
  • set_exit_fillers
  • set_full_reset
  • set_initial_step
  • set_isolated
  • set_post_prompt
  • set_prompt
  • set_system_prompt
  • set_user_prompt
  • set_valid_contexts
  • set_valid_steps
  • create_simple_context
  • GatherInfo & GatherQuestion
  • get_context
  • reset
  • Step
  • add_bullets
  • add_gather_question
  • add_section
  • clear_sections
  • set_end
  • set_functions
  • set_gather_info
  • set_reset_consolidate
  • set_reset_full_reset
  • set_reset_system_prompt
  • set_reset_user_prompt
  • set_skip_to_next_step
  • set_skip_user_turn
  • set_step_criteria
  • set_text
  • set_valid_contexts
  • set_valid_steps
  • to_dict
  • validate
  • DataMap
  • body
  • description
  • error_keys
  • expression
  • fallback_output
  • foreach
  • global_error_keys
  • helpers
  • output
  • parameter
  • params
  • purpose
  • to_swaig_function
  • webhook
  • webhook_expressions
  • FunctionResult
  • add_action
  • add_actions
  • add_dynamic_hints
  • clear_dynamic_hints
  • connect
  • create_payment_action
  • create_payment_parameter
  • create_payment_prompt
  • enable_extensive_data
  • enable_functions_on_timeout
  • execute_rpc
  • execute_swml
  • hangup
  • hold
  • join_conference
  • join_room
  • pay
  • play_background_file
  • record_call
  • remove_global_data
  • remove_metadata
  • replace_in_history
  • rpc_ai_message
  • rpc_ai_unhold
  • rpc_dial
  • say
  • send_sms
  • set_end_of_speech_timeout
  • set_metadata
  • set_post_process
  • set_response
  • set_speech_event_timeout
  • simulate_user_input
  • sip_refer
  • stop
  • stop_background_file
  • stop_record_call
  • stop_tap
  • switch_context
  • swml_change_context
  • swml_change_step
  • swml_transfer
  • swml_user_event
  • tap
  • to_dict
  • toggle_functions
  • update_global_data
  • update_settings
  • wait_for_user
  • Helper Functions
  • LiveWire
  • Agent
  • on_enter
  • on_exit
  • on_user_turn_completed
  • Pipeline Nodes
  • update_instructions
  • update_tools
  • AgentServer
  • rtc_session
  • AgentSession
  • generate_reply
  • interrupt
  • say
  • start
  • update_agent
  • function_tool
  • Infrastructure
  • Plugins
  • run_app
  • RunContext
  • Signals
  • MCP Gateway
  • MCPClient
  • MCPGateway
  • run
  • shutdown
  • MCPService, MCPClient & MCPManager
  • create_client
  • get_service_tools
  • shutdown
  • validate_services
  • Session & SessionManager
  • close_session
  • create_session
  • get_session
  • list_sessions
  • shutdown
  • PomBuilder
  • add_section
  • add_subsection
  • add_to_section
  • from_sections
  • has_section / get_section
  • render_markdown / render_xml
  • to_dict
  • to_json
  • Prefabs
  • ConciergeAgent
  • FAQBotAgent
  • InfoGathererAgent
  • ReceptionistAgent
  • SurveyAgent
  • Search
  • DocumentProcessor
  • create_chunks
  • Helper Functions & Constants
  • IndexBuilder
  • build_index
  • build_index_from_sources
  • validate_index
  • SearchEngine
  • get_stats
  • search
  • SearchIndexMigrator
  • get_index_info
  • migrate_pgvector_to_sqlite
  • migrate_sqlite_to_pgvector
  • SearchService
  • search_direct
  • start
  • stop
  • SkillBase
  • cleanup
  • define_tool
  • get_global_data
  • get_hints
  • get_instance_key
  • get_parameter_schema
  • get_prompt_sections
  • get_skill_data
  • register_tools
  • setup
  • update_skill_data
  • validate_env_vars
  • validate_packages
  • Skills
  • api_ninjas_trivia
  • claude_skills
  • Custom Skills
  • datasphere
  • datasphere_serverless
  • datetime
  • google_maps
  • info_gatherer
  • joke
  • math
  • mcp_gateway
  • native_vector_search
  • play_background_file
  • spider
  • swml_transfer
  • weather_api
  • web_search
  • wikipedia_search
  • SWAIGFunction
  • execute
  • to_swaig
  • validate_args
  • SWMLBuilder
  • add_section
  • ai
  • answer
  • build
  • hangup
  • play
  • render
  • reset
  • say
  • 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
  • add_directory
  • remove_directory
  • start
  • stop
  • Overview
  • Actions
  • AIAction
  • stop
  • CollectAction
  • start_input_timers
  • stop
  • volume
  • DetectAction
  • stop
  • FaxAction
  • stop
  • PayAction
  • stop
  • PlayAction
  • pause
  • resume
  • stop
  • volume
  • RecordAction
  • pause
  • resume
  • stop
  • StandaloneCollectAction
  • start_input_timers
  • stop
  • StreamAction
  • stop
  • TapAction
  • stop
  • TranscribeAction
  • stop
  • Call
  • ai
  • ai_hold
  • ai_message
  • ai_unhold
  • amazon_bedrock
  • answer
  • bind_digit
  • clear_digit_bindings
  • collect
  • connect
  • denoise
  • denoise_stop
  • detect
  • disconnect
  • echo
  • hangup
  • hold
  • join_conference
  • join_room
  • leave_conference
  • leave_room
  • live_transcribe
  • live_translate
  • on
  • pass_
  • pay
  • play
  • play_and_collect
  • queue_enter
  • queue_leave
  • receive_fax
  • record
  • refer
  • send_digits
  • send_fax
  • stream
  • tap
  • transcribe
  • transfer
  • unhold
  • user_event
  • wait_for
  • wait_for_ended
  • Constants
  • Events
  • Message
  • on
  • wait
  • RelayClient
  • connect
  • dial
  • disconnect
  • execute
  • receive
  • run
  • send_message
  • unreceive
  • RelayError
  • Overview
  • Addresses
  • create
  • delete
  • get
  • list
  • Calling
  • ai_hold
  • ai_message
  • ai_stop
  • ai_unhold
  • collect
  • collect_start_input_timers
  • collect_stop
  • denoise
  • denoise_stop
  • detect
  • detect_stop
  • dial
  • disconnect
  • end
  • live_transcribe
  • live_translate
  • play
  • play_pause
  • play_resume
  • play_stop
  • play_volume
  • receive_fax_stop
  • record
  • record_pause
  • record_resume
  • record_stop
  • refer
  • send_fax_stop
  • stream
  • stream_stop
  • tap
  • tap_stop
  • transcribe
  • transcribe_stop
  • transfer
  • update
  • user_event
  • Chat
  • create_token
  • Compat
  • Accounts
  • create
  • get
  • list
  • update
  • Applications
  • create
  • delete
  • get
  • list
  • update
  • Calls
  • create
  • delete
  • get
  • list
  • start_recording
  • start_stream
  • stop_stream
  • update
  • update_recording
  • Conferences
  • delete_recording
  • get
  • get_participant
  • get_recording
  • list
  • list_participants
  • list_recordings
  • remove_participant
  • start_stream
  • stop_stream
  • update
  • update_participant
  • update_recording
  • Faxes
  • create
  • delete
  • delete_media
  • get
  • get_media
  • list
  • list_media
  • update
  • LAML Bins
  • create
  • delete
  • get
  • list
  • update
  • Messages
  • create
  • delete
  • delete_media
  • get
  • get_media
  • list
  • list_media
  • update
  • Phone Numbers
  • delete
  • get
  • import_number
  • list
  • list_available_countries
  • purchase
  • search_local
  • search_toll_free
  • update
  • Queues
  • create
  • delete
  • dequeue_member
  • get
  • get_member
  • list
  • list_members
  • update
  • Recordings
  • delete
  • get
  • list
  • Tokens
  • create
  • delete
  • update
  • Transcriptions
  • delete
  • get
  • list
  • Datasphere
  • create
  • delete
  • delete_chunk
  • get
  • get_chunk
  • list
  • list_chunks
  • search
  • update
  • Fabric
  • Addresses
  • AI Agents
  • create
  • delete
  • get
  • list
  • list_addresses
  • update
  • Call Flows
  • create
  • delete
  • deploy_version
  • get
  • list
  • list_addresses
  • list_versions
  • update
  • Conference Rooms
  • create
  • delete
  • get
  • list
  • list_addresses
  • update
  • cXML Applications
  • delete
  • get
  • list
  • list_addresses
  • update
  • cXML Scripts
  • create
  • delete
  • get
  • list
  • list_addresses
  • update
  • cXML Webhooks
  • create
  • delete
  • get
  • list
  • list_addresses
  • update
  • FreeSWITCH Connectors
  • create
  • delete
  • get
  • list
  • list_addresses
  • update
  • RELAY Applications
  • create
  • delete
  • get
  • list
  • list_addresses
  • update
  • Resources
  • assign_domain_application
  • assign_phone_route
  • delete
  • get
  • list
  • list_addresses
  • SIP Endpoints
  • create
  • delete
  • get
  • list
  • list_addresses
  • update
  • SIP Gateways
  • create
  • delete
  • get
  • list
  • list_addresses
  • update
  • Subscribers
  • create
  • create_sip_endpoint
  • delete
  • delete_sip_endpoint
  • get
  • get_sip_endpoint
  • list
  • list_addresses
  • list_sip_endpoints
  • update
  • update_sip_endpoint
  • SWML Scripts
  • create
  • delete
  • get
  • list
  • list_addresses
  • update
  • SWML Webhooks
  • create
  • delete
  • get
  • list
  • list_addresses
  • update
  • Tokens
  • create_embed_token
  • create_guest_token
  • create_invite_token
  • create_subscriber_token
  • refresh_subscriber_token
  • Imported Numbers
  • create
  • Logs
  • Conference Logs
  • list
  • Fax Logs
  • get
  • list
  • Message Logs
  • get
  • list
  • Voice Logs
  • get
  • list
  • list_events
  • Lookup
  • phone_number
  • MFA
  • call
  • sms
  • verify
  • Number Groups
  • add_membership
  • create
  • delete
  • delete_membership
  • get
  • get_membership
  • list
  • list_memberships
  • update
  • Phone Numbers
  • create
  • delete
  • get
  • list
  • search
  • set_ai_agent
  • set_call_flow
  • set_cxml_application
  • set_cxml_webhook
  • set_relay_application
  • set_relay_topic
  • set_swml_webhook
  • update
  • Project
  • create
  • delete
  • update
  • PubSub
  • create_token
  • Queues
  • create
  • delete
  • get
  • get_member
  • get_next_member
  • list
  • list_members
  • update
  • Recordings
  • delete
  • get
  • list
  • Registry
  • Brands
  • create
  • create_campaign
  • get
  • list
  • list_campaigns
  • Campaigns
  • create_order
  • get
  • list_numbers
  • list_orders
  • update
  • Numbers
  • Orders
  • RestClient
  • Short Codes
  • get
  • list
  • update
  • SignalWireRestError
  • SIP Profile
  • get
  • update
  • Verified Callers
  • create
  • delete
  • get
  • list
  • redial_verification
  • submit_verification
  • update
  • Video
  • VideoConferences
  • create
  • create_stream
  • delete
  • get
  • list
  • list_conference_tokens
  • list_streams
  • update
  • VideoConferenceTokens
  • get
  • reset
  • VideoRoomRecordings
  • delete
  • get
  • list
  • list_events
  • VideoRooms
  • create
  • create_stream
  • delete
  • get
  • list
  • list_streams
  • update
  • VideoRoomSessions
  • get
  • list
  • list_events
  • list_members
  • list_recordings
  • VideoRoomTokens
  • create
  • VideoStreams
  • delete
  • get
  • update
  • Overview
  • Webhook Signature Validation
  • validateRequest
  • validateWebhookSignature
  • webhookValidationMiddleware
  • Overview
  • AgentBase
  • addAnswerVerb
  • addFunctionInclude
  • addHint
  • addHints
  • addInternalFiller
  • addLanguage
  • addMcpServer
  • addPatternHint
  • addPostAiVerb
  • addPostAnswerVerb
  • addPreAnswerVerb
  • addPronunciation
  • addSkill
  • addSkillByName
  • addSwaigQueryParams
  • asRouter
  • autoMapSipUsernames
  • clearPostAiVerbs
  • clearPostAnswerVerbs
  • clearPreAnswerVerbs
  • clearSwaigQueryParams
  • createToolToken
  • defineContexts
  • defineTool
  • defineTools
  • defineTypedTool
  • enableDebugEvents
  • enableDebugRoutes
  • enableMcpServer
  • enableSipRouting
  • extractSipUsername
  • getApp
  • getBasicAuthCredentials
  • getContexts
  • getFullUrl
  • getLanguageParams
  • getMcpServers
  • getName
  • getPostPrompt
  • getPrompt
  • getPromptPom
  • getRawPrompt
  • getRegisteredTools
  • getTool
  • handleMcpRequest
  • hasSkill
  • isMcpServerEnabled
  • listSkills
  • manualSetProxyUrl
  • onDebugEvent
  • onFunctionCall
  • onRequest
  • onSummary
  • onSwmlRequest
  • pom
  • promptAddSection
  • promptAddSubsection
  • promptAddToSection
  • promptHasSection
  • registerSipUsername
  • registerSwaigFunction
  • removeSkill
  • removeSkillByName
  • renderSwml
  • resetContexts
  • run
  • serve
  • setDynamicConfigCallback
  • setFunctionIncludes
  • setGlobalData
  • setInternalFillers
  • setLanguageParams
  • setLanguages
  • setNativeFunctions
  • setParam
  • setParams
  • setPostPrompt
  • setPostPromptLlmParams
  • setPostPromptUrl
  • setPromptLlmParams
  • setPromptPom
  • setPromptText
  • setPronunciations
  • setupGracefulShutdown
  • setWebHookUrl
  • updateGlobalData
  • validateBasicAuth
  • validateToolToken
  • AgentServer
  • getAgent
  • getAgents
  • getApp
  • register
  • registerGlobalRoutingCallback
  • run
  • serveStaticFiles
  • setupSipRouting
  • unregister
  • Configuration
  • AuthHandler
  • expressMiddleware
  • getAuthInfo
  • hasApiKeyAuth
  • hasBasicAuth
  • hasBearerAuth
  • middleware
  • validate
  • verifyApiKey
  • verifyBasicAuth
  • verifyBearerToken
  • ConfigLoader
  • findConfigFile
  • get
  • getAll
  • getConfig
  • getConfigFile
  • getFilePath
  • getSection
  • has
  • hasConfig
  • interpolateEnvVars
  • load
  • loadFromObject
  • mergeWithEnv
  • search
  • set
  • substituteVars
  • Environment Variables
  • Logging
  • PromptManager
  • addSection
  • addSubsection
  • addToSection
  • getPomBuilder
  • getPostPrompt
  • getPrompt
  • getRawPrompt
  • hasSection
  • setPostPrompt
  • setPromptText
  • SchemaUtils
  • clearCache
  • getCacheSize
  • getVerbDescription
  • getVerbNames
  • getVerbProperties
  • getVerbRequiredProperties
  • hasVerb
  • validate
  • validateVerb
  • ServerlessAdapter
  • createAzureHandler
  • createGcfHandler
  • createLambdaHandler
  • detectPlatform
  • generateUrl
  • getPlatform
  • handleRequest
  • SessionManager
  • cleanup
  • createSession
  • createToolToken
  • debugToken
  • deleteSessionMetadata
  • generateToken
  • getSessionMetadata
  • setSessionMetadata
  • validateToken
  • validateToolToken
  • SslConfig
  • getCert
  • getHstsHeader
  • getKey
  • getServerOptions
  • hstsMiddleware
  • isConfigured
  • ContextBuilder
  • addContext
  • Context
  • addBullets
  • addEnterFiller
  • addExitFiller
  • addSection
  • addStep
  • addSystemBullets
  • addSystemSection
  • getStep
  • moveStep
  • removeStep
  • setConsolidate
  • setEnterFillers
  • setExitFillers
  • setFullReset
  • setInitialStep
  • setIsolated
  • setPostPrompt
  • setPrompt
  • setSystemPrompt
  • setUserPrompt
  • setValidContexts
  • setValidSteps
  • createSimpleContext
  • GatherInfo & GatherQuestion
  • getCompletionAction
  • getContext
  • getGatherInfo
  • getQuestions
  • getStepOrder
  • getSteps
  • getValidContexts
  • reset
  • Step
  • addBullets
  • addGatherQuestion
  • addSection
  • clearSections
  • setEnd
  • setFunctions
  • setGatherInfo
  • setResetConsolidate
  • setResetFullReset
  • setResetSystemPrompt
  • setResetUserPrompt
  • setSkipToNextStep
  • setSkipUserTurn
  • setStepCriteria
  • setText
  • setValidContexts
  • setValidSteps
  • toDict
  • validate
  • DataMap
  • body
  • description
  • enableEnvExpansion
  • errorKeys
  • expression
  • fallbackOutput
  • foreach
  • globalErrorKeys
  • helpers
  • output
  • parameter
  • params
  • purpose
  • registerWithAgent
  • setAllowedEnvPrefixes
  • toSwaigFunction
  • webhook
  • webhookExpressions
  • FunctionResult
  • addAction
  • addActions
  • addDynamicHints
  • clearDynamicHints
  • connect
  • createPaymentAction
  • createPaymentParameter
  • createPaymentPrompt
  • enableExtensiveData
  • enableFunctionsOnTimeout
  • executeRpc
  • executeSwml
  • hangup
  • hold
  • joinConference
  • joinRoom
  • pay
  • playBackgroundFile
  • recordCall
  • removeGlobalData
  • removeMetadata
  • replaceInHistory
  • rpcAiMessage
  • rpcAiUnhold
  • rpcDial
  • say
  • sendSms
  • setEndOfSpeechTimeout
  • setMetadata
  • setPostProcess
  • setResponse
  • setSpeechEventTimeout
  • simulateUserInput
  • sipRefer
  • stop
  • stopBackgroundFile
  • stopRecordCall
  • stopTap
  • switchContext
  • swmlChangeContext
  • swmlChangeStep
  • swmlTransfer
  • swmlUserEvent
  • tap
  • toDict
  • toggleFunctions
  • updateGlobalData
  • updateSettings
  • waitForUser
  • Helper Functions & Utilities
  • LiveWire
  • Agent
  • AgentSession
  • generateReply
  • interrupt
  • say
  • start
  • updateAgent
  • Infrastructure
  • Plugins
  • runApp
  • RunContext
  • Signals
  • tool / FunctionTool
  • PomBuilder
  • addPomAsSubsection
  • addSection
  • addSubsection
  • addToSection
  • findSection
  • fromSections
  • getSection
  • hasSection
  • pom
  • renderMarkdown
  • renderXml
  • reset
  • toDict
  • toJson
  • Prefabs
  • ConciergeAgent
  • FAQBotAgent
  • InfoGathererAgent
  • ReceptionistAgent
  • SurveyAgent
  • PromptObjectModel
  • addPomAsSubsection
  • addSection
  • findSection
  • fromJson
  • fromYaml
  • renderMarkdown
  • renderXml
  • Section
  • toDict
  • toJson
  • toYaml
  • SkillBase
  • cleanup
  • defineTool
  • getAgent
  • getConfig
  • getDataMapTools
  • getGlobalData
  • getHints
  • getInstanceKey
  • getParameterSchema
  • getPromptSections
  • getSkillData
  • getSkillNamespace
  • getTools
  • hasAllEnvVars
  • hasAllPackages
  • isInitialized
  • markInitialized
  • setAgent
  • setup
  • updateSkillData
  • validateEnvVars
  • validatePackages
  • SkillManager
  • addSkill
  • clear
  • getAllHints
  • getAllPromptSections
  • getAllTools
  • getLoadedSkillEntries
  • getMergedGlobalData
  • getSkill
  • hasSkill
  • hasSkillByKey
  • listSkillKeys
  • listSkills
  • loadedSkills
  • loadSkill
  • loadSkillByName
  • removeSkill
  • removeSkillByName
  • SkillRegistry
  • addSearchPath
  • addSkillDirectory
  • clear
  • create
  • discoverAll
  • discoverFromDirectory
  • getAllSkillsSchema
  • getExternalPaths
  • getInstance
  • getSearchPaths
  • getSkillClass
  • getSkillSchema
  • has
  • listAllSkillSources
  • listRegistered
  • listSkills
  • lock
  • register
  • resetInstance
  • unregister
  • Skills
  • ApiNinjasTriviaSkill
  • AskClaudeSkill
  • ClaudeSkillsSkill
  • CustomSkillsSkill
  • DataSphereServerlessSkill
  • DataSphereSkill
  • DateTimeSkill
  • GoogleMapsSkill
  • InfoGathererSkill
  • JokeSkill
  • MathSkill
  • McpGatewaySkill
  • NativeVectorSearchSkill
  • PlayBackgroundFileSkill
  • SpiderSkill
  • SwmlTransferSkill
  • WeatherApiSkill
  • WebSearchSkill
  • WikipediaSearchSkill
  • SwaigFunction
  • execute
  • toSwaig
  • validateArgs
  • SwmlBuilder
  • addSection
  • addVerb
  • addVerbToSection
  • ai
  • answer
  • build
  • document
  • getDocument
  • getSchemaUtils
  • hangup
  • play
  • render
  • renderDocument
  • reset
  • say
  • setValidation
  • SWMLService
  • addSection
  • addVerb
  • addVerbToSection
  • asRouter
  • defineTool
  • extractSipUsername
  • getAllFunctions
  • getApp
  • getBasicAuthCredentials
  • getBuilder
  • getDocument
  • getFunction
  • getRegisteredTools
  • getTool
  • hasFunction
  • hasTool
  • listToolNames
  • manualSetProxyUrl
  • onFunctionCall
  • registerRoutingCallback
  • registerSwaigFunction
  • registerVerbHandler
  • removeFunction
  • renderDocument
  • renderSwml
  • resetDocument
  • run
  • serve
  • setOnRequestCallback
  • stop
  • validateBasicAuth
  • Overview
  • Actions
  • AIAction
  • stop
  • CollectAction
  • startInputTimers
  • stop
  • volume
  • DetectAction
  • stop
  • FaxAction
  • stop
  • PayAction
  • stop
  • PlayAction
  • pause
  • resume
  • stop
  • volume
  • RecordAction
  • pause
  • resume
  • stop
  • StandaloneCollectAction
  • startInputTimers
  • stop
  • StreamAction
  • stop
  • TapAction
  • stop
  • TranscribeAction
  • stop
  • Call
  • ai
  • aiHold
  • aiMessage
  • aiUnhold
  • amazonBedrock
  • answer
  • bindDigit
  • clearDigitBindings
  • collect
  • connect
  • denoise
  • denoiseStop
  • detect
  • disconnect
  • echo
  • hangup
  • hold
  • joinConference
  • joinRoom
  • leaveConference
  • leaveRoom
  • liveTranscribe
  • liveTranslate
  • on
  • pass
  • pay
  • play
  • playAndCollect
  • queueEnter
  • queueLeave
  • receiveFax
  • record
  • refer
  • sendDigits
  • sendFax
  • stream
  • tap
  • transcribe
  • transfer
  • unhold
  • userEvent
  • waitFor
  • waitForEnded
  • Constants
  • Events
  • Message
  • on
  • wait
  • RelayClient
  • connect
  • dial
  • disconnect
  • execute
  • notify
  • onCall
  • onEvent
  • onMessage
  • receive
  • run
  • sendMessage
  • unreceive
  • RelayError
  • Overview
  • Addresses
  • create
  • delete
  • get
  • list
  • Calling
  • aiHold
  • aiMessage
  • aiStop
  • aiUnhold
  • collect
  • collectStartInputTimers
  • collectStop
  • denoise
  • denoiseStop
  • detect
  • detectStop
  • dial
  • disconnect
  • end
  • liveTranscribe
  • liveTranslate
  • play
  • playPause
  • playResume
  • playStop
  • playVolume
  • receiveFaxStop
  • record
  • recordPause
  • recordResume
  • recordStop
  • refer
  • sendFaxStop
  • stream
  • streamStop
  • tap
  • tapStop
  • transcribe
  • transcribeStop
  • transfer
  • update
  • userEvent
  • ChatResource
  • createToken
  • Compat
  • Accounts
  • create
  • get
  • list
  • update
  • Applications
  • create
  • delete
  • get
  • list
  • update
  • Calls
  • create
  • delete
  • get
  • list
  • startRecording
  • startStream
  • stopStream
  • update
  • updateRecording
  • Conferences
  • deleteRecording
  • get
  • getParticipant
  • getRecording
  • list
  • listParticipants
  • listRecordings
  • removeParticipant
  • startStream
  • stopStream
  • update
  • updateParticipant
  • updateRecording
  • Faxes
  • create
  • delete
  • deleteMedia
  • get
  • getMedia
  • list
  • listMedia
  • update
  • LAML Bins
  • create
  • delete
  • get
  • list
  • update
  • Messages
  • create
  • delete
  • deleteMedia
  • get
  • getMedia
  • list
  • listMedia
  • update
  • Phone Numbers
  • delete
  • get
  • importNumber
  • list
  • listAvailableCountries
  • purchase
  • searchLocal
  • searchTollFree
  • update
  • Queues
  • create
  • delete
  • dequeueMember
  • get
  • getMember
  • list
  • listMembers
  • update
  • Recordings
  • delete
  • get
  • list
  • Tokens
  • create
  • delete
  • update
  • Transcriptions
  • delete
  • get
  • list
  • Datasphere
  • create
  • delete
  • deleteChunk
  • get
  • getChunk
  • list
  • listChunks
  • search
  • update
  • Fabric
  • Addresses
  • AI Agents
  • create
  • delete
  • get
  • list
  • listAddresses
  • update
  • Call Flows
  • create
  • delete
  • deployVersion
  • get
  • list
  • listAddresses
  • listVersions
  • update
  • Conference Rooms
  • create
  • delete
  • get
  • list
  • listAddresses
  • update
  • cXML Applications
  • delete
  • get
  • list
  • listAddresses
  • update
  • cXML Scripts
  • create
  • delete
  • get
  • list
  • listAddresses
  • update
  • cXML Webhooks
  • create
  • delete
  • get
  • list
  • listAddresses
  • update
  • FreeSWITCH Connectors
  • create
  • delete
  • get
  • list
  • listAddresses
  • update
  • RELAY Applications
  • create
  • delete
  • get
  • list
  • listAddresses
  • update
  • Resources
  • assignDomainApplication
  • assignPhoneRoute
  • delete
  • get
  • list
  • listAddresses
  • SIP Endpoints
  • create
  • delete
  • get
  • list
  • listAddresses
  • update
  • SIP Gateways
  • create
  • delete
  • get
  • list
  • listAddresses
  • update
  • Subscribers
  • create
  • createSipEndpoint
  • delete
  • deleteSipEndpoint
  • get
  • getSipEndpoint
  • list
  • listAddresses
  • listSipEndpoints
  • update
  • updateSipEndpoint
  • SWML Scripts
  • create
  • delete
  • get
  • list
  • listAddresses
  • update
  • SWML Webhooks
  • create
  • delete
  • get
  • list
  • listAddresses
  • update
  • Tokens
  • createEmbedToken
  • createGuestToken
  • createInviteToken
  • createSubscriberToken
  • refreshSubscriberToken
  • ImportedNumbersResource
  • create
  • Logs
  • Conference Logs
  • list
  • Fax Logs
  • get
  • list
  • Message Logs
  • get
  • list
  • Voice Logs
  • get
  • list
  • listEvents
  • LookupResource
  • phoneNumber
  • MFA
  • call
  • sms
  • verify
  • Number Groups
  • addMembership
  • create
  • delete
  • deleteMembership
  • get
  • getMembership
  • list
  • listMemberships
  • update
  • Phone Numbers
  • create
  • delete
  • get
  • list
  • search
  • setAiAgent
  • setCallFlow
  • setCxmlApplication
  • setCxmlWebhook
  • setRelayApplication
  • setRelayTopic
  • setSwmlWebhook
  • update
  • Project
  • create
  • delete
  • update
  • PubSubResource
  • createToken
  • Queues
  • create
  • delete
  • get
  • getMember
  • getNextMember
  • list
  • listMembers
  • update
  • Recordings
  • delete
  • get
  • list
  • Registry
  • Brands
  • create
  • createCampaign
  • get
  • list
  • listCampaigns
  • Campaigns
  • createOrder
  • get
  • listNumbers
  • listOrders
  • update
  • Numbers
  • Orders
  • RestClient
  • RestError
  • Short Codes
  • get
  • list
  • update
  • SIP Profile
  • get
  • update
  • Verified Callers
  • create
  • delete
  • get
  • list
  • redialVerification
  • submitVerification
  • update
  • Video
  • Room Recordings
  • delete
  • get
  • list
  • listEvents
  • Room Sessions
  • get
  • list
  • listEvents
  • listMembers
  • listRecordings
  • Room Tokens
  • create
  • Rooms
  • create
  • createStream
  • delete
  • get
  • list
  • listStreams
  • update
  • VideoConferences
  • create
  • createStream
  • delete
  • get
  • list
  • listConferenceTokens
  • listStreams
  • update
  • VideoConferenceTokens
  • get
  • reset
  • VideoStreams
  • delete
  • get
  • update
Log inSign up
Support
On this page
  • Parameters
  • Returns
AgentsSkillRegistry

getExternalPaths

|View as Markdown|Open in Claude|

Get a copy of the external skill directories registered via addSkillDirectory().

Parameters

None.

Returns

string[] — A copy of the registered external directory paths.

Was this page helpful?
Edit this page
Previous

getInstance

Next
Built with