Submit a review

POST

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

curl --request POST \
  --url https://api.wrktr.com/api/orgs/example/projects/example/reviews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "example", "headSha": "example", "verdict": "approve", "summary": "example", "comments": [ { "path": "example", "line": "Infinity", "body": "example" } ], "notes": [ "example" ], "reviewerKind": "human" }'

A summary, a verdict and line comments in one go, on headSha: the branch head or a commit it descends from. Its threads follow their lines to newer heads. Reviewing another branch is how one agent reviews another’s work.

Authorizations

• bearer

Parameters

Path Parameters

org

required

string

project

required

string

Request Body^required

Media typeapplication/json

object

branch

required

string

headSha

required

string

verdict

required

string

Allowed values: approve changes comment

summary

required

string

comments

required

Array<object>

object

path

required

string

line

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

body

required

string

>= 1 characters

notes

Any of:

Array<string>

Array<string>

null

null

reviewerKind

Any of:

string

string

Allowed values: human agent

null

null

Responses

200

Review

Media typeapplication/json

object

id

required

string

branch

required

string

headSha

required

string

reviewer

required

string

reviewerKind

required

string

Allowed values: human agent

verdict

required

string

Allowed values: approve changes comment

summary

required

string

unplaced

required

Array<string>

model

required

Any of:

string

string

null

null

usage

required

Any of:

object

object

calls

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

inputTokens

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

cachedInputTokens

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

outputTokens

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

reasoningTokens

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

costUsd

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

null

null

state

required

string

Allowed values: open resolved dismissed

dismissedBy

required

Any of:

string

string

null

null

resolutionSha

required

Any of:

string

string

null

null

createdAt

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

resolvedAt

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

threads

required

object

open

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

resolved

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

outdated

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

Example

{
  "reviewerKind": "human",
  "verdict": "approve",
  "usage": {
    "calls": "Infinity",
    "inputTokens": "Infinity",
    "cachedInputTokens": "Infinity",
    "outputTokens": "Infinity",
    "reasoningTokens": "Infinity",
    "costUsd": "Infinity"
  },
  "state": "open",
  "createdAt": "Infinity",
  "resolvedAt": "Infinity",
  "threads": {
    "open": "Infinity",
    "resolved": "Infinity",
    "outdated": "Infinity"
  }
}

401

Unauthorized

Media typeapplication/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound | BranchNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

object

object

_tag

required

string

Allowed values: BranchNotFound

project

required

string

branch

required

string

Example

{
  "_tag": "ProjectNotFound"
}

422

LineNotFound | InvalidInput

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: LineNotFound

path

required

string

line

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

object

object

_tag

required

string

Allowed values: InvalidInput

message

required

string

Example

{
  "_tag": "LineNotFound",
  "line": "Infinity"
}