SignalWire Docs

# SignalWire Developer Documentation

> SignalWire provide comprehensive and easy to use APIs that allow developers to reate unified communication applications.

- [SignalWire Docs](/index.md): Build performant and scalable real-time communications applications on the programmable cloud platform built for developers.


## Ai

- [AI](/ai.md): Programmable, integrated, realtime voice AI
- [AI Guides](/ai/guides.md): Get started with AI using our Quickstart guide.
- [AI platform capabilities](/ai/get-started/platform-capabilities.md): Learn about the capabilities of SignalWire's AI platform, including natural language processing, voice technology, business applications, advanced features, multi-channel intelligence, real-time analytics, and security.
- [Best practices](/ai/get-started/prompt-engineering/best-practices.md): Master the core techniques and guidelines for crafting effective prompts for SignalWire AI Agents.
- [Best Practices for Creating a SignalWire AI Agent](/ai/guides/best-practices.md): This guide offers a detailed overview of best 
practices to make sure your SignalWire Agent operates 
effectively.

- [Create your first phone AI Agent](/ai/get-started.md): Deploy a serverless AI Agent and call it over the PSTN in under 5 minutes - for free
- [Integrations](/ai/guides/integrations.md): Learn how to integrate different AI services with SignalWire
- [LiveKit integration](/ai/guides/integrations/livekit.md): Integrate LiveKit Agents with SignalWire's infrastructure
- [Make outbound LiveKit Agent calls via SignalWire](/ai/guides/integrations/livekit/outbound.md): Route LiveKit Calls onto the PSTN with SignalWire.
- [Outbound Calling](/ai/guides/integrations/vapi/outbound-calls.md): Configure VAPI AI assistants to make outbound calls through SignalWire's infrastructure
- [POM technical reference](/ai/pom/technical-reference.md): Learn more about the Prompt Object Model
- [Prompt engineering](/ai/get-started/prompt-engineering.md): Learn the fundamentals of prompt engineering and how it can help you create responsive and reliable AI agents for your SignalWire applications.
- [Prompt object model (POM)](/ai/pom.md): A lightweight Python library for structured prompt management with LLMs
- [Route inbound calls to a LiveKit Agent](/ai/guides/integrations/livekit/inbound.md): Route calls to LiveKit via SIP and SWML's Connect method.
- [VAPI Inbound Calling](/ai/guides/integrations/vapi/inbound-calls.md): Route incoming calls from SignalWire phone numbers to VAPI AI assistants using SIP trunking
- [VAPI Integration](/ai/guides/integrations/vapi.md): Integrate VAPI AI assistants with SignalWire's infrastructure
- [Where to apply prompt engineering](/ai/get-started/prompt-engineering/where-to-apply.md): Learn about the different areas where prompt engineering can be applied in SignalWire AI Agents for optimal results.

## API OpenAPI Spec

> The OpenAPI Spec defiitions.

- [Calling API Spec](/assets/llms-txt/attachments/openapi.md): The OpenAPI spec for the SignalWire Calling API.

## Call Flow Builder

- [AI Agent](/call-flow-builder/ai-agent.md): Call Flow Builder node to connect to an AI Agent
- [Answer Call](/call-flow-builder/answer-call.md): Call Flow Builder node to answer an incoming call.
- [Call Flow Builder](/call-flow-builder.md): Learn about the Call Flow Builder, a visual tool for creating and managing call flows.
- [Conditions](/call-flow-builder/conditions.md): Call Flow Builder node to add conditions to your call flow.
- [Execute SWML](/call-flow-builder/execute-swml.md): Call Flow Builder node to execute a remote SWML document and return to the current document.
- [Forward to Phone](/call-flow-builder/forward-to-phone.md): Call Flow Builder node to forward the call to a phone number.
- [Gather Input](/call-flow-builder/gather-input.md): Call Flow Builder node to gather input from the caller.
- [Handle Call](/call-flow-builder/handle-call.md): Call Flow Builder node to handle an incoming call.
- [Hang Up Call](/call-flow-builder/hangup-call.md): Call Flow Builder node to hang up a call.
- [Nodes](/call-flow-builder/nodes.md): Call Flow Builder
- [Play Audio or TTS](/call-flow-builder/play-audio-or-tts.md): Call Flow Builder node to play audio or TTS to the caller.
- [Request](/call-flow-builder/request.md): Call Flow Builder node to make an HTTP request
- [Send SMS](/call-flow-builder/send_sms.md): Call Flow Builder node to send an SMS
- [Set Variables](/call-flow-builder/set-variables.md): Call Flow Builder node to set variables in the call flow.
- [Start Call Recording](/call-flow-builder/start-call-recording.md): Call Flow Builder node to start recording a call.
- [Stop Call Recording](/call-flow-builder/stop-call-recording.md): Call Flow Builder node to stop recording a call.
- [Unset Variables](/call-flow-builder/unset-variables.md): Call Flow Builder node to unset variables in the call flow.
- [Variables](/call-flow-builder/variables.md): Call Flow Builder
- [Voicemail Recording](/call-flow-builder/voicemail-recording.md): Call Flow Builder node to record voicemail messages.

## Cantina

