Get a review

GET /v1/reviews/{review_id}

Permission: read:reviews
Tokens: API key, CLI user token, Session token

Read a code review with its reviewers and every comment they returned, including the ones held back for anchoring outside the reviewed range.

Path parameters

review_idstringrequired

{

"base_sha": str,

"budget": float,

"cost": int,

"created_at": str,

"error": str,

"event": str,

"finalized_at": str,

"findings": int,

"github_review_id": int,

"head_sha": str,

"id": str,

"status": str,

"tokens": int

}

Response

base_shastringrequired

budgetnumberrequired

The reviewer sessions' spend budgets together, in US dollars.

commentsarray<ReviewComment>required

costintegerrequired

What the reviewer sessions cost together, in millicents.

created_atstring, date-timerequired

errorstring

eventenum

The GitHub review event the platform submitted, from the config's output.on_pass or output.on_fail; null until posted.

one ofCOMMENTAPPROVEREQUEST_CHANGES

finalized_atstring, date-time

findingsintegerrequired

Comments the reviewers returned, posted to GitHub or not.

github_review_idinteger

The GitHub review id once posted.

head_shastringrequired

The commit the review is anchored at.

idstringrequired

pull_requestReviewPullRequestrequired

repositoryReviewRepositoryrequired

reviewersarray<ReviewReviewer>required

statusenumrequired

running: reviewers are working. posted: one GitHub review was posted. empty: the review passed silently, so nothing was posted. failed: no reviewer finished or GitHub refused the review.

one ofrunningpostingpostedemptyfailed

tokensintegerrequired

Tokens the reviewer sessions consumed together, including prompt-cache reads and writes.

Path parameters

Response

On this page