> For the complete documentation index, see [llms.txt](https://developer.emporix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.emporix.io/api-documentation/api-guides/utilities/search-service.md).

# Search Service

Searches custom instances for a tenant, stores saved searches, and manages the indexes and jobs used by that search.

{% hint style="danger" %}
This service is in preview mode - some of the features may not be fully operational yet.
{% endhint %}

Follow [Search Service Tutorials](/api-documentation/api-guides/utilities/search-service/search.md) to create an index, monitor its job, search custom instances, reuse saved searches, and copy index definitions.

### Key features and benefits

* Searches custom instances of one custom schema type by text, phrase, autocomplete, or wildcard
* Filters and combines matches with `and` and `or` groups
* Returns a page of custom instances, with an optional total count
* Stores a search for a custom schema type and runs it later with new text without starting an index build
* Creates, reads, updates, and deletes a search index for a custom schema type
* Starts a job to build an index when the index is created or when its field definition changes
* Updates `name` and `description` on a ready index without starting a job when the field definition stays the same
* Starts a job to delete an index
* Reads index jobs.


---

# 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://developer.emporix.io/api-documentation/api-guides/utilities/search-service.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.
