Skip to main content
The repositories endpoints let you query all repos connected to your BugViper account, list their pull requests, and fetch detailed review run data. Every endpoint requires a valid Firebase ID Token in the Authorization header and returns JSON.

GET /api/v1/repos/overview

Returns all repositories connected to your account with aggregate statistics in a single call. Use this endpoint to populate a high-level summary view across all repos. Authentication required: Yes

Response

Returns an array of repository summary objects.
string
GitHub organization name or username that owns the repository.
string
Repository name.
integer
Total number of issues BugViper has raised across all PRs in this repository.
integer
Number of issues that have been marked as resolved or fixed.
integer
Count of distinct pull requests that have received at least one BugViper review.
integer
Total number of individual review runs executed across all PRs in this repository.

GET /api/v1/repos/{owner}/{repo}/prs

Lists all pull requests that have been reviewed for a given repository, ordered by most recently reviewed. Authentication required: Yes

Path Parameters

string
required
GitHub organization name or username that owns the repository.
string
required
Repository name.

Response

Returns an array of PR summary objects.
integer
The GitHub pull request number.
string
Title of the pull request as it appears on GitHub.
string
Current state of the PR: open, closed, or merged.
string
ISO 8601 timestamp of when the PR was merged, or null if not yet merged.
integer
Number of BugViper review runs that have been executed against this PR.

GET /api/v1/repos/{owner}/{repo}/prs/{pr_number}/reviews

Lists all review runs for a specific pull request. Each run corresponds to a single invocation of BugViper — for example, a full review triggered by @bugviper full review or a lint run triggered by @bugviper run lint. Authentication required: Yes

Path Parameters

string
required
GitHub organization name or username that owns the repository.
string
required
Repository name.
integer
required
The GitHub pull request number.

Response

Returns an array of review run summary objects, ordered from most recent to oldest.
integer
Sequential run number within this PR, starting at 1.
string
ISO 8601 timestamp of when this review run was triggered.
integer
Number of issues (bugs, security findings, etc.) reported in this run.
integer
Number of positive findings — areas of code the agent highlighted as well-written or correct.
string
Review mode used for this run: normal (single generalist agent) or deep (three specialized sub-agents running in parallel).

GET /api/v1/repos/{owner}/{repo}/prs/{pr_number}/reviews/{run_number}

Returns the full detail of a single review run, including the walkthrough summary, every issue found, and all positive findings. Use this endpoint to render a complete run detail view. Authentication required: Yes

Path Parameters

string
required
GitHub organization name or username that owns the repository.
string
required
Repository name.
integer
required
The GitHub pull request number.
integer
required
The sequential review run number to retrieve.

Response

integer
Sequential run number within this PR.
string
Review mode: normal or deep.
string
ISO 8601 timestamp of when this review run was triggered.
string
Walkthrough summary generated by the agent — describes which files were modified and the overall scope of the change.
array
Array of positive finding strings. Each entry is a short description of something the agent considered correct, well-structured, or otherwise praiseworthy in the diff.
array
Array of issue objects. Each object contains the following fields: