> For the complete documentation index, see [llms.txt](https://docs.osmosworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.osmosworks.com/introduction/readme.md). # Osmos Backend Documentation ## What is Osmos? Osmos is a multi-tenant backend that lets organizations (tenants) configure and offer services to their customers. A tenant administrator defines a service as a staged flow of questions, required documents, and optional charges. Customers submit requests; staff review them and convert accepted requests into applications. Applications progress through stages, collecting answers and documents, and may require payment before completion. The backend is implemented as a Spring Boot application using PostgreSQL for persistence, Redis for caching and sessions, Liquibase for migrations, and Paystack for payment processing. Notifications and file uploads use Resend and Cloudinary respectively. ## Who this documentation is for * **Backend engineers** extending or maintaining Osmos. * **Frontend and mobile engineers** integrating with the REST API. * **DevOps and platform operators** deploying and running the service. * **Tenant administrators and staff** who need to understand the backend operations their roles perform. ## How to use this documentation * Start with [Overview and core concepts](/overview-and-core-concepts/core-concepts.md) to understand the domain model. * Read [Architecture](/architecture/security.md) for request handling, security, and tenant isolation. * Explore [Business modules](/business-modules/service-configuration.md) for detailed behavior of each domain. * Use the [API reference](/api-reference/api.md) for endpoint details and examples. * Refer to the [Data model](/data-model/entities.md) and [Glossary](/glossary/glossary.md) for entity relationships and domain terms. ## Related links * [API reference overview](/api-reference/api.md) * [Architecture](/architecture/security.md) --- # 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.osmosworks.com/introduction/readme.md?ask=&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.