> For the complete documentation index, see [llms.txt](https://knowlg.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowlg.sunbird.org/learn/product-and-developer-guide/assets-search-service.md).

# Search Service

The **search service** is designed to enable users to efficiently search and explore assets on the platform. The primary API for this purpose is the Composite search API, which provides a unified way to fetch various types of objects within the application. These objects include 'Content', 'ContentImage', 'Collection', 'CollectionImage', 'QuestionSet', 'QuestionSetImage', 'Asset', 'Channel', 'Framework', 'ObjectCategory', 'ObjectCategoryDefinition', 'License', 'Question', and more.

Users have the flexibility to apply filters based on any attribute of the [object model](https://github.com/Sunbird-Knowlg/knowledge-platform/tree/master/schemas). This means that they can narrow down their search results by specifying specific criteria, such as title, category, author, date, or any other relevant attribute associated with the objects.

By default, the Composite search API returns objects that have a 'status' of "Live" and a 'visibility' of "default". These defaults ensure that the initial search results are relevant and align with the platform's standard display settings.

It's important to note that the default result 'limit' is set to 100, meaning that the API will return up to 100 matching objects in a single response. If more results are needed, users may consider pagination or adjusting the limit accordingly.


---

# 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://knowlg.sunbird.org/learn/product-and-developer-guide/assets-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.
