> For the complete documentation index, see [llms.txt](https://uci.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://uci.sunbird.org/use.md). # Use - [Choose your Persona](https://uci.sunbird.org/use/choose-your-persona.md): Choose the Persona that fits you best to view next steps - [Adopter - Install and use UCI](https://uci.sunbird.org/use/adopter.md): I want to use Sunbird UCI in my own project and I want to set up my own instance of Sunbird UCI - [Pre-requisites, Installation Setup, Post Setup](https://uci.sunbird.org/use/adopter/pre-requisites-installation-setup-post-setup.md) - [Setting up your very first conversation](https://uci.sunbird.org/use/adopter/setting-up-your-very-first-conversation.md) - [API Documentation](https://uci.sunbird.org/use/adopter/api-documentation.md) - [Data Exhaust and Analytics](https://uci.sunbird.org/use/adopter/data-exhaust-and-analytics.md) - [Posthog Event](https://uci.sunbird.org/use/adopter/posthog-event.md) - [Whatsapp (Netcore)](https://uci.sunbird.org/use/adopter/whatsapp-flow-for-uci.md) - [Environment Variables](https://uci.sunbird.org/use/adopter/about-the-env.md) - [Developer - Contribute to UCI](https://uci.sunbird.org/use/developer.md): I am an open-source enthusiast and I want to contribute to the Sunbird UCI - [UCI Basics](https://uci.sunbird.org/use/developer/uci-basics.md) - [XMessage Specification](https://uci.sunbird.org/use/developer/uci-basics/xmessage-specification.md) - [Transformers](https://uci.sunbird.org/use/developer/uci-basics/transformers.md) - [ODK Transformer](https://uci.sunbird.org/use/developer/uci-basics/transformers/odk-transformer.md) - [Interactive-Messages](https://uci.sunbird.org/use/developer/uci-basics/transformers/odk-transformer/interactive-messages.md) - [Media Messages](https://uci.sunbird.org/use/developer/uci-basics/transformers/odk-transformer/media-messages.md) - [Location](https://uci.sunbird.org/use/developer/uci-basics/transformers/odk-transformer/location.md) - [Broadcast Transformer](https://uci.sunbird.org/use/developer/uci-basics/transformers/broadcast-transformer.md) - [Adapters](https://uci.sunbird.org/use/developer/uci-basics/adapters.md) - [Firebase Notification Adapter](https://uci.sunbird.org/use/developer/uci-basics/adapters/firebase-notification-adapter.md) - [User Segment](https://uci.sunbird.org/use/developer/uci-basics/user-segment.md) - [Schema Overview](https://uci.sunbird.org/use/developer/uci-basics/schema-overview.md) - [UCI Core Schema](https://uci.sunbird.org/use/developer/uci-basics/schema-overview/uci-core-schema.md) - [XMessage Schema](https://uci.sunbird.org/use/developer/uci-basics/schema-overview/uci-core-schema/xmessage-schema.md) - [Assessment DB Schema](https://uci.sunbird.org/use/developer/uci-basics/schema-overview/uci-core-schema/assessment-db-schema.md) - [UCI API Schema](https://uci.sunbird.org/use/developer/uci-basics/schema-overview/uci-api-schema.md) - [Development environment](https://uci.sunbird.org/use/developer/development-environment.md) - [Backend Setup](https://uci.sunbird.org/use/developer/development-environment/backend-setup.md) - [Setting up IDE](https://uci.sunbird.org/use/developer/development-environment/setting-up-ide.md) - [Environment variable setup](https://uci.sunbird.org/use/developer/development-environment/environment-variable-setup.md) - [Debug services](https://uci.sunbird.org/use/developer/development-environment/debug-services.md) - [Build and Execute UCI](https://uci.sunbird.org/use/developer/development-environment/build-and-execute-uci.md) - [Frontend Setup (Admin Console)](https://uci.sunbird.org/use/developer/development-environment/frontend-setup-admin-console.md) - [Frontend Setup (PWA)](https://uci.sunbird.org/use/developer/development-environment/frontend-setup-pwa.md) - [Transport Socket](https://uci.sunbird.org/use/developer/development-environment/transport-socket.md) - [API Documentation](https://uci.sunbird.org/use/developer/api-documentation.md) - [Bot Setup APIs](https://uci.sunbird.org/use/developer/api-documentation/bot-setup-apis.md) - [History APIs](https://uci.sunbird.org/use/developer/api-documentation/history-apis.md) - [Direct Message APIs](https://uci.sunbird.org/use/developer/api-documentation/direct-message-apis.md) - [Vault APIs](https://uci.sunbird.org/use/developer/api-documentation/vault-apis.md) - [Database Schema](https://uci.sunbird.org/use/developer/database-schema.md) - [Cassandra Xmessage Database](https://uci.sunbird.org/use/developer/database-schema/database-cassandra.md) - [Postgres Forms Database](https://uci.sunbird.org/use/developer/database-schema/database-formsdb.md) - [Postgres User Analytics Database](https://uci.sunbird.org/use/developer/database-schema/database-user-analytics.md) - [Postgres Comms Database](https://uci.sunbird.org/use/developer/database-schema/database-comms.md) - [Contribution Guide](https://uci.sunbird.org/use/developer/contribution-guide.md) - [Your first PR](https://uci.sunbird.org/use/developer/contribution-guide/your-first-pr.md) - [Contribute an Adapter](https://uci.sunbird.org/use/developer/contribution-guide/create-an-adapter.md) - [Adapter Implementation](https://uci.sunbird.org/use/developer/contribution-guide/adapter-implementation.md) - [Create a Transformer](https://uci.sunbird.org/use/developer/contribution-guide/create-a-transformer.md) - [Contact the administrator](https://uci.sunbird.org/use/contact-the-administrator.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://uci.sunbird.org/use.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.