> For the complete documentation index, see [llms.txt](https://developer.magtek.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.magtek.com/services/reader-management-services/reader-management-system-api.md).

# Reader Management System API

The Reader Management System (RMS) API is a REST interface for remotely managing deployed MagTek readers — staging configuration, tag, key, and firmware updates and retrieving device status so fleets can be maintained without handling each device by hand. This reference groups the RMS-V2 endpoints by device family — MagneSafe V5, DynaFlex, DynaPro Go, oDynamo, and iDynamo 5 Gen III — and links each operation to its live request in the RMS-V2 Postman collection. API credentials are issued by MagTek/Magensa support; start with the Introduction and V5 Authorization sections below.

## **RMS-V2 API** <a href="#hid-demo" id="hid-demo"></a>

### **V5**

| **API Section**                                                                                                                                            | **Description**                                                                                                                                     |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| [<mark style="color:red;">**Introduction**</mark>](https://rmsv2.developer.magtek.com/#intro)                                                              | Overview of the RMS-V2 API — base URL, request/response conventions, and how remote configuration, tag, and firmware updates reach fielded readers. |
| [<mark style="color:red;">**V5 Authorization**</mark>](https://rmsv2.developer.magtek.com/#7d974f9b-4c1e-423e-8b08-02730ec0a3fb)                           | How to authenticate to RMS-V2 and obtain the access token required by the V5 endpoints.                                                             |
| [<mark style="color:red;">**Configurations**</mark>](https://rmsv2.developer.magtek.com/#89b9c741-8b3f-488b-9e1e-69b36bc96b42)                             | Endpoints for listing, retrieving, and queuing configuration-profile updates for MagneSafe V5 readers.                                              |
| [<mark style="color:red;">**Get Configs/List (V5)**</mark>](https://rmsv2.developer.magtek.com/#9b5fb7bc-c2c5-41aa-bdee-f19855da0eaa)                      | .Returns the list of configuration profiles available for V5 devices.                                                                               |
| [<mark style="color:red;">**Get Configs (V5)**</mark>](https://rmsv2.developer.magtek.com/#1c2bd207-367c-4ca0-bcce-e149cf7c59da)                           | Retrieves a specific V5 configuration profile.                                                                                                      |
| [<mark style="color:red;">**Get Configs (V5 Force update)**</mark>](https://rmsv2.developer.magtek.com/#6bb00f0c-c8ca-409f-8e50-7584b30339c6)              | Retrieves a V5 configuration profile flagged to reapply even if the device already has it.                                                          |
| [<mark style="color:red;">**Post Configs (V5)**</mark>](https://rmsv2.developer.magtek.com/#b8adeb44-27cd-4d24-a9fb-8a9bb0b12a7f)                          | Queues a configuration-profile update for a V5 device                                                                                               |
| [<mark style="color:red;">**Post Configs (V5 Force update)**</mark>](https://rmsv2.developer.magtek.com/#d0bd7e55-5b5c-45ee-a78e-19c67d5997ed)             | Queues a V5 configuration update and forces reapplication even if already current.                                                                  |
| [<mark style="color:red;">**Tags**</mark>](https://rmsv2.developer.magtek.com/#c6ff98b0-5bbd-4ade-bfdc-65130f08dcf5)                                       | Endpoints for listing, retrieving, and queuing tag (TLV data element) updates for V5 readers.                                                       |
| [<mark style="color:red;">**Get Tags/List**</mark>](https://rmsv2.developer.magtek.com/#35555fe4-ae27-40e2-8668-09cb5ec1a888)                              | Returns the list of tag sets available for V5 devices.                                                                                              |
| [<mark style="color:red;">**Get Tags (V5 with version)**</mark>](https://rmsv2.developer.magtek.com/#6b32e707-ac67-41fa-961b-d6bde2b32d2d)                 | Retrieves a specific version of a V5 tag set.                                                                                                       |
| [<mark style="color:red;">**Get Tags (V5 without version)**</mark>](https://rmsv2.developer.magtek.com/#af227fd4-3953-421a-83f2-003b9cfdbdd5)              | Retrieves the latest V5 tag set.                                                                                                                    |
| [<mark style="color:red;">**Get Tags (V5 Force update)**</mark>](https://rmsv2.developer.magtek.com/#450c272b-b181-4e4b-8d25-b554d511e766)                 | Retrieves a V5 tag set flagged to reapply even if already current.                                                                                  |
| [<mark style="color:red;">**Post Tags (V5 with version)**</mark>](https://rmsv2.developer.magtek.com/#70b8d126-7cb2-4e19-9f97-1c3811577fc3)                | Queues a specific version of a tag set for a V5 device.                                                                                             |
| [<mark style="color:red;">**Post Tags (V5 without version)**</mark>](https://rmsv2.developer.magtek.com/#26ea518b-71bc-4340-8aaa-895c2d29372e)             | Queues the latest tag set for a V5 device.                                                                                                          |
| [<mark style="color:red;">**Post Tags (V5 Force update)**</mark>](https://rmsv2.developer.magtek.com/#d3e780be-4540-4964-9485-c70910458737)                | Queues a V5 tag-set update and forces reapplication even if already current.                                                                        |
| [<mark style="color:red;">**Firmwares**</mark>](https://rmsv2.developer.magtek.com/#398b7e13-aead-419c-958b-10e44d617beb)                                  | Endpoints for listing, retrieving, and queuing firmware updates for V5 readers.                                                                     |
| [<mark style="color:red;">**Get Firmware (V5 with version)**</mark>](https://rmsv2.developer.magtek.com/#c9518226-b99f-4693-8014-678a79be44c0)             | Retrieves a specific firmware version for V5 devices.                                                                                               |
| [<mark style="color:red;">**Get Firmware (V5 without version)**</mark>](https://rmsv2.developer.magtek.com/#47cfb29c-57ca-43bb-84ff-e76319935555)          | Retrieves the latest firmware for V5 devices.                                                                                                       |
| [<mark style="color:red;">**Get Firmware (V5 Force update)**</mark>](https://rmsv2.developer.magtek.com/#627898a2-6ec6-4043-ae2e-26c3be4807f0)             | Retrieves a V5 firmware update flagged to reinstall even if already current.                                                                        |
| [<mark style="color:red;">**Post Firmware (V5 with version)**</mark>](https://rmsv2.developer.magtek.com/#7a59cf21-401c-47df-abf6-1ae660a7aefb)            | Queues a specific firmware version for a V5 device.                                                                                                 |
| [<mark style="color:red;">**Post Firmware (V5 without version)**</mark>](https://rmsv2.developer.magtek.com/#b4843fae-1202-42f7-b349-7c24836763b4)         | Queues the latest firmware for a V5 device.                                                                                                         |
| [<mark style="color:red;">**Post Firmware (V5 Force update)**</mark>](https://rmsv2.developer.magtek.com/#bc206757-0c5d-47d6-af7c-e23bee5f925b)            | Queues a V5 firmware update and forces reinstallation even if already current.                                                                      |
| [<mark style="color:red;">**Post Firmware (V5 DownloadPayload = false)**</mark>](https://rmsv2.developer.magtek.com/#5d83f92c-96b2-44a1-ba1f-0cf4f7f31874) | Queues a V5 firmware update whose response omits the firmware payload, returning metadata only so the payload can be fetched separately.            |

### **DynaFlex** <a href="#hid-demo" id="hid-demo"></a>

| **API Section**                                                                                                                                                  | **Description**                                                                                                                       |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| [<mark style="color:red;">**Configurations**</mark>](https://rmsv2.developer.magtek.com/#2e14e507-a210-410b-b00e-8d3953be0bed)                                   | Endpoints for listing and queuing configuration updates for DynaFlex-family devices, plus QwantiFi cloud-management calls.            |
| [<mark style="color:red;">**QwantiFiCloudManagement**</mark>](https://rmsv2.developer.magtek.com/#919d6207-be9d-41b6-942b-c9dadb1aa66a)                          | Endpoints for managing a DynaFlex-family device's QwantiFi (MQTT) cloud connectivity and status.                                      |
| [<mark style="color:red;">**Post Update Device MQTT Configurations**</mark>](https://rmsv2.developer.magtek.com/#ba45f39d-4914-4d45-9861-ce95ccaf54f3)           | Updates the MQTT configuration (broker and topic settings) provisioned to a DynaFlex-family device.                                   |
| [<mark style="color:red;">**Post Update Device Status**</mark>](https://rmsv2.developer.magtek.com/#7592ccb9-be75-406c-b0ce-60ec5683f36a)                        | Updates a DynaFlex-family device's status record in RMS.                                                                              |
| [<mark style="color:red;">**Get Configs/List (DynaFlex)**</mark>](https://rmsv2.developer.magtek.com/#ea2ed49a-4238-4258-8bc1-c15b310e3b66)                      | Returns the list of configuration profiles available for DynaFlex-family devices.                                                     |
| [<mark style="color:red;">**Post Configs Key Load (DynaFlex)**</mark>](https://rmsv2.developer.magtek.com/#9c35c948-2053-4893-a2d3-a5528aeb952c)                 | Queues a key-load configuration for a DynaFlex device, injecting or updating its cryptographic keys.                                  |
| [<mark style="color:red;">**Post Configs SCDE (DynaFlex II Go)**</mark>](https://rmsv2.developer.magtek.com/#c2dbc0fd-e6cb-479a-a920-a762ad62dc57)               | Queues the SCDE configuration for a DynaFlex II Go device.                                                                            |
| [<mark style="color:red;">**Post Configs SCDE (DynaFlex II Go Force update)**</mark>](https://rmsv2.developer.magtek.com/#036f3878-3b5a-4c88-8a48-0923352bed45)  | Queues the SCDE configuration for a DynaFlex II Go device, forcing reapplication even if already present.                             |
| [<mark style="color:red;">**Tags**</mark>](https://rmsv2.developer.magtek.com/#1cd1539c-1a62-4d0b-ac25-d104ed15f4e9)                                             | Endpoints for listing, retrieving, and queuing tag (TLV) updates for DynaFlex-family devices, including file and command delivery.    |
| [<mark style="color:red;">**Get Tags (DynaFlex with version)**</mark>](https://rmsv2.developer.magtek.com/#b33cbdad-db92-446c-ad7e-52d0e3d63ca0)                 | Retrieves a specific version of a DynaFlex tag set.                                                                                   |
| [<mark style="color:red;">**Get Tags (DynaFlex without version)**</mark>](https://rmsv2.developer.magtek.com/#a707d755-15fe-4371-97ff-b086bea2114b)              | Retrieves the latest DynaFlex tag set.                                                                                                |
| [<mark style="color:red;">**Get Tags (DynaFlex Force update)**</mark>](https://rmsv2.developer.magtek.com/#066207f7-c8d5-4243-be80-528a0d349236)                 | Retrieves a DynaFlex tag set flagged to reapply even if already current.                                                              |
| [<mark style="color:red;">**Post Tags (DynaFlex with version)**</mark>](https://rmsv2.developer.magtek.com/#9f64ee20-31b8-49c9-bdcf-b6173f863afb)                | Queues a specific version of a tag set for a DynaFlex device.                                                                         |
| [<mark style="color:red;">**Post Tags (DynaFlex without version)**</mark>](https://rmsv2.developer.magtek.com/#39a7ced3-de82-4aec-af0b-d2362bc6c883)             | Queues the latest tag set for a DynaFlex device.                                                                                      |
| [<mark style="color:red;">**Post Tags (DynaFlex Force update)**</mark>](https://rmsv2.developer.magtek.com/#903d18c2-0d85-4615-96e9-7d389ba4f3ec)                | Queues a DynaFlex tag-set update and forces reapplication even if already current.                                                    |
| [<mark style="color:red;">**Post Tags (DynaFlex Send files)**</mark>](https://rmsv2.developer.magtek.com/#ee9fa7a3-37ff-4667-9031-a5ed6f5a5b73)                  | Pushes one or more files to a DynaFlex device through the tag mechanism.                                                              |
| [<mark style="color:red;">**Post Tags (DynaFlex Send commands)**</mark>](https://rmsv2.developer.magtek.com/#59de118a-58f2-438c-85ff-eea243bc307b)               | Sends one or more device commands to a DynaFlex device through the tag mechanism.                                                     |
| [<mark style="color:red;">**Firmwares**</mark>](https://rmsv2.developer.magtek.com/#599ab30b-aefa-4137-bc6d-7f60fcec08fd)                                        | Endpoints for retrieving and queuing firmware updates across DynaFlex-family models.                                                  |
| [<mark style="color:red;">**Get Firmware (DYNAFLEX II GO)**</mark>](https://rmsv2.developer.magtek.com/#b5d89cd1-f38c-43e5-9f39-d1372206a920)                    | Retrieves the firmware update for DynaFlex II Go devices.                                                                             |
| [<mark style="color:red;">**Get Firmware (DYNAFLEX II PED)**</mark>](https://rmsv2.developer.magtek.com/#c502cd12-c984-4ef7-81d7-6821014e238e)                   | Retrieves the firmware update for DynaFlex II PED devices.                                                                            |
| [<mark style="color:red;">**Get Firmware (DYNAPROX)**</mark>](https://rmsv2.developer.magtek.com/#66ffc82e-544b-409e-a0ce-4912e4de9442)                          | Retrieves the firmware update for DynaProx devices.                                                                                   |
| [<mark style="color:red;">**Get Firmware (DYNAFLEX)**</mark>](https://rmsv2.developer.magtek.com/#c8e28474-c69b-4bac-94d6-c9cccaed81cd)                          | Retrieves the firmware update for DynaFlex devices.                                                                                   |
| [<mark style="color:red;">**Post Firmware (DYNAFLEX II GO)**</mark>](https://rmsv2.developer.magtek.com/#2c84dad6-d5ba-4d82-862e-de8133dd8d20)                   | Queues a firmware update for DynaFlex II Go devices.                                                                                  |
| [<mark style="color:red;">**Post Firmware (DYNAFLEX II PED)**</mark>](https://rmsv2.developer.magtek.com/#fde4ddc6-ee1d-4704-bb5d-bd4692229996)                  | Queues a firmware update for DynaFlex II PED devices.                                                                                 |
| [<mark style="color:red;">**Post Firmware (DYNAPROX)**</mark>](https://rmsv2.developer.magtek.com/#674c21d8-fb7c-42ad-947c-10ef7ed2caca)                         | Queues a firmware update for DynaProx devices.                                                                                        |
| [<mark style="color:red;">**Post Firmware (DYNAFLEX)**</mark>](https://rmsv2.developer.magtek.com/#2c6569d4-55b1-400f-a706-4d997e844bae)                         | Queues a firmware update for DynaFlex devices.                                                                                        |
| [<mark style="color:red;">**Post Firmware (DynaFlex DownloadPayload = false)**</mark>](https://rmsv2.developer.magtek.com/#582d6c29-197a-4965-a144-b26bf0f8adc2) | Queues a DynaFlex firmware update whose response omits the payload, returning metadata only so the payload can be fetched separately. |

### DynaPro Go

| **API Section**                                                                                                                                         | **Description**                                                                              |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| [<mark style="color:red;">**DynaProGo**</mark>](https://rmsv2.developer.magtek.com/#12127a3b-0cca-4d45-a361-4dec8ba7169e)                               | RMS-V2 endpoints for remotely managing DynaPro Go PIN devices.                               |
| [<mark style="color:red;">**Tags**</mark>](https://rmsv2.developer.magtek.com/#81521107-9615-4594-bb00-5af27688a73d)                                    | Endpoints for queuing tag (TLV) updates for DynaPro Go devices.                              |
| [<mark style="color:red;">**Post Tags (DynaProGo CAPK)**</mark>](https://rmsv2.developer.magtek.com/#fa9ed910-e3aa-40eb-843b-0dcd50299003)              | Queues an EMV Certificate Authority Public Key (CAPK) update for a DynaPro Go device.        |
| [<mark style="color:red;">**Post Tags (DynaProGo CAPK Force update)**</mark>](https://rmsv2.developer.magtek.com/#1c7b14e1-6533-453f-af17-91d5c1673099) | Queues a CAPK update for a DynaPro Go device, forcing reapplication even if already present. |

### oDynamo

| **API Section**                                                                                                                                       | **Description**                                                                            |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| [<mark style="color:red;">**oDynamo**</mark>](https://rmsv2.developer.magtek.com/#9b8d88f5-7992-47ed-b74d-42276c9ecd0b)                               | RMS-V2 endpoints for remotely managing oDynamo OEM readers.                                |
| [<mark style="color:red;">**Tags**</mark>](https://rmsv2.developer.magtek.com/#81521107-9615-4594-bb00-5af27688a73d)                                  | Endpoints for queuing tag (TLV) updates for oDynamo devices.                               |
| [<mark style="color:red;">**Post Tags (oDynamo CAPK)**</mark>](https://rmsv2.developer.magtek.com/#5db28274-cc99-46ae-8c64-55c5a1bb0fd1)              | Queues an EMV Certificate Authority Public Key (CAPK) update for an oDynamo device.        |
| [<mark style="color:red;">**Post Tags (oDynamo CAPK Force update)**</mark>](https://rmsv2.developer.magtek.com/#84f28f4e-2689-4711-a681-a97096728183) | Queues a CAPK update for an oDynamo device, forcing reapplication even if already present. |

### iDynamo 5 Gen III

| **API Section**                                                                                                                                                        | **Description**                                                                                                                  |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| [<mark style="color:red;">**iDynamo5 Gen III**</mark>](https://rmsv2.developer.magtek.com/#460ecb20-e376-4e5e-beaf-b6ddf2cd25f0)                                       | RMS-V2 endpoints for remotely managing iDynamo 5 Gen III readers.                                                                |
| [<mark style="color:red;">**Configurations**</mark>](https://rmsv2.developer.magtek.com/#2311cde1-1100-4ecc-a41c-3ec69022bf63)                                         | Endpoints for listing and queuing configuration updates that set interface, mode, and data options on iDynamo 5 Gen III devices. |
| [<mark style="color:red;">**Get Configs/List**</mark>](https://rmsv2.developer.magtek.com/#6016f099-b7ff-43b2-a842-263451a9d9bd)                                       | Returns the list of configuration profiles available for iDynamo 5 Gen III devices.                                              |
| [<mark style="color:red;">**Post Configs (Enable push-button)**</mark>](https://rmsv2.developer.magtek.com/#c1c5ed7c-4a73-4960-bbcc-becb09aeecf3)                      | Queues a configuration that enables the device's push-button.                                                                    |
| [<mark style="color:red;">**Post Configs (Enable push-button for one press)**</mark>](https://rmsv2.developer.magtek.com/#949e2438-1a42-4b32-ab00-59fb5a198010)        | Queues a configuration that enables the push-button for a single press.                                                          |
| [<mark style="color:red;">**Post Configs (Enable push-button for multiple presses)**</mark>](https://rmsv2.developer.magtek.com/#0a6f587c-28fd-4039-bdf9-e37ed24bbf0e) | Queues a configuration that enables the push-button for multiple presses.                                                        |
| [<mark style="color:red;">**Post Configs (Disable push-button)**</mark>](https://rmsv2.developer.magtek.com/#ecf914a3-e96b-4e4d-a56c-c5f29b623bae)                     | Queues a configuration that disables the device's push-button.                                                                   |
| [<mark style="color:red;">**Post Configs (Enable Qwantum Mode)**</mark>](https://rmsv2.developer.magtek.com/#b2f1c309-6ff1-41c6-bbdc-a7be2b6c8457)                     | Queues a configuration that switches the device into Qwantum mode.                                                               |
| [<mark style="color:red;">**Post Configs (Enable Normal Mode)**</mark>](https://rmsv2.developer.magtek.com/#04adae6e-f194-4589-b97b-a6ea80f7076e)                      | Queues a configuration that returns the device to normal mode.                                                                   |
| [<mark style="color:red;">**Post Configs (Set USB HID)**</mark>](https://rmsv2.developer.magtek.com/#964ed7d2-5811-449e-8718-99762c25365b)                             | Queues a configuration that sets the device's USB interface to HID mode.                                                         |
| [<mark style="color:red;">**Post Configs (Set USB Keyboard Emulation)**</mark>](https://rmsv2.developer.magtek.com/#b0e948ab-6153-4570-b2fb-255581b815b5)              | Queues a configuration that sets the device's USB interface to keyboard-emulation mode.                                          |
| [<mark style="color:red;">**Post Configs (Set iAP / RS-232 / UART)**</mark>](https://rmsv2.developer.magtek.com/#4d2f4ccc-1791-46b7-8dd4-b50b1690451a)                 | Queues a configuration that sets the device's interface to iAP, RS-232, or UART.                                                 |
| [<mark style="color:red;">**Post Configs (Set One-Time Automatic)**</mark>](https://rmsv2.developer.magtek.com/#ece1b7a0-f701-4e5a-8fc2-2f0111c27620)                  | Queues a configuration that puts the device in one-time automatic mode.                                                          |
| [<mark style="color:red;">**Post Configs DataVariant**</mark>](https://rmsv2.developer.magtek.com/#1c46d5d2-8906-47f1-adb8-4a356bb6aafc)                               | Queues a configuration that sets the device's data variant (output data format).                                                 |
| [<mark style="color:red;">**Post Configs PINVariant**</mark>](https://rmsv2.developer.magtek.com/#15f00ddb-4c83-4368-b87c-c96cf6e1159d)                                | Queues a configuration that sets the device's PIN variant.                                                                       |
| [<mark style="color:red;">**Firmwares**</mark>](https://rmsv2.developer.magtek.com/#414d42e9-a6de-403e-8b96-3c17914b0e60)                                              | Endpoints for retrieving and queuing firmware updates for iDynamo 5 Gen III devices.                                             |
| [<mark style="color:red;">**Get Firmware (Force update RawCommands=False)**</mark>](https://rmsv2.developer.magtek.com/#e28eb15a-44d2-48d4-bcca-ccf903e47114)          | Retrieves a forced iDynamo 5 Gen III firmware update delivered as processed commands (RawCommands = false).                      |
| [<mark style="color:red;">**Post Firmware (Force update RawCommands=False)**</mark>](https://rmsv2.developer.magtek.com/#fdd07abb-1023-4ad5-ac41-bd1603182e3b)         | Queues a forced iDynamo 5 Gen III firmware update delivered as processed commands (RawCommands = false)                          |
| [<mark style="color:red;">**Get Firmware (Force update RawCommands=True)**</mark>](https://rmsv2.developer.magtek.com/#c29e898e-7be5-47fc-9b7d-7f22264251d9)           | Retrieves a forced iDynamo 5 Gen III firmware update delivered as raw commands (RawCommands = true).                             |
| [<mark style="color:red;">**Post Firmware (Force update RawCommands=True)**</mark>](https://rmsv2.developer.magtek.com/#8df5b3f2-a43d-4861-b148-04110c8b2435)          | Queues a forced iDynamo 5 Gen III firmware update delivered as raw commands (RawCommands = true).                                |

### ​Need More Help

{% hint style="info" %}
**Need Help?**

For additional support, please contact MagTek Support:

**Technical Support:**

* 📧 **Email:** [support@magtek.com](mailto:support@magtek.com?subject=Support%20Request)
* 📞 **Phone:** 1-562-546-6800 (US)
* 🕐 **Hours:** Monday-Friday, 5:30 AM - 5:00 PM PST

**Online Resources:**

* 🌐 **Support Portal:** developer.magtek.com

**Documentation Feedback:**

Help us improve this documentation! [feedback@magtek.com](mailto:feedback@magtek.com?subject=Feedback)
{% endhint %}


---

# 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://developer.magtek.com/services/reader-management-services/reader-management-system-api.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.