PR Reviews

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

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

Required scope: pr_reviews:read

Get a PR review

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

Start a PR review

Start a review for a pull request. Specify the repository full name and the PR number:

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

Required scope: pr_reviews:write

PR review settings

Read the PR review configuration of your organization:

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 the configuration. All fields are required:

curl -X PATCH "https://app.strix.ai/api/v1/pr-reviews/settings" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "exclude_bots": true,
    "excluded_authors": ["dependabot"],
    "reviewed_bots": [],
    "review_on_push": true,
    "allow_overage": false,
    "overage_review_cap": null
  }'

Required scope: pr_reviews:write

Getting Started

Guides

Ways to trigger a review

List PR reviews

Get a PR review

Start a PR review

PR review settings

​Ways to trigger a review

​List PR reviews

​Get a PR review

​Start a PR review

​PR review settings

Ways to trigger a review

List PR reviews

Get a PR review

Start a PR review

PR review settings