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

# Help API

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/api/help.md).
{% endhint %}

Help hub articles (the FAQ) and the contact form that sends a message to support.

* **Services:** `api_php_live_v2` at `https://z4.snapfix.com` (`/v1/app`, `/v1/guest`); `php-apis` at `https://z1.snapfix.com/api/snapfix/index.php`
* **Auth:** api\_php\_live\_v2 `/v1/app`: user token (authpy JWT in `Authorization: Bearer`). The routes run the account checks of every `/v1/app` route ([What a user token does not prove](https://docs.snapfix.com/engineering-reference/api.md#what-a-user-token-does-not-prove)), but check no role, site or group. `/v1/guest`: one shared Basic login, which is also in public web bundles, so it identifies the app and not a person. php-apis: user token (Bearer JWT, if `JWT_AUTH_ENABLED` is on \[[ASK-12](https://github.com/snapfix/docs/blob/main/ASK.md#ask-12-which-settings-do-the-production-api-servers-use)]); its two help actions are generic table actions that act on what the request sends.
* **Used by:** web\_app\_v2 (the sign-in help page and its contact form, guest routes only), iOS and Android (the Help Hub's FAQ and contact form, signed in and signed out); 2 of the 6 endpoints have no known caller.
* **Answers and errors:** the `/v1/app` envelope and codes are in [Tasks: common errors](https://docs.snapfix.com/engineering-reference/api/tasks.md#common-errors). The `/v1/guest` routes skip the token, temporary-password and verification checks; a missing or wrong guest login gets `401` with `{"error": "Unauthorized."}`, which has no `status` field. php-apis answers HTTP `200` with `result` `false` and the message ([Responses](https://docs.snapfix.com/engineering-reference/api.md#responses)). Each section lists its own errors.
* **Logs:** api\_php\_live\_v2 writes each call to its request log, with the response when it is under about 100 KB. The log keeps every request field except files and masks only `password`, so the contact form's five fields are stored in full (api\_php\_live\_v2 @ ef3c4319f6, `app/Services/LogService.php:113`, `app/Http/Middleware/TerminableLogger.php:39-44`). php-apis stores each request body and each response under about 100 KB in its daily request log.

| Method | Path                                                            | Service            | Purpose                                                     |
| ------ | --------------------------------------------------------------- | ------------------ | ----------------------------------------------------------- |
| POST   | [`/v1/app/help-hub`](#post-v1apphelp-hub)                       | api\_php\_live\_v2 | Send the contact form to support, signed in                 |
| GET    | [`/v1/app/help-hub/{category}`](#get-v1apphelp-hubcategory)     | api\_php\_live\_v2 | List help articles in a category                            |
| POST   | [`/v1/guest/help-hub`](#post-v1guesthelp-hub)                   | api\_php\_live\_v2 | Send the contact form to support, signed out                |
| GET    | [`/v1/guest/help-hub/{category}`](#get-v1guesthelp-hubcategory) | api\_php\_live\_v2 | List help articles in a category                            |
| ANY    | `?action=read_pub_help`                                         | php-apis           | Read help entries by UUID, generic table action (no caller) |
| ANY    | `?action=save_pub_help`                                         | php-apis           | Save help entries, generic table action (no caller)         |

Notes on the table:

* Rows marked "(no caller)" have no caller in any client clone: the apps list both actions in their endpoint registries only (ios @ aa31967ac8, `APIManagers/ApiEndpointManager.swift:1383-1396`; android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/utils/APIEndPointUtils.java:300-301`). They are generic table actions on [`tPub_Help`](https://docs.snapfix.com/engineering-reference/db/tables/tpub_help.md), which nothing else in the repos reads or writes (php-apis @ 238ca4414e, `html/api/snapfix/index.php:4248-4259`). The help hub reads its articles from the server's files, and the contact form goes to [`tPri_Log_Helphub_ContactForm`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_log_helphub_contactform.md). Whether to remove the two actions is open \[[ASK-11](https://github.com/snapfix/docs/blob/main/ASK.md#ask-11-which-unused-api-endpoints-are-still-needed)].
* What they can do: neither is on the dispatcher's no-token list (`index.php:355`), so both need a user token, or the php-apis Basic login while `JWT_AUTH_ENABLED` is off \[[ASK-12](https://github.com/snapfix/docs/blob/main/ASK.md#ask-12-which-settings-do-the-production-api-servers-use)]. `save_pub_help` inserts or updates whatever `tPub_Help` rows it is sent, with no check of the caller, through the generic save that puts the rows' field names into the SQL (`htmlphp/api/snapfix/class/class.functions.php:749-751`). `read_pub_help` returns rows by `uuids` or by filters, with the request's own `uuid_tUser` and `last_updated_ts` (`:1799-1840`). The shapes are in [Requests](https://docs.snapfix.com/engineering-reference/api.md#requests).
* Help videos and the tours have no route: the apps list their help videos in code, and the web's tour service makes no HTTP call (ios @ aa31967ac8, `SnapFix/HelpVideosVC.swift:95-121`; android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/activity/HelpHubActivity.kt:312-316`; web\_app\_v2 @ 0989b8e685, `src/app/services/snaptips/snaptips.service.ts`).
* The articles' source is the server's `HELPHUB_PROVIDER` setting: `internal`, the code default, or `hubspot`. The value is not in any repo (api\_php\_live\_v2 @ ef3c4319f6, `config/helphub.php:11`), but production serves the built-in articles: on 2026-11-14 the production sign-in help showed exactly the seven entries of `resources/other/helphub/faq.php`, in file order, and a search with no match reached the empty state, which HubSpot's string `content` would break (`app/Services/HelpHub/Providers/HubSpotServiceProvider.php:56`, `:62`; web\_app\_v2 @ 0989b8e685, `src/app/pages/auth/help-hub-faq/help-hub-faq.component.ts:98-103`).
* **Screens and features:** [FAQ](https://docs.snapfix.com/how-the-apps-work/screens/help/faq.md), [Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md), [sign-in help](https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md) and [Help Hub](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md); [Help Hub](https://docs.snapfix.com/product/features/help/help-hub.md) and [Contact support](https://docs.snapfix.com/product/features/help/contact-support.md).

## POST /v1/app/help-hub

Sends the contact form as a signed-in user: the apps' "Get in touch" form. The server stores it and emails it to the support mailbox ([Contact form](#contact-form)).

* **Auth:** user token. Any signed-in user may send it; no role, site or group is checked. The sender is the token's user, and the body cannot name another (api\_php\_live\_v2 @ ef3c4319f6, `routes/app.php:66-70`, `app/Http/Controllers/v1/Versions/v1_0/App/HelpHubController.php:33-45`).
* **Used by:** iOS (`GetInTouchVC.callAPI` when signed in: ios @ aa31967ac8, `SnapFix/GetInTouchVC.swift:112-144`), Android (`HelpHubActivity.saveGetInTouchData` and `MyProfileActivity.saveGetInTouchData`: android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/activity/HelpHubActivity.kt:365-397`, `app/src/main/java/gmail/com/snapfixapp/activity/MyProfileActivity.kt:845-876`). The web doesn't call this route: its form is on the signed-out pages only (web\_app\_v2 @ 0989b8e685, `src/app/services/help-hub/help-hub-http/help-hub-http.service.ts:28-35`).

**Request:** JSON or form fields: the five [contact form fields](#contact-form).

**Response** `200`: `data` is `null`.

```json
{
  "status": "success",
  "message": "Operation was successful",
  "data": null
}
```

**Errors:** [common errors](https://docs.snapfix.com/engineering-reference/api/tasks.md#common-errors), with the first failed rule's text for `422`, such as "The message field is required."; `500` "An unexpected error occurred. Please try again later." when the server's `HUBSPOT_ACCESS_TOKEN` is not set. The form is stored through the HubSpot provider, whose constructor fails without the token, before the row is written or the email queued (`app/Services/HelpHub/HelpHubService.php:25-34`, `app/Services/HelpHub/Providers/HubSpotServiceProvider.php:19`, `:26-34`, `app/Exceptions/Handler.php:78-85`).

**Side effects:** one [`tPri_Log_Helphub_ContactForm`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_log_helphub_contactform.md) row with the caller as `uuid_tUser`, and one email to the support mailbox with the caller's name, sign-in email and mobile number ([Contact form](#contact-form)). No HubSpot call, no ticket and no push \[[ASK-189](https://github.com/snapfix/docs/blob/main/ASK.md#ask-189-should-contact-form-messages-create-a-hubspot-ticket)].

## GET /v1/app/help-hub/{category}

Lists the articles of one help category for signed-in users: the apps' FAQ screen, which asks for `faq`.

* **Auth:** user token. Any signed-in user; no role, site or group is checked.
* **Used by:** iOS (`FaqVC.getFAQList` when signed in, with the registry name `faq`: ios @ aa31967ac8, `SnapFix/FaqVC.swift:118-143`), Android (`HelpHubActivity.getFAQData` and `MyProfileActivity.getFAQData`: android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/activity/HelpHubActivity.kt:407-431`, `app/src/main/java/gmail/com/snapfixapp/activity/MyProfileActivity.kt:2733-2756`). The web doesn't call this route.

**Request**

| Name       | In   | Type   | Required | Rules                                                                                                                                                                                                                                                                                                             |
| ---------- | ---- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `category` | path | string | yes      | One of `what-is-snapfix`, `faq`, `checklists`, `getting-started`, `troubleshooting`, `contact-support` or `subscription-billing` (api\_php\_live\_v2 @ ef3c4319f6, `config/helphub.php:13-21`). Anything else: `422` "The selected category is invalid." (`app/Http/Requests/v1/HelpHubArticlesRequest.php:9-26`) |

**Response** `200`: `data` is a list of [help article objects](#help-article-object).

* **`internal` source:** reads `resources/other/helphub/<category>.php`. Only `faq` has a file, with seven articles; the other six categories answer an empty list (`app/Services/HelpHub/Providers/InternalServiceProvider.php:11-26`).
* **`hubspot` source:** searches HubSpot's knowledge base for up to 50 articles of the category, then fetches each article's page, one after another with a 10-second timeout, for its text. Both caches are off unless `HUBSPOT_CACHE_ENABLED` is on (`app/Services/HelpHub/Providers/HubSpotServiceProvider.php:46-120`, `:271-303`; `config/helphub.php:27-34`). Each article's `content` is then one HTML string, not a list.
* The text is English whatever `Accept-Language` says.

```json
{
  "status": "success",
  "message": "Operation was successful",
  "data": [
    {
      "id": 1,
      "url": "https://support.example.com/knowledge/example-article",
      "title": "Example article",
      "description": "A made-up summary of the article.",
      "content": [
        "The first made-up paragraph.",
        "The second made-up paragraph."
      ]
    }
  ]
}
```

**Errors:** [common errors](https://docs.snapfix.com/engineering-reference/api/tasks.md#common-errors); `422` "The selected category is invalid." for an unknown category; `400` "Something went wrong" when the HubSpot search fails, while `APP_DEBUG` is off (`HubSpotServiceProvider.php:284-286`).

**Side effects:** none on the database. With the `hubspot` source, the HubSpot calls above, and cache writes when caching is on.

## POST /v1/guest/help-hub

Sends the same contact form without signing in, from the sign-in help pages. It is stored without a user.

* **Auth:** the shared guest Basic login; no user is read (api\_php\_live\_v2 @ ef3c4319f6, `routes/guest.php:30-34`, `app/Http/Middleware/AuthorizeGuestApi.php:16-27`). Each IP address may make 60 guest calls a minute and 1,000 a day (`app/Providers/RouteServiceProvider.php:107-117`, `:140-149`). Anyone with the shared login can send the form, and no CAPTCHA is asked.
* **Used by:** web (`GetInTouchComponent.onSubmit`, through `HelpHubHttpService.submitGetInTouchForm`, on `/auth/get-in-touch`: web\_app\_v2 @ 0989b8e685, `src/app/pages/auth/get-in-touch/get-in-touch.component.ts:48-72`, `src/app/services/help-hub/help-hub-http/help-hub-http.service.ts:28-35`, `src/app/pages/auth/auth.routes.ts:14`), iOS (`GetInTouchVC.callAPI` when signed out, with the registry name `help-hub-guest`; signed out, iOS sends the guest Basic login whatever the registry says: ios @ aa31967ac8, `SnapFix/GetInTouchVC.swift:121-125`, `APIManagers/APIManager.swift:1777-1780`), Android (`LoginHelpHubActivity.saveGetInTouchData`: android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/activity/LoginHelpHubActivity.kt:240-271`).
* The web also sends the five fields to Firebase Analytics, as the `get_in_touch_submit` event, before it checks the form (`get-in-touch.component.ts:49`, `src/app/services/fire-event/fire-event.service.ts:27-50`).

**Request:** JSON or form fields: the five [contact form fields](#contact-form).

**Response** `200`: as for [POST /v1/app/help-hub](#post-v1apphelp-hub).

**Errors:**

* `401` `{"error": "Unauthorized."}`: the guest login is missing or wrong.
* `400` "There is an issue with the service you are seeking for. ...": a blacklisted IP address or country. The blacklist's email check reads a `username` field, so the form's `email` is never checked (`app/Http/Middleware/Blacklist.php:47-54`).
* `400`: a malformed or unknown `X-API-Version` ([Requests](https://docs.snapfix.com/engineering-reference/api.md#requests)).
* `422`: a failed rule, as on `/v1/app`.
* `429`: a throttling rule for the route, while throttling is on (`app/Http/Middleware/RateLimiter.php:34-51`).
* `500` "An unexpected error occurred. Please try again later.": the per-IP limit of 60 calls a minute or 1,000 a day is reached. The error handler treats the framework's throttle error as a server error, so this limit never answers `429` (`app/Exceptions/Handler.php:78-85`, `:117-123`). The same `500` comes when `HUBSPOT_ACCESS_TOKEN` is not set.

**Side effects:** as for [POST /v1/app/help-hub](#post-v1apphelp-hub), without a user: `uuid_tUser` is `NULL`, `uuid_tUser_CreatedBy` and `uuid_tUser_ModifiedBy` are empty strings, and the email has no "Logged in User" lines ([Contact form](#contact-form)).

## GET /v1/guest/help-hub/{category}

Lists the articles of one category without signing in: the `faq` list on the sign-in help page, "Help with Logging in". None of its seven articles covers passwords, codes or invitations.

* **Auth:** the shared guest Basic login; no user is read. The per-IP limits of [POST /v1/guest/help-hub](#post-v1guesthelp-hub) apply.
* **Used by:** web (`HelpHubFaqComponent.loadFaqData`, through `HelpHubHttpService.getHelpHubFaq`, on `/auth/help-hub-faq`: web\_app\_v2 @ 0989b8e685, `src/app/pages/auth/help-hub-faq/help-hub-faq.component.ts:111-139`, `src/app/services/help-hub/help-hub-http/help-hub-http.service.ts:20-26`, `src/app/pages/auth/auth.routes.ts:13`), iOS (`FaqVC.getFAQList` when signed out, with the registry name `faq-guest`: ios @ aa31967ac8, `SnapFix/FaqVC.swift:122-127`), Android (`LoginHelpHubActivity.getFAQData`: android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/activity/LoginHelpHubActivity.kt:282-306`). Where the page opens is in [sign-in help](https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md).

**Request**

| Name       | In   | Type   | Required | Rules                                                                                     |
| ---------- | ---- | ------ | -------- | ----------------------------------------------------------------------------------------- |
| `category` | path | string | yes      | The same values and rule as [GET /v1/app/help-hub/{category}](#get-v1apphelp-hubcategory) |

**Response** `200`: `data` is a list of [help article objects](#help-article-object), from the same source as on `/v1/app`.

**Errors:** `401` `{"error": "Unauthorized."}` for a missing or wrong guest login; `422` "The selected category is invalid."; `400` for a blacklisted IP address or country, a bad `X-API-Version`, or a failed HubSpot search; `429` for a throttling rule; `500` when the per-IP limit is reached.

**Side effects:** none on the database. With the `hubspot` source, the same HubSpot calls as on `/v1/app`.

## Contact form

The body of both POST routes, and what a submission does.

**Fields** (api\_php\_live\_v2 @ ef3c4319f6, `app/Http/Requests/v1/HelpHubContactFromRequest.php:10-19`)

| Name        | In   | Type   | Required | Rules                                                                                                                                     |
| ----------- | ---- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `firstName` | body | string | yes      | Any text, no length limit                                                                                                                 |
| `lastName`  | body | string | yes      | Any text, no length limit                                                                                                                 |
| `email`     | body | string | yes      | An email address (Laravel's `email` rule: "The email field must be a valid email address."). Not compared with the sender's sign-in email |
| `subject`   | body | string | yes      | Any text, no length limit                                                                                                                 |
| `message`   | body | string | yes      | Up to 5,000 characters                                                                                                                    |

Other fields are dropped: only these five are stored and emailed (`app/Http/Controllers/v1/Versions/v1_0/App/HelpHubController.php:38`).

**What a submission does**

| Effect                                                                                                                                                                       | Signed in (`/v1/app`)                                                                                                            | Signed out (`/v1/guest`)                                                                     |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| A [`tPri_Log_Helphub_ContactForm`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_log_helphub_contactform.md) row, with the five fields in `contactform_json` | `uuid_tUser`, `uuid_tUser_CreatedBy` and `uuid_tUser_ModifiedBy` hold the caller's UUID                                          | `uuid_tUser` is `NULL`; `uuid_tUser_CreatedBy` and `uuid_tUser_ModifiedBy` are empty strings |
| One email to the support mailbox                                                                                                                                             | The body adds the caller's name, sign-in email and mobile number                                                                 | The five fields only                                                                         |
| A HubSpot call or ticket                                                                                                                                                     | None \[[ASK-189](https://github.com/snapfix/docs/blob/main/ASK.md#ask-189-should-contact-form-messages-create-a-hubspot-ticket)] | None                                                                                         |
| A push notification                                                                                                                                                          | None                                                                                                                             | None                                                                                         |

The row is written by the HubSpot provider class, which writes only this table and calls nothing (`app/Services/HelpHub/Providers/HubSpotServiceProvider.php:36-44`, `app/Models/HelpHubContactFormModel.php:13`). No code in the repos reads the rows back or deletes them, so the email is the only way the form reaches support.

**Email** (`app/Http/Controllers/v1/Versions/v1_0/App/HelpHubController.php:42`, `app/Mail/HelpHubContactEmail.php`)

* **To:** the support mailbox in the server's `APP_SUPPORT_EMAIL` setting; the code default is `support@snapfix.com` (`config/app.php:33`).
* **Subject:** "HelpHub Contact Form" (`lang/en/messages.php:177`).
* **Body:** the `helphub_email` view. It reads "Hello," and "The following help hub contact form has been submitted". For a signed-in sender it adds "Logged in User" (the name), "Email" (the sign-in email) and "Mobile" (the country code and number). Then come "First Name", "Last Name", "Email", "Subject" and "Message" from the form, and "Thank you". It ends with a hidden 1×1 image from an external email-tracking domain (`resources/views/emails/en/helphub_email.blade.php:12-29`).
* **View:** the Mailable names `verification_code_email` in `build()` and `helphub_email` in `content()`. In Laravel 10, `content()` is applied after `build()`, so `helphub_email` is the view sent; the framework code is not in the clone, so this rests on laravel/framework 10.50.2 in `composer.lock` (`app/Mail/HelpHubContactEmail.php:37-54`).
* **Reply-to:** none. The envelope sets only the subject, so a reply doesn't reach the person who wrote (`app/Mail/HelpHubContactEmail.php:27-32`).
* **Sending:** the `SendEmail` job, through the provider that `MAIL_MAILER` picks: `mailgun`, `ses`, `internal`, or SMTP for anything else, the code default. With `internal`, the recipients, the subject and the whole HTML body go as JSON to `MASSAGING_INTERNAL_URL`, with the `MASSAGING_INTERNAL_*` login \[[ASK-12](https://github.com/snapfix/docs/blob/main/ASK.md#ask-12-which-settings-do-the-production-api-servers-use)] (`app/Jobs/SendEmail.php:32-36`, `app/Services/Mail/EmailProviderResolver.php:12-31`, `app/Services/Mail/Transports/InternalEmailTransport.php:39-50`, `config/mail.php:16`, `:89-94`).
* **When:** with the queue on Redis, as in `.env.example`, a worker sends the email after the answer, and a mail failure doesn't reach the sender. With the code default `sync`, the email is sent before the answer, and a mail failure gives `500` after the row is stored. The production setting is not in any repo \[[ASK-12](https://github.com/snapfix/docs/blob/main/ASK.md#ask-12-which-settings-do-the-production-api-servers-use)] (`config/queue.php:16`, `.env.example:50`).

```mermaid
flowchart LR
  A[Form submitted] --> B[Check the five fields]
  B --> C[Store the row]
  C --> D[Queue the email]
  D --> E[Answer success]
  D -.-> F[Queue sends the email]
```

## Help article object

One article in the two GET routes, passed through as the source gives it (api\_php\_live\_v2 @ ef3c4319f6, `app/Http/Resources/HelpHubFaqResource.php:14-23`).

| Field         | Type                          | Meaning                                                                                                                                                                                                                                                                                                                                             |
| ------------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`          | integer                       | The article's ID in its source. The internal FAQ numbers its seven articles 1 to 7                                                                                                                                                                                                                                                                  |
| `url`         | string                        | The article's page on the support site                                                                                                                                                                                                                                                                                                              |
| `title`       | string                        | The title. With `hubspot`, tags are stripped from it (`app/Services/HelpHub/Providers/HubSpotServiceProvider.php:51`)                                                                                                                                                                                                                               |
| `description` | string                        | A short summary                                                                                                                                                                                                                                                                                                                                     |
| `content`     | array of strings, or a string | The article's text blocks, in order. With `hubspot`, one string of the page's HTML, which the clients don't expect: all three read a list (android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/model/FAQItem.kt:8`; ios @ aa31967ac8, `SnapFix/FaqVC.swift:16`; web\_app\_v2 @ 0989b8e685, `src/app/models/help-hub/help-hub.model.ts:7`) |


---

# 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.snapfix.com/engineering-reference/api/help.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.
