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

# Get Review

> Read a review's status, finding counts and redline file.

> [!NOTE]
>
> **Preview.** This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive `403 mcp_not_enabled`. See the [preview overview](/preview).

Returns one review: its type, status, files, finding counts and redline. Read the findings themselves with [List Findings](/api-reference/reviews/list-findings). It reads reviews started in the Wordsmith app as well as through the API.

To wait for a running review, long-poll its `operation_id` with [Get Operation](/api-reference/operations/get-operation) instead of polling this endpoint.

## Authentication

Requires an API key, or an OAuth token with `reviews:read`.

## Path parameters

**review\_id** `string` *required*

The review id, from the operation's `resource.id` or [List Reviews](/api-reference/reviews/list-reviews).

## Response

Returns `200` with the review. `findings` counts what has been found so far, so it grows while the review runs.

**id** `string` *required*

The review id.

**name** `string` *required*

The review's name, as the Wordsmith app shows it.

**type** `string` *required*

`playbook`, `instructions` or `counterparty_edits`. A `counterparty_edits` review triages the other side's tracked changes. It is started in the Word add-in or in chat, and the API can read it but not start one.

**status** `string` *required*

`queued`, `running`, `completed`, `failed` or `cancelled`. A review whose worker stopped responding reads `failed`.

**file\_ids** `string[]` *required*

The review's own copies of the reviewed files, in review order. Read them with the files API.

**playbook\_id** `string | null`

The playbook a `playbook` review ran.

**instructions** `string | null`

The instructions an `instructions` review checked.

**party** `string | null`

The side the review acts for, as named in the document.

**findings** `object` *required*

**properties**

**total** `integer`

Findings so far, whatever their status.

**issues** `integer`

Findings whose `status` is `issue`.

**high** `integer`

Issues of `high` severity.

**medium** `integer`

Issues of `medium` severity.

**low** `integer`

Issues of `low` severity.

**redline\_file\_id** `string | null`

The tracked-changes DOCX of every proposed amendment, once the review has written it. When the amendments change more than one reviewed document, it is a ZIP of one DOCX per document. `null` when no check proposed an amendment, or the review presents its changes another way.

**operation\_id** `string | null`

The latest operation you started on this review, such as the review itself or a redline.

**url** `string` *required*

Opens the review in Wordsmith. Viewers must sign in.

**created\_at** `string | null`

**updated\_at** `string | null`

```bash cURL theme={null}
curl "https://api.wordsmith.ai/api/v1/reviews/5f0c9a12-8e3b-4d71-a6c4-0b2e9f7d3c58" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"
```

```json Playbook theme={null}
{
  "id": "5f0c9a12-8e3b-4d71-a6c4-0b2e9f7d3c58",
  "name": "Customer: NDA Review",
  "type": "playbook",
  "status": "completed",
  "file_ids": ["4d2e6f81-3a5b-4c7d-9e0f-1a2b3c4d5e6f"],
  "playbook_id": "2c4b8f90-5d1e-4a37-b6e2-c8f0a3d71e45",
  "instructions": null,
  "party": "Customer",
  "findings": { "total": 32, "issues": 7, "high": 2, "medium": 3, "low": 2 },
  "redline_file_id": "c71e2a90-4b3d-4f68-9e15-8d0a6b2f3c47",
  "operation_id": "3b8e0f1c-6a2d-4e57-9c1b-2f7d8a4e6b90",
  "url": "https://app.wordsmith.ai/reviews/5f0c9a12-8e3b-4d71-a6c4-0b2e9f7d3c58",
  "created_at": "2026-10-13T09:00:00Z",
  "updated_at": "2026-10-13T09:03:41Z"
}
```

```json Instructions theme={null}
{
  "id": "d87cb8f9-a92d-4955-881d-2386545cb19f",
  "name": "supply-agreement.pdf",
  "type": "instructions",
  "status": "running",
  "file_ids": ["578a613e-fca6-453f-9110-1d7abd029895"],
  "playbook_id": null,
  "instructions": "Check that liability is capped at 12 months of fees.",
  "party": null,
  "findings": { "total": 2, "issues": 1, "high": 0, "medium": 1, "low": 0 },
  "redline_file_id": null,
  "operation_id": "4ae0de09-7ef8-4dcf-941a-b4d038009288",
  "url": "https://app.wordsmith.ai/reviews/d87cb8f9-a92d-4955-881d-2386545cb19f",
  "created_at": "2026-10-13T10:00:00Z",
  "updated_at": "2026-10-13T10:01:18Z"
}
```

## Errors

| Status | `error_code` | When |
| - | - | - |
| 404 | `resource_not_found` | No review with this id, or the caller cannot read it. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.