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

# Search

Allow your team and users to search for knowledge

Customers can search for answers to their questions directly in the knowledge base. Searches from visitors who aren't logged in cover articles marked **Public**. Searches from logged-in customers also cover **Customer** articles whose filters they match.

Your team, when logged into Pylon, can also find [articles marked](/pylon-docs/knowledge-base/articles-and-collections.md#visibility) **Internal** and **Direct link only** articles through search.

Article titles, content, and [tags](/pylon-docs/knowledge-base/articles-and-collections.md#tags) are all searchable.

{% hint style="info" %}
On the **Performance** page of your knowledge base, the **Search** tab lists every search query and how many results it returned. Filter to **Zero results** to see what documentation to write next. See [Analytics](/pylon-docs/knowledge-base/analytics.md).
{% endhint %}

## **Federated Search**

If you've added external websites, such as your documentation site, as [Training Data](/pylon-docs/platform/training-data.md), knowledge base search is **federated** across them. Results from those sites appear alongside your articles.

<figure><img src="https://982123570-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9hXBoCTTNw5flARlUVJf%2Fuploads%2FaZYKOkF2WYpKZaR0zXuj%2FCleanShot%202024-11-09%20at%2016.54.27.png?alt=media&amp;token=816f7b06-528a-45c9-a70f-1ff14f4a0635" alt=""><figcaption><p>A search query with results from the knowledge base, documentation site, and marketing page.</p></figcaption></figure>

### Searchable domains

Choose which external sites appear in search results on your knowledge base's **Settings > Searchable domains** page. Turn **Include in search** on or off for each site. This applies to every knowledge base in your workspace. Click **Edit resources** to add or remove sites.

## Searching as a team member

Your team can search for knowledge base articles using [Command Search](/pylon-docs/platform/command-search.md) or from the issue detail view directly by clicking on the knowledge base icon in the sidebar of an issue.

<figure><img src="https://982123570-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9hXBoCTTNw5flARlUVJf%2Fuploads%2FCOOF9Zg64Bzaor6ApQbS%2FScreenshot%202025-03-26%20at%208.43.34%E2%80%AFPM.png?alt=media&amp;token=b53c3e06-4687-4a19-80c4-f764216f7b4b" alt=""><figcaption></figcaption></figure>

## AI Search

When your customer asks a question in the knowledge base search, Pylon's AI attempts to answer it directly at the top of the results under **Ask AI**, citing its sources. Customers can mark the answer **Helpful** or **Not helpful**.

AI answers also appear when customers search the knowledge base from the [chat widget](/pylon-docs/chat-widget/overview.md), in the customer's language. Widget search results include both your articles and pages from your searchable domains.

<figure><img src="https://982123570-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9hXBoCTTNw5flARlUVJf%2Fuploads%2FNyWvLiLBDKvrQoZVqHbT%2FCleanShot%202025-06-06%20at%2021.14.50.gif?alt=media&amp;token=634d52c1-1579-4705-9f05-33dd4ecd4fbf" alt=""><figcaption></figcaption></figure>


---

# 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.usepylon.com/pylon-docs/knowledge-base/search.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.
