Create a coding task
curl --request POST \
--url https://api.coderabbit.ai/v1/code/tasks \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"repository_id": "<string>",
"branch": "<string>",
"instructions": "<string>",
"client_request_id": "<string>",
"org_id": "<string>",
"org_name": "<string>",
"is_private": true
}
'import requests
url = "https://api.coderabbit.ai/v1/code/tasks"
payload = {
"repository_id": "<string>",
"branch": "<string>",
"instructions": "<string>",
"client_request_id": "<string>",
"org_id": "<string>",
"org_name": "<string>",
"is_private": True
}
headers = {
"x-coderabbitai-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repository_id: '<string>',
branch: '<string>',
instructions: '<string>',
client_request_id: '<string>',
org_id: '<string>',
org_name: '<string>',
is_private: true
})
};
fetch('https://api.coderabbit.ai/v1/code/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"task": {
"task_id": "<string>",
"title": "<string>",
"status": "<string>",
"turn_status": "<string>",
"repository_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"pull_request_url": "<string>",
"plan_version": 1
},
"created": true
}{
"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
}
}Create a coding task
Uses the existing coding task admission, permissions, billing and product flags. Delivery initially produces a proposed patch.
POST
/
v1
/
code
/
tasks
Create a coding task
curl --request POST \
--url https://api.coderabbit.ai/v1/code/tasks \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"repository_id": "<string>",
"branch": "<string>",
"instructions": "<string>",
"client_request_id": "<string>",
"org_id": "<string>",
"org_name": "<string>",
"is_private": true
}
'import requests
url = "https://api.coderabbit.ai/v1/code/tasks"
payload = {
"repository_id": "<string>",
"branch": "<string>",
"instructions": "<string>",
"client_request_id": "<string>",
"org_id": "<string>",
"org_name": "<string>",
"is_private": True
}
headers = {
"x-coderabbitai-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repository_id: '<string>',
branch: '<string>',
instructions: '<string>',
client_request_id: '<string>',
org_id: '<string>',
org_name: '<string>',
is_private: true
})
};
fetch('https://api.coderabbit.ai/v1/code/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"task": {
"task_id": "<string>",
"title": "<string>",
"status": "<string>",
"turn_status": "<string>",
"repository_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"pull_request_url": "<string>",
"plan_version": 1
},
"created": true
}{
"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 --input request.json
An agent connected to the CodeRabbit MCP server runs this operation as the
create_code_task tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "create_code_task",
"arguments": {
"repository_id": "<repository_id>",
"branch": "<branch>",
"instructions": "<instructions>",
"client_request_id": "<client_request_id>"
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Body
application/json
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?