Start review

POST
/api/v1/reviews

Authorization

bearerAuth
headerAuthorizationBearer <token>

An API key created in Capy under Settings → API.

Request body

application/json
  1. body
repo*string
prNumber*integer
idempotencyKey?string
Length1 <= length <= 191
forceRefresh?boolean
sourceThreadId?string
model?string
effort?string
One of"none""instant""minimal""low""medium""high""xhigh""max"
tier?string

Review tier for this round, including its model, effort, and charge multiplier. Outranks the explicit model and both stored first-review and follow-up defaults. Omitted uses the default for the round's scope.

One of"low""medium""high"
shadow?boolean
headSha?string
Length40 <= length <= 40
projectId?string
memorySelection?string
One of"index""paths""select"

Response body

ReviewStarted

application/json
  1. response
reviewId*string
requestId*string
threadId*string
headSha*string
adopted*boolean
sourceRecorded?boolean
curl -X POST 'https://api.capy.ai/api/v1/reviews' \  -H 'Content-Type: application/json' \  -d '{  "repo": "string",  "prNumber": 0}'
{  "reviewId": "string",  "requestId": "string",  "threadId": "string",  "headSha": "string",  "adopted": true,  "sourceRecorded": true}
Open in Capy