> For the complete documentation index, see [llms.txt](https://docs.mapsindoors.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mapsindoors.com/reference-docs/ios-sdk.md).

# iOS SDK

Reference documentation for each version.

{% hint style="info" %}
From version 4.18.0 MapsIndoors requires a minimum iOS version of 16 and Xcode 26 as [Apple require apps to be built with Xcode 26](https://developer.apple.com/news/upcoming-requirements/?id=02032026a) to be distributed via the App Store from April 28, 2026.
{% endhint %}

{% tabs %}
{% tab title="v4" %}
**Latest**[**​**](https://docs.mapsindoors.com/reference-docs/ios#latest-1)

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>4.22.0</strong></td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.22.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.22.0/documentation/mapsindoors/</a></td></tr></tbody></table>

**Previous versions**[**​**](https://docs.mapsindoors.com/reference-docs/ios#previous-versions)

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>4.21.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.21.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.21.0/documentation/mapsindoors/</a></td></tr><tr><td>4.20.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.20.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.20.0/documentation/mapsindoors/</a></td></tr><tr><td>4.19.2</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.19.2/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.19.2/documentation/mapsindoors/</a></td></tr><tr><td>4.19.1</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.19.1/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.19.1/documentation/mapsindoors/</a></td></tr><tr><td>4.19.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.19.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.19.0/documentation/mapsindoors/</a></td></tr><tr><td>4.18.1</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.18.1/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.18.1/documentation/mapsindoors/</a></td></tr><tr><td>4.18.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.18.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.18.0/documentation/mapsindoors/</a></td></tr><tr><td>4.17.3</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.17.3/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.17.3/documentation/mapsindoors/</a></td></tr><tr><td>4.17.2</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.17.2/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.17.2/documentation/mapsindoors/</a></td></tr><tr><td>4.17.1</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.17.1/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.17.1/documentation/mapsindoors/</a></td></tr><tr><td>4.17.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.17.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.17.0/documentation/mapsindoors/</a></td></tr><tr><td>4.16.5</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.16.5/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.16.5/documentation/mapsindoors/</a></td></tr><tr><td>4.16.4</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.16.4/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.16.4/documentation/mapsindoors/</a></td></tr><tr><td>4.16.3</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.16.3/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.16.3/documentation/mapsindoors/</a></td></tr><tr><td>4.16.2</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.16.2/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.16.2/documentation/mapsindoors/</a></td></tr><tr><td>4.16.1</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.16.1/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.16.1/documentation/mapsindoors/</a></td></tr><tr><td>4.16.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.16.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.16.0/documentation/mapsindoors/</a></td></tr><tr><td>4.15.7</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.15.7/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.15.7/documentation/mapsindoors/</a></td></tr><tr><td>4.15.6</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.15.6/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.15.6/documentation/mapsindoors/</a></td></tr><tr><td>4.15.2</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.15.2/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.15.2/documentation/mapsindoors/</a></td></tr><tr><td>4.15.1</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.15.1/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.15.1/documentation/mapsindoors/</a></td></tr><tr><td>4.14.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.14.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.14.0/documentation/mapsindoors/</a></td></tr><tr><td>4.13.2</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.13.2/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.13.2/documentation/mapsindoors/</a></td></tr><tr><td>4.13.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.13.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.13.0/documentation/mapsindoors/</a></td></tr><tr><td>4.12.3</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.12.3/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.12.3/documentation/mapsindoors/</a></td></tr><tr><td>4.12.2</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.12.2/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.12.2/documentation/mapsindoors/</a></td></tr><tr><td>4.12.1</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.12.1/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.12.1/documentation/mapsindoors/</a></td></tr><tr><td>4.11.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.11.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.11.0/documentation/mapsindoors/</a></td></tr><tr><td>4.10.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.10.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.10.0/documentation/mapsindoors/</a></td></tr><tr><td>4.9.7</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.7/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.7/documentation/mapsindoors/</a></td></tr><tr><td>4.9.6</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.6/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.6/documentation/mapsindoors/</a></td></tr><tr><td>4.9.5</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.5/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.5/documentation/mapsindoors/</a></td></tr><tr><td>4.9.4</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.4/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.4/documentation/mapsindoors/</a></td></tr><tr><td>4.9.3</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.3/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.3/documentation/mapsindoors/</a></td></tr><tr><td>4.9.2</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.2/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.2/documentation/mapsindoors/</a></td></tr><tr><td>4.9.1</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.1/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.1/documentation/mapsindoors/</a></td></tr><tr><td>4.9.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.9.0/documentation/mapsindoors/</a></td></tr><tr><td>4.8.3</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.8.3/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.8.3/documentation/mapsindoors/</a></td></tr><tr><td>4.8.1</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.8.1/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.8.1/documentation/mapsindoors/</a></td></tr><tr><td>4.8.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.8.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.8.0/documentation/mapsindoors/</a></td></tr><tr><td>4.7.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.7.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.7.0/documentation/mapsindoors/</a></td></tr><tr><td>4.6.3</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.6.3/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.6.3/documentation/mapsindoors/</a></td></tr><tr><td>4.6.2</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.6.2/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.6.2/documentation/mapsindoors/</a></td></tr><tr><td>4.6.1</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.6.1/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.6.1/documentation/mapsindoors/</a></td></tr><tr><td>4.6.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.6.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.6.0/documentation/mapsindoors/</a></td></tr><tr><td>4.5.15</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.15/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.15/documentation/mapsindoors/</a></td></tr><tr><td>4.5.14</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.14/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.14/documentation/mapsindoors/</a></td></tr><tr><td>4.5.13</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.13/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.13/documentation/mapsindoors/</a></td></tr><tr><td>4.5.12</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.12/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.12/documentation/mapsindoors/</a></td></tr><tr><td>4.5.11</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.11/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.11/documentation/mapsindoors/</a></td></tr><tr><td>4.5.10</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.10/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.10/documentation/mapsindoors/</a></td></tr><tr><td>4.5.9</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.9/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.9/documentation/mapsindoors/</a></td></tr><tr><td>4.5.8</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.8/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.8/documentation/mapsindoors/</a></td></tr><tr><td>4.5.7</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.7/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.7/documentation/mapsindoors/</a></td></tr><tr><td>4.5.6</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.6/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.6/documentation/mapsindoors/</a></td></tr><tr><td>4.5.5</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.5/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.5/documentation/mapsindoors/</a></td></tr><tr><td>4.5.4</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.4/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.4/documentation/mapsindoors/</a></td></tr><tr><td>4.5.3</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.3/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.3/documentation/mapsindoors/</a></td></tr><tr><td>4.5.2</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.2/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.2/documentation/mapsindoors/</a></td></tr><tr><td>4.5.1</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.1/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.1/documentation/mapsindoors/</a></td></tr><tr><td>4.5.0</td><td><a href="https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.0/documentation/mapsindoors/">https://app.mapsindoors.com/mapsindoors/reference/ios/4.5.0/documentation/mapsindoors/</a></td></tr></tbody></table>

**4.4.1 and earlier**

* [MapsIndoors iOS SDK v4.4.1](https://app.mapsindoors.com/mapsindoors/reference/ios/4.4.1/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.4.0](https://app.mapsindoors.com/mapsindoors/reference/ios/4.4.0/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.13](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.13/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.12](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.12/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.11](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.11/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.10](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.10/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.9](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.9/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.8](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.8/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.7](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.7/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.6](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.6/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.5](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.5/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.4](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.4/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.3](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.3/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.2](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.2/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.1](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.1/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.3.0](https://app.mapsindoors.com/mapsindoors/reference/ios/4.3.0/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.14](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.14/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.13](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.13/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.12](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.12/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.11](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.11/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.10](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.10/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.9](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.9/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.8](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.8/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.7](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.7/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.6](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.6/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.5](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.5/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.4](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.4/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.2](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.2/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.1](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.1/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.2.0](https://app.mapsindoors.com/mapsindoors/reference/ios/4.2.0/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.1.4](https://app.mapsindoors.com/mapsindoors/reference/ios/4.1.4/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.1.3](https://app.mapsindoors.com/mapsindoors/reference/ios/4.1.3/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.1.2](https://app.mapsindoors.com/mapsindoors/reference/ios/4.1.2/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.1.1](https://app.mapsindoors.com/mapsindoors/reference/ios/4.1.1/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.1.0](https://app.mapsindoors.com/mapsindoors/reference/ios/4.1.0/documentation/mapsindoors/)
* [MapsIndoors iOS SDK v4.0.3](https://app.mapsindoors.com/mapsindoors/reference/ios/v4-doc/documentation/mapsindoors/)
  {% endtab %}

{% tab title="v3" %}
**Latest**[**​**](https://docs.mapsindoors.com/reference-docs/ios#latest-2)

* [MapsIndoors iOS SDK v3.50.2](https://app.mapsindoors.com/mapsindoors/reference/ios/v3/classes.html)
  {% endtab %}
  {% endtabs %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.mapsindoors.com/reference-docs/ios-sdk.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
