> For the complete documentation index, see [llms.txt](https://docs.bird.com/connectivity-platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bird.com/connectivity-platform/basics/flowbuilder-steps-glossary.md).

# FlowBuilder Steps Glossary

By going through this article, you will find a handy list of all the available steps in the [MessageBirds FlowBuilder](https://messagebird.com/en/flow-builder/). It just might give you an idea of the variety of available scenarios and use cases you can cover. Sit tight and read through.

#### &#x20;Table of contents <a href="#id-01g1jephgjwj4mqhsckk92xdzv" id="id-01g1jephgjwj4mqhsckk92xdzv"></a>

* [Before getting started](#01G1JEP0YJYXBA9JPTJJ1SQED4)
* [FlowBuilder Steps](#01G1JEN5K3HQACPTNEJEKWB75T)

&#x20;

#### Before getting started <a href="#id-01g1jep0yjyxba9jptjj1sqed4" id="id-01g1jep0yjyxba9jptjj1sqed4"></a>

You will need:

* A [MessageBird account](https://dashboard.messagebird.com/)

#### FlowBuilder Steps <a href="#id-01g1jen5k3hqacptnejekwb75t" id="id-01g1jen5k3hqacptnejekwb75t"></a>

Here is a complete list of all the available *Steps* in a given *Flow*:

&#x20;

| **Flow Controls**                                                                     |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p><br></p><p><img src="/files/RJqsJiRre6dFsmMU5KBx" alt="" data-size="original"></p> | Branch                                                                                                                                                       | Combine conditions to define how the Flow executes on an *if-then* basis                                                                                                                                                                                                                                                                             |
| <img src="/files/U8UIURxRjnm1oZrRRz4R" alt="" data-size="original">                   | [Date/Time](https://support.messagebird.com/hc/en-us/articles/360000347397-How-to-set-attributes-for-the-Date-Time-Step-)                                    | Define an action to perform if the hour and date conditions are met                                                                                                                                                                                                                                                                                  |
| <img src="/files/BwSOnlSXeEsPyNxEyGz1" alt="" data-size="original">                   | End of Flow                                                                                                                                                  | End the Flow after this step is used                                                                                                                                                                                                                                                                                                                 |
| <img src="/files/t3y4QlfxTkSusAcCRXTX" alt="" data-size="original">                   | Jump to                                                                                                                                                      | Jump to any other step in the Flow                                                                                                                                                                                                                                                                                                                   |
| **SMS**                                                                               |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| <img src="/files/W95RexYw4wO89bwACUSv" alt="" data-size="original">                   | [Send SMS](/connectivity-platform/how-to-guides/how-to-set-up-a-flow-to-send-outbound-sms.md)                                                                | <p>Send an outbound SMS.</p><p><strong>\*Requires an</strong> <a href="https://dashboard.messagebird.com/en/channels"><strong>SMS channel</strong></a></p>                                                                                                                                                                                           |
| <img src="/files/ZKSO9y8VGmZ4d0VFCEoZ" alt="" data-size="original">                   | [Subscribe to group](/connectivity-platform/contacts/managing-group-subscribers.md)                                                                          | Add the number which triggered the Flow to [Dashboard Contact Groups](https://dashboard.messagebird.com/en/contacts)                                                                                                                                                                                                                                 |
| <img src="/files/K3O9iau7MCtrlmQN6I4T" alt="" data-size="original">                   | [Unsubscribe from group](/connectivity-platform/contacts/managing-group-subscribers.md)                                                                      | Remove the number which triggered the Flow from [Dashboard Contact Groups](https://dashboard.messagebird.com/en/contacts)                                                                                                                                                                                                                            |
| <img src="/files/74THD828XS93WwkAYVZC" alt="" data-size="original">                   | Forward to group                                                                                                                                             | Forward an SMS that has started a Flow to an entire group of [Dashboard Contact Groups](https://dashboard.messagebird.com/en/contacts)                                                                                                                                                                                                               |
| <img src="/files/TgNziMnnq2KV7HAGMZV6" alt="" data-size="original">                   | Forward to email                                                                                                                                             | <p>Forward an SMS that has started a Flow to an e-mail address</p><p><strong>\*Requires an</strong> <a href="https://dashboard.messagebird.com/en/channels"><strong>SMS channel</strong></a></p>                                                                                                                                                     |
| <img src="/files/bb0BC7WcHrrbJZhu7LKw" alt="" data-size="original">                   | Forward SMS                                                                                                                                                  | <p>Forward an SMS that has started a Flow to another number</p><p><strong>\*Requires an</strong> <a href="https://dashboard.messagebird.com/en/channels"><strong>SMS channel</strong></a></p>                                                                                                                                                        |
| <img src="/files/F6AfkfnwwSGGV5ybN4yy" alt="" data-size="original">                   | Reply using SMS                                                                                                                                              | <p>Reply to a number that has triggered a Flow with a predefined SMS message</p><p><strong>\*Requires an</strong> <a href="https://dashboard.messagebird.com/en/channels"><strong>SMS channel</strong></a></p>                                                                                                                                       |
| **Messaging**                                                                         |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| <img src="/files/RQp6xosTzYXwX7TqPAva" alt="" data-size="original">                   | [Send conversation message](/connectivity-platform/steps-catalogue/using-the-send-conversation-message-step-in-flow-builder-video.md)                        | <p>Send messages in existing conversations, be it the 1st message or a reply to an inbound message, through any messaging channel (<em>WhatsApp, Telegram, Instagram</em>, etc).</p><p><strong>\*Requires at least one</strong> <a href="https://dashboard.messagebird.com/en/channels"><strong>channel</strong></a> <strong>configured</strong></p> |
| <img src="/files/8PmuafQ3sUjnsAJnEDE9" alt="" data-size="original">                   | [Send Facebook message](/connectivity-platform/steps-catalogue/using-flow-builder-to-send-facebook-meta-messenger-messages.md)                               | <p>Send messages in existing Facebook conversations. This includes exchanging rich messages like quick replies, carousels, media, and attachments.</p><p><strong>\*Requires a Messenger</strong> <a href="https://dashboard.messagebird.com/en/channels"><strong>channel</strong></a></p>                                                            |
| <img src="/files/iXYq1Jzo1Emt91rajrhL" alt="" data-size="original">                   | [Send Instagram message](/connectivity-platform/steps-catalogue/using-flowbuilder-to-send-instagram-messages.md)                                             | <p>Send messages in existing Instagram conversations. This includes exchanging rich messages like quick replies, carousels, media, and attachments.</p><p><strong>\*Requires an Instagram</strong> <a href="https://dashboard.messagebird.com/en/channels"><strong>channel</strong></a></p>                                                          |
| <img src="/files/3YNRIGVt5VOzmpj8NrW6" alt="" data-size="original">                   | [Send WhatsApp message](/connectivity-platform/steps-catalogue/using-flow-builder-to-send-whatsapp-messages.md)                                              | <p>Send messages in existing WhatsApp conversations. This includes exchanging rich messages like quick replies, product messages, Images, and attachments.</p><p><strong>\*Requires a WhatsApp</strong> <a href="https://dashboard.messagebird.com/en/channels"><strong>channel</strong></a></p>                                                     |
| <img src="/files/ljcyidlzdF9McojgyYZQ" alt="" data-size="original">                   | Send WhatsApp template message                                                                                                                               | <p>Send WhatsApp template messages</p><p><strong>\*Requires a WhatsApp</strong> <a href="https://dashboard.messagebird.com/en/channels"><strong>channel</strong></a></p>                                                                                                                                                                             |
| <img src="/files/t8FhFppdVmttbrSHZ1Xh" alt="" data-size="original">                   | Wait                                                                                                                                                         | Wait before executing the next step in FlowBuilder for the determined amount of time                                                                                                                                                                                                                                                                 |
| <img src="/files/miX7SEP9gQYjh93Lqd30" alt="" data-size="original">                   | [Wait for a response](/connectivity-platform/steps-catalogue/using-the-wait-for-a-response-step-in-flow-builder-video.md)                                    | Await a response from the end-user before continuing the Flow further                                                                                                                                                                                                                                                                                |
| **Email**                                                                             |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| <img src="/files/0TZwqoo57wdw2aRuKnKE" alt="" data-size="original">                   | Send an email                                                                                                                                                | <p>Send an outgoing email</p><p><strong>\*Requires an email</strong> <a href="https://dashboard.messagebird.com/en/channels"><strong>channel</strong></a></p>                                                                                                                                                                                        |
| **Inbox**                                                                             |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| <img src="/files/9bwC13TRkd42ndBZK42P" alt="" data-size="original">                   | Add a note                                                                                                                                                   | <p>Add an internal note to an <a href="https://inbox.messagebird.com/">Inbox</a> ticket</p><p><strong>\*Requires</strong> <a href="https://messagebird.com/en/pricing"><strong>Inbox</strong></a></p>                                                                                                                                                |
| <img src="/files/GjtTNKoqLu9lt3FZ8xPV" alt="" data-size="original">                   | Add Inbox contact                                                                                                                                            | <p>Add a new contact to the workspace's <a href="https://inbox.messagebird.com/contacts">Inbox contact list</a></p><p><strong>\*Requires</strong> <a href="https://messagebird.com/en/pricing"><strong>Inbox</strong></a></p>                                                                                                                        |
| <img src="/files/alAQ9ax4qkYlfQ4Fr0Tc" alt="" data-size="original">                   | Update Inbox contact                                                                                                                                         | <p>Update a contact in the workspace’s <a href="https://inbox.messagebird.com/contacts">Inbox contact list</a></p><p><strong>\*Requires</strong> <a href="https://messagebird.com/en/pricing"><strong>Inbox</strong></a></p>                                                                                                                         |
| <img src="/files/7ccixxCQTIwtC0Mu7PmM" alt="" data-size="original">                   | [Create Inbox ticket](/connectivity-platform/steps-catalogue/using-flow-builder-to-create-a-ticket-in-inbox.md)                                              | <p>Create an Inbox ticket in the workspace’s <a href="https://inbox.messagebird.com/">Inbox instance</a> with the latest end-users message</p><p><strong>\*Requires</strong> <a href="https://messagebird.com/en/pricing"><strong>Inbox</strong></a></p>                                                                                             |
| **Artificial Intelligence**                                                           |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| <img src="/files/gozLJsgIJ3TFzTTn51iH" alt="" data-size="original">                   | [Analyze image](/connectivity-platform/use-cases/detect-and-extract-text-from-images-with-flow-builder.md)                                                   | Extract the contents of an image (including [text](https://support.messagebird.com/hc/en-us/articles/360017490237-Detect-and-extract-text-from-images-with-Flow-Builder)) powered by machine learning                                                                                                                                                |
| <img src="/files/4eFb9qwhX2QgNRokvphx" alt="" data-size="original">                   | Analyze sentiment                                                                                                                                            | Recognizing the mood of the end-user based on the content of a message powered by machine learning                                                                                                                                                                                                                                                   |
| <img src="/files/W4r8ZG2glQCyZIepP7qw" alt="" data-size="original">                   | [Answer FAQ](/connectivity-platform/inbox-for-good/activate-faq-bots.md)                                                                                     | Answer frequently asked questions by putting to work the capabilities of [*Knowledge Bases*](/connectivity-platform/getting-started/best-practices-for-your-knowledge-base-datasets.md) solution                                                                                                                                                     |
| <img src="/files/thWbeTCS3VyZ7buaFDlw" alt="" data-size="original">                   | [Fill form](/connectivity-platform/getting-started/how-to-set-up-fill-form-in-flow-builder.md)                                                               | Capture a list of standardized data points by putting to work the capabilities of the [*Knowledge Bases Form*](/connectivity-platform/getting-started/best-practices-for-your-knowledge-base-datasets.md) feature                                                                                                                                    |
| <img src="/files/wT8vYdODBhpVTnL2nEdS" alt="" data-size="original">                   | [Recognize entities](/connectivity-platform/getting-started/how-to-set-up-entity-recognition-in-flow-builder.md)                                             | Recognize pieces of information and data entities in message content with a little help from machine learning                                                                                                                                                                                                                                        |
| <img src="/files/w6QSE9HegioxfL7LB8LD" alt="" data-size="original">                   | [Recognize intent](/connectivity-platform/getting-started/how-to-set-up-the-recognize-intent-step.md)                                                        | Recognize the user's intent in the message content and turn it into a variable, powered by  machine learning                                                                                                                                                                                                                                         |
| <img src="/files/uLnlubtfxFQh87XL2x3a" alt="" data-size="original">                   | [Recognize language](/connectivity-platform/set-up-inboxs-built-in-automations/language-recognition.md)                                                      | Recognize the language in the message content and turn it into a variable, powered by  machine learning                                                                                                                                                                                                                                              |
| <img src="/files/ozz5nMamOlA2Nd7hIAv7" alt="" data-size="original">                   | [Translate](/connectivity-platform/use-cases/automatically-detect-and-translate-the-language-in-your-customers-messages.md)                                  | Translate message content powered by machine learning                                                                                                                                                                                                                                                                                                |
| **Google**                                                                            |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| <img src="/files/MEplGgcnUz1BIzAVkXaR" alt="" data-size="original">                   | Add row in Google Sheets                                                                                                                                     | <p>Add a row into a Google Sheet of your choice</p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/integrations"><strong>Google Sheets Integration</strong></a></p>                                                                                                                                                   |
| <img src="/files/pUPq6nS2x8cuXYpuY6zS" alt="" data-size="original">                   | Create a Google Calendar Event                                                                                                                               | <p>Add a Google Calendar Event into a Google Calendar of your choice</p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/integrations"><strong>Google Calendar Integration</strong></a></p>                                                                                                                            |
| **Salesforce**                                                                        |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| <img src="/files/xNbzvk3HxGynuuYW9woM" alt="" data-size="original">                   | [Create Salesforce Lead](/connectivity-platform/integrations/connect-and-use-salesforce-with-flow-builder.md#h_01f32dgvz7npra05ncb8mhywqk)                   | <p>Create a new SF Lead in the connected <a href="https://dashboard.messagebird.com/en/integrations/salesforce/create">Salesforce integration</a></p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/integrations"><strong>Salesforce Integration</strong></a></p>                                                    |
| <img src="/files/xNbzvk3HxGynuuYW9woM" alt="" data-size="original">                   | [Create Salesforce Opportunity](/connectivity-platform/integrations/connect-and-use-salesforce-with-flow-builder.md#h_01f32dhgw7e3vey9qb94kpgg6a)            | <p>Create a new SF Opportunity in the connected <a href="https://dashboard.messagebird.com/en/integrations/salesforce/create">Salesforce integration</a></p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/integrations"><strong>Salesforce Integration</strong></a></p>                                             |
| <img src="/files/xNbzvk3HxGynuuYW9woM" alt="" data-size="original">                   | [Update Salesforce Lead](/connectivity-platform/integrations/connect-and-use-salesforce-with-flow-builder.md#h_01f32dh8vytjnm5326zezmf7hd)                   | <p>Update an SF LEad in the connected <a href="https://dashboard.messagebird.com/en/integrations/salesforce/create">Salesforce integration</a></p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/integrations"><strong>Salesforce Integration</strong></a></p>                                                       |
| **HTTP & Webhooks**                                                                   |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| <img src="/files/qEZIcPJhnWEaQjoKlMWz" alt="" data-size="original">                   | Await webhook                                                                                                                                                | Pause the Flow until the defined webhook is called                                                                                                                                                                                                                                                                                                   |
| <img src="/files/Ty2j84o5S5LfZ8SodFj9" alt="" data-size="original">                   | [Fetch variables](/connectivity-platform/steps-catalogue/fetching-variable-steps-in-flow-builder.md)                                                         | Fetch variables from external sources by using an HTTP request                                                                                                                                                                                                                                                                                       |
| <img src="/files/MfFLFcI1GOTFC0PKA5OB" alt="" data-size="original">                   | Forward to URL                                                                                                                                               | Forward the message which has started the Flow to a defined URL in the shape of a JSON payload                                                                                                                                                                                                                                                       |
| <img src="/files/Dj5ajxD9Prd1HVlMQCQv" alt="" data-size="original">                   | HTTP Request                                                                                                                                                 | Make an HTTP request to a defined URL                                                                                                                                                                                                                                                                                                                |
| **Voice**                                                                             |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| <img src="/files/UVlCpIfmOwEoX833u5sW" alt="" data-size="original">                   | Outbound call                                                                                                                                                | <p>Make an outbound call</p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/numbers"><strong>voice enabled number</strong></a></p>                                                                                                                                                                                    |
| <img src="/files/5xjRcY57bNDMKg8HgMGC" alt="" data-size="original">                   | End call                                                                                                                                                     | <p>Hang up a call</p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/numbers"><strong>voice enabled number</strong></a></p>                                                                                                                                                                                           |
| <img src="/files/NzxeqTNQJdAH2xQTDE5W" alt="" data-size="original">                   | Fetch call flow from URL                                                                                                                                     | <p>Fetch a call flow from an URL (<em>a web resource/container/DB</em>)</p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/numbers"><strong>voice enabled number</strong></a></p>                                                                                                                                     |
| <img src="/files/EBlkNLZvNeoaBrUtvFC2" alt="" data-size="original">                   | Forward call                                                                                                                                                 | <p>Forward an incoming call to a specified number or a SIP (<em>Session Initiation Protocol</em>) URI (<em>Uniform Resource Identifier</em>)</p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/numbers"><strong>voice enabled number</strong></a></p>                                                                |
| <img src="/files/RQ4dhjnTP1EP1OdTpPSq" alt="" data-size="original">                   | Forward call to Toky                                                                                                                                         | <p>Forward an incoming call to <a href="https://toky.co/en">Toky’s</a> cloud phone system</p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/integrations"><strong>Toky Integration</strong></a></p>                                                                                                                  |
| <img src="/files/zmOiRLT2bDgdtp8nQVT6" alt="" data-size="original">                   | If/else                                                                                                                                                      | Determine the next steps/journey of the Flow based on the user feedback (keypad input) or set condition                                                                                                                                                                                                                                              |
| <img src="/files/En01cGxIEoUEREcywerW" alt="" data-size="original">                   | IVR menu                                                                                                                                                     | <p>Set up an IVR (<em>Interactive Voice Response</em>) menu</p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/numbers"><strong>voice enabled number</strong></a></p>                                                                                                                                                 |
| <img src="/files/puCNBC66983zNjt4mTZ1" alt="" data-size="original">                   | Pause call Flow                                                                                                                                              | <p>Pause a Flow for a set amount of time</p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/numbers"><strong>voice enabled number</strong></a></p>                                                                                                                                                                    |
| <img src="/files/FIxebBzhRsGLbqb9jLSK" alt="" data-size="original">                   | Play sound file                                                                                                                                              | <p>Play a sound file set in the step</p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/numbers"><strong>voice enabled number</strong></a></p>                                                                                                                                                                        |
| <img src="/files/h8Mxa6Ac9868M6OZW8bO" alt="" data-size="original">                   | Record call audio                                                                                                                                            | <p>Record call audio and create a matching audio resource from the phone call</p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/numbers"><strong>voice enabled number</strong></a></p>                                                                                                                               |
| <img src="/files/SMrBX4ITvPes8a1XYUzF" alt="" data-size="original">                   | Say                                                                                                                                                          | <p>Convert a written message defined in the step into speech to be played in the call</p><p><strong>\*Requires a</strong> <a href="https://dashboard.messagebird.com/en/numbers"><strong>voice enabled number</strong></a></p>                                                                                                                       |
| **Key/value storage**                                                                 |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| <img src="/files/fiZDRjcFEc1P1XurtLfs" alt="" data-size="original">                   | [Store value](/connectivity-platform/steps-catalogue/using-database-steps-in-flow-builder.md#h_01ffm3vzzapa1xwh52pd6kampn)                                   | Store or update data into a [Database](https://dashboard.messagebird.com/en/developers/databases/list)                                                                                                                                                                                                                                               |
| <img src="/files/ZM2NdNSNXeS4PnCdGuks" alt="" data-size="original">                   | [Retrieve value from database](/connectivity-platform/steps-catalogue/using-database-steps-in-flow-builder.md#h_01ffm4phaj3r8v4hegs1ymrq5n)                  | Retrieve data from a [Database](https://dashboard.messagebird.com/en/developers/databases/list)                                                                                                                                                                                                                                                      |
| <img src="/files/NV0IjpooohYXq65rcYlo" alt="" data-size="original">                   | [Delete value from database](/connectivity-platform/steps-catalogue/using-database-steps-in-flow-builder.md#h_01ffm4drkh28w19y574cxc323p)                    | Delete data from a [Database](https://dashboard.messagebird.com/en/developers/databases/list)                                                                                                                                                                                                                                                        |
| **Data handling**                                                                     |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| <img src="/files/GNnxs40gNj38YHBsot4g" alt="" data-size="original">                   | Set variables                                                                                                                                                | Define a custom variable that can be reused later in the same Flow                                                                                                                                                                                                                                                                                   |
| **For advanced users**                                                                |                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                      |
| <img src="/files/dgy9Fj2ezCJ5oDn2IAJv" alt="" data-size="original">                   | [Call a function](/connectivity-platform/advanced-functionalities/create-your-own-date-formatting-function-in-flow-builder.md#set-up-the-call-function-step) | Call a [Function](https://dashboard.messagebird.com/en/developers/functions/list) you have created. Enables deep customization of the Flow and/or integration with other services.                                                                                                                                                                   |

\
Depending on the [Trigger](https://support.messagebird.com/hc/en-us/articles/360000334298-Triggers-Numbers-Templates-Steps#h_01G1JF23K4KMWWJD83EPT4ZRPP) you are using, some additional steps might be available and some steps, specific to a differently triggered Flow might not be.

&#x20;

📤  Feel free to [contact our Support](https://support.messagebird.com/hc/en-us/requests/new) in case you might need some help!


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.bird.com/connectivity-platform/basics/flowbuilder-steps-glossary.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
