# Read the managed workspace diff

Use mode=uncommitted, mode=base or mode=pr to select the diff projection.

`GET /api/threads/{id}/diff`

Required permission: `thread:read`.

## Parameters

| Name | In | Type | Required | Description |

| --- | --- | --- | --- | --- |

| `id` | path | `string` | Yes | — |

| `mode` | query | `string` | No | — |

## Example request

```bash
curl --request GET \
  --url https://api.hoplite.sh/api/threads/id/diff \
  --header "X-Api-Key: $HOPLITE_API_KEY"
```

## 200 response

Successful response

Content type: `application/json`. Response type: `object`.

| Field | Type | Required | Constraints | Description |
| --- | --- | --- | --- | --- |
| `ok` | `boolean` | Yes | constant true | — |
| `diff` | `object` | Yes | — | — |
| `diff.threadId` | `string` | Yes | — | — |
| `diff.mode` | `string` | Yes | uncommitted · base · pr | — |
| `diff.files` | `object[]` | Yes | — | — |
| `diff.files.path` | `string` | Yes | — | — |
| `diff.files.previousPath` | `string` | No | — | — |
| `diff.files.state` | `string` | No | added · modified · deleted · renamed · copied · unmerged · unknown | — |
| `diff.files.additions` | `number` | No | — | — |
| `diff.files.deletions` | `number` | No | — | — |
| `diff.files.patch` | `string` | No | — | — |
| `diff.files.truncated` | `boolean` | No | — | — |
| `diff.files.truncatedReason` | `string` | No | file_too_large · snapshot_too_large · binary · generated | — |
| `diff.files.byteSize` | `number` | No | — | — |
| `diff.files.sha` | `string` | No | — | — |
| `diff.stats` | `object` | No | — | — |
| `diff.stats.files` | `number` | Yes | — | — |
| `diff.stats.additions` | `number` | Yes | — | — |
| `diff.stats.deletions` | `number` | Yes | — | — |
| `diff.source` | `string` | No | — | — |
| `diff.effectiveMode` | `string` | No | uncommitted · base · pr | — |
| `diff.isFallback` | `boolean` | No | — | — |
| `diff.unavailableReason` | `string` | No | — | — |

```json
{
  "ok": true,
  "diff": {
    "threadId": "thread_example",
    "mode": "base",
    "files": [
      {
        "path": "src/login.test.ts",
        "state": "modified",
        "additions": 1,
        "deletions": 0,
        "patch": "@@ -1 +1,2 @@\n describe(\"login\", () => {\n+  it.todo(\"redirects after login\");\n"
      }
    ],
    "stats": {
      "files": 1,
      "additions": 1,
      "deletions": 0
    }
  }
}
```

## Response headers

| Header | Type | Statuses | Description |

| --- | --- | --- | --- |

| `RateLimit` | `string` | `200`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Current ingress policy, remaining requests, and seconds until reset, for example `"ingress";r=599;t=60`. |

| `RateLimit-Policy` | `string` | `200`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Ingress quota and window, for example `"ingress";q=600;qu="requests";w=60`. |

| `X-RateLimit-Limit` | `integer` | `200`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Maximum requests allowed in the current rolling window. |

| `X-RateLimit-Remaining` | `integer` | `200`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Requests remaining in the current rolling window. |

| `X-RateLimit-Reset` | `integer` | `200`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Unix timestamp when the current rolling window resets. |

| `x-request-id` | `string` | `200`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Request correlation ID. |

| `Retry-After` | `integer` | `429`, `503` | Seconds until another request should be attempted. |

| `X-Retry-After` | `integer` | `429`, `503` | Legacy retry delay in seconds. |

## Status codes

- `200` — Successful response

- `400` — Invalid request. Validation responses include field paths.

- `401` — The API key is missing, invalid, or lacks the operation's permission.

- `402` — The organization does not have access to the requested product capability.

- `403` — The key's current user no longer has the required organization membership or role.

- `404` — The resource is not available in the authenticated scope.

- `409` — The request conflicts with a retry receipt or current resource state.

- `410` — The event cursor has expired; capture a fresh head and resource snapshot.

- `429` — The API-key rate limit has been exceeded.

- `500` — The API encountered an unexpected failure.

- `501` — The deployment has not configured the requested capability.

- `503` — A required API dependency, including the rate limiter, is unavailable.