Skip to main content
POST
Request a review of the current pull-request head

Authorizations

x-coderabbitai-api-key
string
header
required

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

Path Parameters

repository_id
string
required
Pattern: ^[1-9]\d*$
pull_request_number
integer
required
Required range: 0 < x <= 2147483647

Body

application/json
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

accepted
boolean
required
message
string
required
observed_head_sha
string
required

Head observed before requesting a review. The existing dispatcher refreshes the PR and reviews its current head; this is not an execution identifier or completion guarantee.