Create an on-demand or scheduled report
curl --request POST \
--url https://api.coderabbit.ai/v1/reports \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"name": "<string>",
"time": "<string>",
"timezone": "<string>",
"parameters": [
{
"values": [
"<string>"
]
}
],
"emails": [
"jsmith@example.com"
],
"type": "ONDEMAND",
"from": "<string>",
"to": "<string>",
"org_id": "<string>",
"org_name": "<string>",
"channel": "<string>",
"prompt": "<string>"
}
'import requests
url = "https://api.coderabbit.ai/v1/reports"
payload = {
"name": "<string>",
"time": "<string>",
"timezone": "<string>",
"parameters": [{ "values": ["<string>"] }],
"emails": ["jsmith@example.com"],
"type": "ONDEMAND",
"from": "<string>",
"to": "<string>",
"org_id": "<string>",
"org_name": "<string>",
"channel": "<string>",
"prompt": "<string>"
}
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({
name: '<string>',
time: '<string>',
timezone: '<string>',
parameters: [{values: ['<string>']}],
emails: ['jsmith@example.com'],
type: 'ONDEMAND',
from: '<string>',
to: '<string>',
org_id: '<string>',
org_name: '<string>',
channel: '<string>',
prompt: '<string>'
})
};
fetch('https://api.coderabbit.ai/v1/reports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"report_id": "<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
}
}Create an on-demand or scheduled report
Saves a configuration through the existing report creator, destination authorization and scheduling behavior. ONDEMAND requests also trigger native generation; the returned ID identifies configuration, not completed report content. The separate legacy /api/v1/report.generate API retains its existing generation contract.
POST
/
v1
/
reports
Create an on-demand or scheduled report
curl --request POST \
--url https://api.coderabbit.ai/v1/reports \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"name": "<string>",
"time": "<string>",
"timezone": "<string>",
"parameters": [
{
"values": [
"<string>"
]
}
],
"emails": [
"jsmith@example.com"
],
"type": "ONDEMAND",
"from": "<string>",
"to": "<string>",
"org_id": "<string>",
"org_name": "<string>",
"channel": "<string>",
"prompt": "<string>"
}
'import requests
url = "https://api.coderabbit.ai/v1/reports"
payload = {
"name": "<string>",
"time": "<string>",
"timezone": "<string>",
"parameters": [{ "values": ["<string>"] }],
"emails": ["jsmith@example.com"],
"type": "ONDEMAND",
"from": "<string>",
"to": "<string>",
"org_id": "<string>",
"org_name": "<string>",
"channel": "<string>",
"prompt": "<string>"
}
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({
name: '<string>',
time: '<string>',
timezone: '<string>',
parameters: [{values: ['<string>']}],
emails: ['jsmith@example.com'],
type: 'ONDEMAND',
from: '<string>',
to: '<string>',
org_id: '<string>',
org_name: '<string>',
channel: '<string>',
prompt: '<string>'
})
};
fetch('https://api.coderabbit.ai/v1/reports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"report_id": "<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 /reports --input request.json
An agent connected to the CodeRabbit MCP server runs this operation as the
create_report tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "create_report",
"arguments": {
"name": "<name>",
"time": "<time>",
"timezone": "<timezone>",
"parameters": [],
"emails": [],
"promptTemplate": "Daily Standup Report",
"type": "ONDEMAND",
"from": "<from>",
"to": "<to>"
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Body
application/json
- Option 1
- Option 2
- Option 3
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?