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

# Umbraco Search Documentation

Developer documentation on how to build with and extend Umbraco Search

Umbraco Search is a free and open source add-on for Umbraco CMS. It helps you build appealing search experiences for your website users, without requiring in-depth knowledge of the underlying search technology.

In addition, Umbraco Search can also power both the backoffice content search and the [Content Delivery API](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api).

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Installation</strong></td><td>Everything you need to install Umbraco Search.</td><td><a href="https://729597853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8y3HWAq58Pro6rEj1ehn%2Fuploads%2FcRykad1JvjKBxLcDFUdw%2FDocumentations%20Icons_Umbraco_Cloud_Setup.png?alt=media&amp;token=2183542d-fa18-4b3c-b9ff-da15aa0b0a45">Documentations Icons_Umbraco_Cloud_Setup.png</a></td><td><a href="/umbraco-search/installation/installation.md">Installation</a></td></tr><tr><td><strong>Getting Started</strong></td><td>Learn how to build with Umbraco Search.</td><td><a href="https://729597853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8y3HWAq58Pro6rEj1ehn%2Fuploads%2F3UB9oBY1pebiZuLbzHGx%2FDocumentations%20Icons_Umbraco_Commerce_Get_Started.png?alt=media&amp;token=06dac9fd-fbd5-4463-b497-402ceda8e4bc">Documentations Icons_Umbraco_Commerce_Get_Started.png</a></td><td><a href="/umbraco-search/getting-started/getting-started.md">Getting Started</a></td></tr><tr><td><strong>Extending</strong></td><td>Extension points to tailor your search experiences.</td><td><a href="https://729597853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8y3HWAq58Pro6rEj1ehn%2Fuploads%2FOgdWk1YPyY4WiEncMN2D%2FDocumentations%20Icons_Umbraco_CMS_Reference_Searching.png?alt=media&amp;token=f53f8a37-c29c-40d6-92bd-24b0697464ff">Documentations Icons_Umbraco_CMS_Reference_Searching.png</a></td><td><a href="/umbraco-search/extending/examine-search-provider.md">Examine Search Provider</a></td></tr></tbody></table>


---

# 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.umbraco.com/umbraco-search/readme.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.
