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

# PR Reviews

> Trigger and inspect automated pull request security reviews

export const ScarfPixel = () => <img referrerPolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=831669b6-b4bd-42cb-8832-2122c03e1d5f" alt="" width="1" height="1" style={{
  position: "absolute",
  width: 0,
  height: 0,
  opacity: 0,
  pointerEvents: "none"
}} />;

<ScarfPixel />

A PR review runs Strix on one pull request and shows the findings inline.

## Ways to trigger a review

After you install the GitHub App on a repository, reviews start:

* **Automatically when a PR is opened** (or marked ready for review). Strix does not review draft PRs.
* **Automatically on new pushes to an open PR** when `review_on_push` is enabled in your PR review settings.
* **When you tag Strix in a PR comment.** To start (or restart) a review, write `@strix` or `@strix-security` in a PR comment or an inline review comment. The commenter must be a repository owner, member, or collaborator. Comments from GitHub Apps and bots also start a review.
* **Through the API** with `POST /api/v1/pr-reviews/start` (refer to the section below).

## List PR reviews

```bash theme={null}
curl -X GET "https://app.strix.ai/api/v1/pr-reviews?limit=20" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
```

**Required scope:** `pr_reviews:read`

The CLI's human view shows the repository, PR number and title, branches, pull-request lifecycle, review status/verdict, and open/total findings. Request exact totals for every review disposition group and lane with:

```bash theme={null}
strix cloud pr-reviews list --include-counts
```

Use `--json` for the complete records and stable IDs in an agent workflow.

## Get a PR review

```bash theme={null}
curl -X GET "https://app.strix.ai/api/v1/pr-reviews/<PR_REVIEW_ID>" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
```

**Required scope:** `pr_reviews:read`

## List security issues caught by PR reviews

List every security issue that the PR reviews of your organization caught. Each issue appears once. Strix collapses repeated reports of the same issue across the review runs of one pull request. Dependency CVEs and retest rows are excluded. Set `include_stats=true` to also get the all-time impact numbers:

```bash theme={null}
curl -X GET "https://app.strix.ai/api/v1/pr-reviews/findings?include_stats=true" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
```

**Required scope:** `pr_reviews:read`

You can filter with `severity`, `pr_state`, `search`, and `repository_full_name`.

The matching CLI command can include the all-time impact totals:

```bash theme={null}
strix cloud pr-reviews findings --include-stats
```

Use `--json` when an agent needs the complete finding records.

## Start a PR review

Start a review for a pull request. Specify the provider and installation ID from the repository record, plus the repository full name and PR number:

```bash theme={null}
curl -X POST "https://app.strix.ai/api/v1/pr-reviews/start" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "github",
    "installation_id": 12345678,
    "repository_full_name": "my-org/my-repo",
    "pr_number": 42
  }'
```

**Required scope:** `pr_reviews:write`

The open-source CLI exposes the same operation as `strix cloud pr-reviews start --provider github --installation-id 12345678 --repository-full-name my-org/my-repo --pr-number 42`. Use `strix cloud repos list` to read `provider` and `installation_id`.

## PR review settings

Read the PR review configuration of your organization:

```bash theme={null}
curl -X GET "https://app.strix.ai/api/v1/pr-reviews/settings" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
```

**Required scope:** `pr_reviews:read`

The `review_on_push` setting controls automatic reviews when you push commits to an open PR. When this setting is off, reviews run only when a PR is opened or when a comment includes `@strix`.

Update one or more settings. The PATCH body is partial, but it must include at least one supported field:

```bash theme={null}
curl -X PATCH "https://app.strix.ai/api/v1/pr-reviews/settings" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"review_on_push":true}'
```

**Required scope:** `pr_reviews:write`


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