Skip to main content
POST
Preview existing changes matching a rule definition

Authorizations

x-coderabbitai-api-key
string
header
required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Body

application/json
definition
object
required
ruleId
string<uuid>
Maximum string length: 200
cursor
string<uuid>
limit
integer
default:25
Required range: 1 <= x <= 50
org_id
string

Git-provider organization ID. Required for workspace keys; omit for organization keys. This differs from the CodeRabbit organization ID in scope.id.

Minimum string length: 1

Response

OK

change_ids
string[]
required
awaiting_assessment_change_ids
string[]
required
nextCursor
required