> ## Documentation Index
> Fetch the complete documentation index at: https://cpgrams.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with the CPGRAMS Simulation API in minutes

## Setup your development environment

Learn how to set up your environment and start using the CPGRAMS Simulation API for the Maker Residency 2025 program.

### API Access and Authentication

<AccordionGroup>
  <Accordion icon="key" title="Get your API key">
    To access the CPGRAMS Simulation API, you'll need an API key. You can generate your API key by following these steps:

    1. Visit [https://grm-unkey.vercel.app/](https://grm-unkey.vercel.app/)
    2. Log in to the platform
    3. Create a new API key

    By default, the generated API keys have access to all available APIs in the system.

    Your API key should be included in all API requests to the server in a header that looks like the following:

    ```
    Authorization: Bearer YOUR_API_KEY
    ```
  </Accordion>

  <Accordion icon="code" title="Make your first API call">
    Once you have your API key, you can make your first API call. Here's an example using curl to get the list of users:

    ```bash theme={null}
    curl -X GET \
      https://api.cpgrams-simulation.opennyai.org/users \
      -H 'Authorization: Bearer YOUR_API_KEY'
    ```

    Or using JavaScript fetch:

    ```javascript theme={null}
    fetch('https://api.cpgrams-simulation.opennyai.org/users', {
      method: 'GET',
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
      }
    })
    .then(response => response.json())
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
    ```
  </Accordion>
</AccordionGroup>

### Core API Functionality

<AccordionGroup>
  <Accordion icon="users" title="User Management">
    The API provides endpoints for creating, retrieving, and managing users with different roles:

    * Citizens: Regular users who can submit grievances
    * Officers: Government officials who handle grievances
    * Admins: System administrators with full access

    [View User Management API →](/api-reference/endpoint/get)
  </Accordion>

  <Accordion icon="file-pen" title="Grievance Submission">
    Citizens can submit grievances through the API, providing details such as:

    * Grievance category and subcategory
    * Description of the issue
    * Supporting documents
    * Personal information

    [View Grievance Submission API →](/api-reference/endpoint/create)
  </Accordion>

  <Accordion icon="arrows-spin" title="Status Updates and Assignment">
    Officers can update the status of grievances and assign them to other officers. The API supports the complete grievance lifecycle from submission to resolution.

    [View Status Update API →](/api-reference/endpoint/update-grievance)
  </Accordion>
</AccordionGroup>

## Building with the API

The CPGRAMS Simulation API is designed to help you build innovative solutions for public grievance redressal in India. Here are some key resources to get you started:

<CardGroup>
  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Explore the complete API documentation with all available endpoints.
  </Card>

  <Card title="Example Applications" icon="laptop-code" href="/essentials/code">
    View example applications built with the CPGRAMS Simulation API.
  </Card>

  <Card title="Design Principles" icon="paintbrush" href="/essentials/images">
    Learn about the design principles for building effective grievance redressal systems.
  </Card>

  <Card title="Maker Residency Program" icon="users" href="/">
    Learn more about the OpenNyAI Maker Residency 2025 program.
  </Card>
</CardGroup>

## Innovation Showcase

The Maker Residency will culminate in a final-day event on June 6, 2025, featuring:

* Live demos of tools in action
* Impact narratives from citizens and GROs
* Engagement with DARPG, PMO, funders, and civic leaders
* Launch of public-facing materials and Digital Public Goods