> ## 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. # Get a PR review > Fetches a PR review with its findings. Results are limited to repositories within the token's rbac scopes. ## OpenAPI ````yaml /openapi.json get /pr-reviews/{prReviewId} openapi: 3.1.0 info: title: Strix API version: 1.0.0 description: >- Public REST API for the Strix autonomous penetration testing platform. Manage scans, vulnerabilities, assets, schedules, API tokens, and webhooks. servers: - url: /api/v1 description: Strix v1 API security: - BearerAuth: [] tags: - name: Scans description: Launch, monitor, and manage security scans. - name: Vulnerabilities description: View and triage discovered vulnerabilities. - name: Assets description: Domains and repositories registered for scanning. - name: Schedules description: Recurring scan schedules (Pro plan). - name: Search description: Search across issues, pentests, PR reviews, chats, assets and schedules. - name: Tokens description: Manage API tokens for authentication. - name: Webhooks description: Configure webhook subscriptions for real-time event notifications. - name: Organization description: Workspace configuration for the authenticated organization. - name: Members description: Manage organization members and roles. - name: Invitations description: List and revoke organization invitations. - name: PR Reviews description: Automated security review of pull requests. - name: Connectors description: Network connectors for scanning internal/private targets. - name: Knowledge description: >- Organization knowledge base: documents, policies, and repo profiles that steer the agent. - name: Uploads description: Upload source/code/documentation archives for whitebox scans. - name: Integrations description: Third-party integrations (GitLab, Bitbucket, ticketing). - name: Chat description: Conversational agent sessions. - name: Analytics description: Aggregate dashboard analytics. - name: Test Users description: >- Per-domain test accounts (with optional MFA) the agent authenticates as during scans. - name: License description: Self-hosted license state, entitlements, and aggregate usage. - name: Supply Chain description: >- SBOM inventory, supply-chain findings, scans, and policy for connected repositories. - name: CLI description: >- Device authorization endpoints that let the Strix CLI and coding agents sign in and receive an API token. - name: Billing description: Credit balance, agent-payable top-ups, and automatic top-up settings. - name: Workspaces description: List, create, and switch workspaces. - name: Asset Discovery description: >- Passive reconnaissance runs that map the organization's external attack surface, and the discovered-asset inventory they fill. - name: Containers description: >- Container registries, tracked images, image scans, findings, and SBOM components. - name: Run Logs description: Persisted engine logs and the diagnostics bundle of a self-hosted install. paths: /pr-reviews/{prReviewId}: get: tags: - PR Reviews summary: Get a PR review description: >- Fetches a PR review with its findings. Results are limited to repositories within the token's rbac scopes. operationId: getPrReview parameters: - name: prReviewId in: path required: true description: PR review id. schema: type: string format: uuid responses: '200': description: PR review details. content: application/json: schema: $ref: '#/components/schemas/PrReviewDetail' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' security: - BearerAuth: - pr_reviews:read components: schemas: PrReviewDetail: allOf: - $ref: '#/components/schemas/PrReview' - type: object properties: vulnerabilities: type: array items: $ref: '#/components/schemas/PrReviewVulnerability' required: - vulnerabilities PrReview: type: object description: One PR review run plus PR-wide reconciled finding counts in `findings`. properties: id: type: string format: uuid organization_id: type: string user_id: type: - string - 'null' provider: type: string enum: - github - gitlab - bitbucket - azure_repos installation_id: type: integer status: type: string enum: - pending - running - completed - posting - posted - failed status_detail_code: oneOf: - $ref: '#/components/schemas/RunStatusDetailCode' - type: 'null' description: >- Reason code behind the current status. Set when the launch path or the infrastructure set the status, or when a `completed` scan ended early near its cost limit (`budget_near_limit`). `null` for an ordinary engine-owned status. status_detail: type: - string - 'null' description: >- Secret-free explanation of `status_detail_code`. Self-hosted installs return the exact infrastructure message, for example the Kubernetes scheduler message. The hosted product returns generic wording. For `budget_near_limit` every install returns the cost figures, for example `The run used $96.13 of its $100.00 cost limit (96%)…`. repository_full_name: type: string pr_number: type: integer pr_title: type: - string - 'null' pr_url: type: - string - 'null' head_branch: type: string description: Source branch reviewed by this run. base_branch: type: - string - 'null' description: >- Destination branch for the pull request. Null when the provider did not supply it. head_sha: type: string base_sha: type: - string - 'null' start_sha: type: - string - 'null' pr_author: type: - string - 'null' trigger: type: string enum: - webhook - manual mode: type: - string - 'null' enum: - review - verify_base - null pr_state: type: - string - 'null' enum: - open - merged - closed - null description: >- The pull request's own lifecycle, stamped when a review starts and kept live by provider webhooks. Null on older reviews. pr_merged_at: type: - string - 'null' format: date-time summary: type: - string - 'null' verdict: type: - string - 'null' enum: - approve - comment - request_changes - null findings_count: type: integer minimum: 0 description: >- Trigger-maintained count for this individual review run. Prefer the nested `findings.total` field for the PR-wide aggregate shown by list and detail views. open_findings_count: type: integer minimum: 0 description: >- Trigger-maintained unresolved count for this individual review run. Prefer nested `findings.unresolved.total` for the PR-wide actionable aggregate. max_open_score: type: - number - 'null' duration: type: - string - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time posted_at: type: - string - 'null' format: date-time findings: $ref: '#/components/schemas/PrReviewFindings' required: - id - organization_id - user_id - provider - installation_id - status - repository_full_name - pr_number - pr_title - pr_url - head_branch - base_branch - head_sha - base_sha - start_sha - pr_author - trigger - mode - pr_state - pr_merged_at - summary - verdict - findings_count - open_findings_count - max_open_score - duration - created_at - updated_at - posted_at - findings PrReviewVulnerability: type: object description: One deduplicated finding in the pull request's cross-run history. properties: id: type: string title: type: string description: type: string severity: $ref: '#/components/schemas/VulnerabilitySeverity' status: $ref: '#/components/schemas/VulnerabilityStatus' cve: type: - string - 'null' cvss: type: - number - 'null' created_at: type: string format: date-time target: type: - string - 'null' endpoint: type: - string - 'null' method: type: - string - 'null' code_locations: type: - array - 'null' items: type: object additionalProperties: true required: - id - title - description - severity - status - cve - cvss - created_at - target - endpoint - method - code_locations ErrorResponse: type: object properties: detail: type: string description: Human-readable explanation of the error. code: type: string description: >- Stable machine-readable error code. `insufficient_scope` means the token does not hold the scope that this endpoint requires. required_scope: $ref: '#/components/schemas/ApiV1Scope' description: >- Scope that the caller must add to the token. Returned with the `insufficient_scope` code. docs: type: string format: uri description: Documentation page that explains how to resolve the error. hint: type: string description: >- One instruction that resolves the error. For `insufficient_scope`, a CLI session gets the `strix cloud session scopes set full` or `strix cloud login --scope-profile full` command, and an API token gets the settings page where the user creates a token with the scope. When the owner's role cannot hold the scope, the hint asks for a role change instead. required: - detail RunStatusDetailCode: type: string enum: - sandbox_pending - config_missing - llm_not_configured - secrets_missing - connector_unavailable - credentials_unreadable - image_pull_failed - pod_unschedulable - pod_rejected - container_config_failed - volume_failed - sandbox_ended - sandbox_timeout - docker_unavailable - sandbox_create_failed - launch_failed - retest_already_running - watchdog_timeout - launch_no_telemetry - relaunch_failed - relaunches_exhausted - engine_failed - budget_near_limit description: >- Machine-readable reason behind a run status. `sandbox_pending` means the run still waits for the sandbox. `budget_near_limit` qualifies a `completed` scan: the run used 85% or more of its cost limit, so Strix stopped the investigation early and the result may be incomplete. `retest_already_running` qualifies a `failed` retest that never ran: another retest already held one of its issues when it was launched. All other codes explain a failure that the launch path or the infrastructure set, not the engine. PrReviewFindings: description: >- PR-wide finding counts used by list and detail views. They combine the selected/latest run's reconciled findings with deduplicated fixed findings from earlier runs of the same pull request. The top-level severity totals cover that aggregate; `unresolved` covers findings still open or in progress, `snoozed` counts deliberately deferred findings, and `fixed` includes fixed history across runs. allOf: - $ref: '#/components/schemas/SeverityCounts' type: object properties: unresolved: $ref: '#/components/schemas/SeverityCounts' snoozed: type: integer fixed: type: integer required: - unresolved - snoozed - fixed VulnerabilitySeverity: type: string enum: - critical - high - medium - low VulnerabilityStatus: type: string enum: - open - in_progress - snoozed - fixed - ignored - not_affected ApiV1Scope: type: string enum: - scans:read - scans:write - vulnerabilities:read - vulnerabilities:write - dependencies:read - schedules:read - schedules:write - assets:read - assets:write - organizations:read - organizations:write - members:read - members:write - invitations:read - invitations:write - webhooks:read - webhooks:write - tokens:write - audit:read - pr_reviews:read - pr_reviews:write - connectors:read - connectors:write - knowledge:read - knowledge:write - uploads:write - integrations:read - integrations:write - chat:read - chat:write - scans:message - analytics:read - llm:read - llm:write - test_users:read - test_users:write - discovery:read - discovery:write - license:read - supply_chain:read - supply_chain:write - billing:read - billing:write - containers:read - containers:write - logs:read SeverityCounts: type: object properties: total: type: integer critical: type: integer high: type: integer medium: type: integer low: type: integer required: - total - critical - high - medium - low responses: Unauthorized: description: Missing or invalid API token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: >- Insufficient permissions or missing scope. A missing scope returns the `insufficient_scope` code, the `required_scope` field, and a `hint` with the command or page that grants the scope, so a client can request the correct scope and retry. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' InternalError: description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: BearerAuth: type: http scheme: bearer description: >- API token obtained from the Tokens endpoint or CLI device login. Include as `Authorization: Bearer `. Requests made with a managed CLI session also include `X-Strix-Workspace: ` to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.