> For the complete documentation index, see [llms.txt](https://saral.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://saral.sunbird.org/learn/features/minimal-mode.md).

# Minimal Mode

For non-academic use-cases, there will be no fixed participants like students and hierarchy like class,section etc. So minimal mode is to address these non-academic use-cases where a layout roi can be selected by user,scanned and push the scanned data to backend.

`/schools/login` API reponse has flag `isMinimalMode` to enable minimal mode by default for given organization or school. Refer below sample response for `/schools/login` API for reference.

```
{
    "school": {
        "storeTrainingData": true,
        "name": "Dummy school 3",
        "schoolId": "demouser",
        "state": "gujrat",
        "autoSync": false,
        "autoSyncFrequency": 600000,
        "tags": false,
        "isMinimalMode": true
    }
}
```

![](https://811030052-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLe89Gzl6JNQ9inpB8sRg%2Fuploads%2FJvfMrbR8Fmq993mHk396%2Fimage.png?alt=media\&token=35e40e95-9445-49ea-8baa-c6a305c1496b) ![](https://811030052-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLe89Gzl6JNQ9inpB8sRg%2Fuploads%2FOaiU3wwGHT9JHPMKI4uh%2Fimage.png?alt=media\&token=6f8c6d68-08b6-4afb-be6b-fa9118bc5d22) ![](https://811030052-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLe89Gzl6JNQ9inpB8sRg%2Fuploads%2FzMDe4EZMuYWlql9LXw69%2Fimage.png?alt=media\&token=5b6d8d41-e053-4b95-8d2a-da63c286df13)&#x20;

From `v1.5.6` release and above, a switch option is added to switch between Regular and Minimal mode.&#x20;

![](https://811030052-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLe89Gzl6JNQ9inpB8sRg%2Fuploads%2FoDYptLd1xh67nkz8NhKB%2Fimage.png?alt=media\&token=3e957d3c-eea5-4071-8986-2ece40700fd9)![](https://811030052-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLe89Gzl6JNQ9inpB8sRg%2Fuploads%2Fcf2xPQ5igD6Dp8MpruqR%2Fimage.png?alt=media\&token=4a1a1526-153d-4060-aa33-7e831ed3aefc)

For minimal mode , classsId and sectionId will be defaulted to `0.`Backend data can be differentiated using these field values.


---

# 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://saral.sunbird.org/learn/features/minimal-mode.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.
