> For the complete documentation index, see [llms.txt](https://guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/project-comparison-apis/compare-documents-v2.md).

# Compare Documents (Api-Version: 2)

**`POST /projects/compare/documents`** — requires `Api-Version: 2` header

Compares two or more project documents. Version 2 returns an extended response that includes separate comparison results for both `projects` and `presentations`.

***

## Request

### Headers

| Header        | Value | Required | Description                                                              |
| ------------- | ----- | -------- | ------------------------------------------------------------------------ |
| `Api-Version` | `2`   | Yes      | Enables V2 behaviour (extended response with projects and presentations) |

### Request Body

Either `documentId1` + `documentId2`, or `documentIds` (array of at least 2 IDs).

```json
{
  "documentId1": "f3b2a9c1e4d5678901234567",
  "documentId2": "a1b2c3d4e5f6789012345678"
}
```

```json
{
  "documentIds": [
    "f3b2a9c1e4d5678901234567",
    "a1b2c3d4e5f6789012345678"
  ]
}
```

| Field         | Type      | Required    | Description                                 |
| ------------- | --------- | ----------- | ------------------------------------------- |
| `documentId1` | String    | Conditional | First document ID (use with `documentId2`)  |
| `documentId2` | String    | Conditional | Second document ID (use with `documentId1`) |
| `documentIds` | String\[] | Conditional | Array of at least 2 document IDs            |

***

## Response

### Success Response

**Status:** `200 OK`

Returns an extended comparison result with separate sections for projects and presentations.

```json
{
  "projects": {
    "documents": {},
    "left": {},
    "right": {},
    "total": {}
  },
  "presentations": {
    "documents": {},
    "left": {},
    "right": {},
    "total": {}
  }
}
```

### Error Responses

| Status                      | Description                                                                |
| --------------------------- | -------------------------------------------------------------------------- |
| `422 Unprocessable Entity`  | Neither a valid document pair nor a valid `documentIds` array was provided |
| `500 Internal Server Error` | Unexpected server failure                                                  |


---

# 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://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/project-comparison-apis/compare-documents-v2.md?ask=<question>&goal=<user_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.
