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

Get your API key

To access the CPGRAMS Simulation API, you’ll need an API key. During the Maker Residency onboarding process, you will receive your unique API key. If you haven’t received your key, please contact the program coordinators.

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

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:

curl -X GET \
  https://api.cpgrams-simulation.opennyai.org/users \
  -H 'Authorization: Bearer YOUR_API_KEY'

Or using JavaScript fetch:

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));

Core API Functionality

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 →

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 →

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 →

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:

API Reference

Explore the complete API documentation with all available endpoints.

Example Applications

View example applications built with the CPGRAMS Simulation API.

Design Principles

Learn about the design principles for building effective grievance redressal systems.

Maker Residency Program

Learn more about the OpenNyAI Maker Residency 2025 program.

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