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

# API Overview

> Government Portal REST API

Structured JSON API for integrating BIM Engine with your permitting systems, internal tools, or AI agents. Copy this entire reference into your coding agent to build integrations.

## Base URL

```
https://gov.bimengine.ai/api/gov
```

## Authentication

All requests require a valid session cookie. Authenticate through the same mechanism as the web portal.

## Endpoints

| Method  | Path                                      | Description                                                          |
| ------- | ----------------------------------------- | -------------------------------------------------------------------- |
| `GET`   | `/api/gov/dashboard`                      | [Dashboard stats and recent submissions](/api/dashboard)             |
| `GET`   | `/api/gov/submissions`                    | [List submissions with filters](/api/submissions)                    |
| `GET`   | `/api/gov/submissions/:reviewId`          | [Submission detail with compliance items](/api/submissions)          |
| `PATCH` | `/api/gov/submissions/:reviewId`          | [Update status or assignment](/api/submissions)                      |
| `POST`  | `/api/gov/submissions/:reviewId/actions`  | [Record review action on a compliance item](/api/submission-actions) |
| `POST`  | `/api/gov/submissions/:reviewId/complete` | [Finalize a review](/api/submission-actions)                         |
| `GET`   | `/api/gov/codes`                          | [List code editions](/api/codes)                                     |
| `GET`   | `/api/gov/codes/:editionId`               | [Code edition detail](/api/codes)                                    |
| `GET`   | `/api/gov/inspections`                    | [List inspections](/api/inspections)                                 |
| `GET`   | `/api/gov/jurisdiction`                   | [Jurisdiction profile](/api/jurisdiction)                            |
| `GET`   | `/api/gov/analytics`                      | [Analytics data](/api/analytics)                                     |

## Status enums

### Submission status

```
PENDING | IN_REVIEW | APPROVED | REJECTED | NEEDS_RESPONSE
```

### Review action

```
APPROVE | FLAG | REJECT | SKIP
```

### AI verdict

```
GREEN (passing) | YELLOW (needs review) | RED (failing)
```