Read the full published CodeRabbit summary
curl --request GET \
--url https://api.coderabbit.ai/v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review/summary \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review/summary"
headers = {"x-coderabbitai-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};
fetch('https://api.coderabbit.ai/v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"current_head_sha": "<string>",
"summary": {
"body_markdown": "<string>",
"source_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"reviewed_commit_sha": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}Read the full published CodeRabbit summary
Returns the latest published summary with machine-only payloads removed. A null summary means none was found. Its reviewed commit is unknown unless the source establishes it; the current PR head is not a summary commit identity.
GET
/
v1
/
repositories
/
{repository_id}
/
pull-requests
/
{pull_request_number}
/
review
/
summary
Read the full published CodeRabbit summary
curl --request GET \
--url https://api.coderabbit.ai/v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review/summary \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review/summary"
headers = {"x-coderabbitai-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};
fetch('https://api.coderabbit.ai/v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"current_head_sha": "<string>",
"summary": {
"body_markdown": "<string>",
"source_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"reviewed_commit_sha": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}- CLI Tool
- MCP Server
coderabbit api request "/repositories/$REPOSITORY_ID/pull-requests/$PULL_REQUEST_NUMBER/review/summary"
An agent connected to the CodeRabbit MCP server runs this operation as the
get_pull_request_review_summary tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "get_pull_request_review_summary",
"arguments": {
"repository_id": "<repository_id>",
"pull_request_number": 1
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Path Parameters
Query Parameters
Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.
Minimum string length:
1Was this page helpful?