- [Administrator Guide for SignalWire Work/Events](/cantina/user-guide-for-admin-rights.md): Getting started with an Administrator account
- [User Guide for SignalWire Work/Events](/cantina/user-guide.md): A comprehensive user guide for the SignalWire Work and Events products.

## Chat

- [Building Chat Apps with React](/chat/guides/build-a-react-chat-application.md): Learn how to build a chat application with React.
- [Chat](/chat.md): Programmable, integrated, low-latency Chat APIs and SDKs
- [Chat FAQs](/chat/faq.md): Chat can be used to send and receive any JSON-serializable object.
- [First steps with Chat](/chat/getting-started/chat-first-steps.md): Quickly implement a full-fledged chat into your web application.
- [Getting Started](/chat/getting-started.md): Learn how to get started with the SignalWire Chat API.
- [Guides](/chat/guides.md): Learn how to use the SignalWire Chat API.
- [Simple Chat Demo](/chat/getting-started/get-started-with-a-simple-chat-demo.md): In this guide we will explore a simple chat application built using the SignalWire SDK.
- [Using Chat to Send SMS and Make Calls](/chat/guides/using-chat-to-send-sms-and-make-calls.md): Learn how to use the SignalWire Chat API to send SMS and make calls.

## Compatibility Api

- [<Conference> noun](/compatibility-api/cxml/voice/conference-noun.md): ` verb's ` noun allows the connection to a named conference room.
- [<Connect>](/compatibility-api/cxml/voice/connect.md): The `` verb connects an existing call to another resource.
- [<Denoise>](/compatibility-api/cxml/voice/denoise.md): The `` verb enables or disables noise reduction for call audio inbound to SignalWire. It
- [<Dial>](/compatibility-api/cxml/voice/dial.md): The ` verb connects an existing call to another phone number. ` will end this new call if: the called number does not answer, the number does not exist, or SignalWire receives a busy signal.
- [<Echo>](/compatibility-api/cxml/voice/echo.md): The `` verb will echo audio back to the call.
- [<Enqueue>](/compatibility-api/cxml/voice/enqueue.md): The ` verb places a call in a specified call queue. If the specified queue does not exist, a new queue will be created and the call will be placed into that new queue. Calls can be dequeued through the  verb or removed from the queue through the ` verb.
- [<Gather>](/compatibility-api/cxml/voice/gather.md): The `` verb transcribes speech or collects digits during a call.
- [<Hangup>](/compatibility-api/cxml/voice/hangup.md): The ` verb ends a call. While ed calls are never answered, calls that use the ` verb for disconnection are still answered, becoming subject to billing.
- [<Leave>](/compatibility-api/cxml/voice/leave.md): The ` verb transfers a call out of the queue containing that call. It then returns the flow of execution to verb following the ` that placed this call into the queue.
- [<Message>](/compatibility-api/cxml/messaging/message.md): The ` verb sends an SMS or MMS message to a phone number. To send a message in combination with Voice XML verbs, use the ` Voice verb.
- [<Number> noun](/compatibility-api/cxml/voice/number-noun.md): ` verb's  noun specifies what phone number to dial. You can use up to 10 s within a ` to simultaneously call several people. The first person to answer the call will be connected to the caller and the rest of the called numbers will be hung up.
- [<Parameter>](/compatibility-api/cxml/voice/pay/parameter.md): The ` noun within the ` verb enables you to:
- [<Pause>](/compatibility-api/cxml/voice/pause.md): The `` verb waits silently for a distinctive number of seconds.
- [<Pay>](/compatibility-api/cxml/voice/pay.md): Overview
- [<Play>](/compatibility-api/cxml/voice/play.md): The `` verb plays an audio file, which SignalWire fetches from the URL you configured, back to the caller.
- [<Prompt>](/compatibility-api/cxml/voice/pay/prompt.md): The ` noun allows you to customize the default prompts used by `.
- [<Queue> noun](/compatibility-api/cxml/voice/queue-noun.md): ` verb's ` noun specifies what queue to dial.
- [<Receive>](/compatibility-api/cxml/fax/receive.md): The `` verb tells SignalWire to receive an incoming fax, which results in the creation of a new Fax instance resource.
- [<Record>](/compatibility-api/cxml/voice/record.md): The `` verb creates an audio file with the caller's voice and returns the URL to you. Text transcriptions of these recorded calls can also be produced.
- [<Redirect>](/compatibility-api/cxml/messaging/redirect.md): The ` verb transfers control from the current document to another. It is effectively an exit statement from the current document, as there is no way to return to any instructions listed after the ` verb.
- [<Redirect>](/compatibility-api/cxml/voice/redirect.md): An example that redirects the next XML instruction to another call:
- [<Refer>](/compatibility-api/cxml/voice/refer.md): The ` verb transfers a SIP call in SignalWire to a transfer target using the SIP REFER method. This verb returns upon completion of transfer, on failure of transfer, on hangup, or on time out while waiting for NOTIFY. SignalWire will not hang up after ` until all verbs have been processed.
- [<Reject>](/compatibility-api/cxml/fax/reject.md): The ` verb tells SignalWire to reject an incoming fax, which results in a status of canceled`.
- [<Reject>](/compatibility-api/cxml/voice/reject.md): The ` verb rejects a call to your SignalWire number. It is effectively an exit statement from the current document, as there is no way to return to any instructions listed after the ` verb.