Read a retained coding execution turn by its native start sequence
curl --request GET \
--url https://api.coderabbit.ai/v1/code/tasks/{task_id}/turns/{turn_start_seq} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/code/tasks/{task_id}/turns/{turn_start_seq}"
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}/turns/{turn_start_seq}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"start_seq": 123,
"status": "running",
"started_at": "<string>",
"completed_at": "<string>",
"submitted_at": "<string>",
"waiting_for_interaction_id": "<string>",
"result": {
"text": "<string>"
},
"error": {
"code": "execution_failed",
"message": "<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 a retained coding execution turn by its native start sequence
Includes the retained final assistant reply for a completed turn. Result is null while running or when no final reply is retained. Failed turns expose a public error message without internal diagnostics or tool traces.
GET
/
v1
/
code
/
tasks
/
{task_id}
/
turns
/
{turn_start_seq}
Read a retained coding execution turn by its native start sequence
curl --request GET \
--url https://api.coderabbit.ai/v1/code/tasks/{task_id}/turns/{turn_start_seq} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/code/tasks/{task_id}/turns/{turn_start_seq}"
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}/turns/{turn_start_seq}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"start_seq": 123,
"status": "running",
"started_at": "<string>",
"completed_at": "<string>",
"submitted_at": "<string>",
"waiting_for_interaction_id": "<string>",
"result": {
"text": "<string>"
},
"error": {
"code": "execution_failed",
"message": "<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/turns/$TURN_START_SEQ"
An agent connected to the CodeRabbit MCP server runs this operation as the
get_code_task_turn tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "get_code_task_turn",
"arguments": {
"task_id": "<task_id>",
"turn_start_seq": 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:
1Response
OK
Was this page helpful?