Read feedback on a specific stored plan version
curl --request GET \
--url https://api.coderabbit.ai/v1/code/tasks/{task_id}/plan/comments \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/code/tasks/{task_id}/plan/comments"
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/code/tasks/{task_id}/plan/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"task_id": "<string>",
"version": 1,
"sha256": "<string>",
"revision": 1,
"threads": [
{
"id": "<string>",
"status": "open",
"location": {
"start_offset": 1,
"end_offset": 1,
"quote": "<string>"
},
"comments": [
{
"id": "<string>",
"text": "<string>",
"author": {
"user_id": "<string>",
"display_name": "<string>",
"handle": "<string>",
"avatar_url": "<string>"
},
"created_at": "<string>",
"updated_at": "<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 feedback on a specific stored plan version
Read GET /code/tasks/ for plan_version, then GET /code/tasks//plan?version= for version and sha256. Both must match the current stored plan; a changed plan is a conflict, so reread it before retrying. Includes open and resolved threads and omits deleted comments. This operation does not change feedback or approvals.
GET
/
v1
/
code
/
tasks
/
{task_id}
/
plan
/
comments
Read feedback on a specific stored plan version
curl --request GET \
--url https://api.coderabbit.ai/v1/code/tasks/{task_id}/plan/comments \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/code/tasks/{task_id}/plan/comments"
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/code/tasks/{task_id}/plan/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"task_id": "<string>",
"version": 1,
"sha256": "<string>",
"revision": 1,
"threads": [
{
"id": "<string>",
"status": "open",
"location": {
"start_offset": 1,
"end_offset": 1,
"quote": "<string>"
},
"comments": [
{
"id": "<string>",
"text": "<string>",
"author": {
"user_id": "<string>",
"display_name": "<string>",
"handle": "<string>",
"avatar_url": "<string>"
},
"created_at": "<string>",
"updated_at": "<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 "/code/tasks/$TASK_ID/plan/comments?version=$VERSION&sha256=$SHA256"
An agent connected to the CodeRabbit MCP server runs this operation as the
list_code_task_plan_comments tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "list_code_task_plan_comments",
"arguments": {
"task_id": "<task_id>",
"version": 1,
"sha256": "<sha256>"
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
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?