Get a branch's review state

GET

/api/orgs/{org}/projects/{project}/review

const url = 'https://api.wrktr.com/api/orgs/example/projects/example/review?branch=example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.wrktr.com/api/orgs/example/projects/example/review?branch=example' \
  --header 'Authorization: Bearer <token>'

Whether the review agent has reviewed the current head, and its verdict.

Authorizations

bearer
None

Parameters

Path Parameters

org

required

string

project

required

string

Query Parameters

branch

required

string

Responses

200

BranchReview

application/json

object

branch

required

string

headSha

required

string

status

required

string

Allowed values: ready reviewing stale none unavailable failed

stage

required

Any of:

string
null

string

Allowed values: describing waiting-for-checks reviewing

error

required

Any of:

string
null

string

verdict

required

Any of:

string
null

string

Allowed values: approve changes comment

summary

required

Any of:

string
null

string

reviewedSha

required

Any of:

string
null

string

threadsAdded

required

Any of:

number
string

number

resolved

required

Any of:

number
string

number

unplaced

required

Array<string>

model

required

Any of:

string
null

string

usage

required

Any of:

object
null

object

calls

required

Any of:

number
string

number

inputTokens

required

Any of:

number
string

number

cachedInputTokens

required

Any of:

number
string

number

outputTokens

required

Any of:

number
string

number

reasoningTokens

required

Any of:

number
string

number

costUsd

required

Any of:

unknown
null

Any of:

number
string

number

reviewedAt

required

Any of:

unknown
null

Any of:

number
string

number

Example

{
  "status": "ready",
  "stage": "describing",
  "verdict": "approve",
  "threadsAdded": "Infinity",
  "resolved": "Infinity",
  "usage": {
    "calls": "Infinity",
    "inputTokens": "Infinity",
    "cachedInputTokens": "Infinity",
    "outputTokens": "Infinity",
    "reasoningTokens": "Infinity",
    "costUsd": "Infinity"
  },
  "reviewedAt": "Infinity"
}

401

Unauthorized

application/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound | BranchNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

Example

{
  "_tag": "ProjectNotFound"
}