Preview existing changes matching a rule definition

curl --request POST \
  --url https://api.coderabbit.ai/v1/triage/rules/preview \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "definition": {
    "name": "<string>",
    "scope": {
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "connectionId": "<string>",
      "providerOrigin": "<string>",
      "repositoryIds": [
        "<string>"
      ]
    },
    "description": "<string>",
    "conditions": "<unknown>",
    "filters": {
      "when": {
        "mode": "newly_matches"
      },
      "paths": [
        "<string>"
      ],
      "repositories": [
        {
          "repositoryId": "<string>",
          "paths": [
            "<string>"
          ]
        }
      ],
      "includedAuthors": [
        "<string>"
      ],
      "excludedAuthors": [
        "<string>"
      ],
      "includedTeams": [
        "<string>"
      ],
      "excludedTeams": [
        "<string>"
      ]
    },
    "action": {
      "kind": "bring_to_ready",
      "prompt": "<string>",
      "settings": {
        "inactivityHours": 4,
        "maxRepairRounds": 3,
        "fixCi": true,
        "addressCodeRabbit": true,
        "addressHumanFeedback": true
      }
    },
    "actions": [
      {
        "kind": "bring_to_ready",
        "prompt": "<string>",
        "settings": {
          "inactivityHours": 4,
          "maxRepairRounds": 3,
          "fixCi": true,
          "addressCodeRabbit": true,
          "addressHumanFeedback": true
        }
      }
    ]
  },
  "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "search": "<string>",
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "limit": 25,
  "org_id": "<string>",
  "org_name": "<string>"
}
'

import requests

url = "https://api.coderabbit.ai/v1/triage/rules/preview"

payload = {
    "definition": {
        "name": "<string>",
        "scope": {
            "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "connectionId": "<string>",
            "providerOrigin": "<string>",
            "repositoryIds": ["<string>"]
        },
        "description": "<string>",
        "conditions": "<unknown>",
        "filters": {
            "when": { "mode": "newly_matches" },
            "paths": ["<string>"],
            "repositories": [
                {
                    "repositoryId": "<string>",
                    "paths": ["<string>"]
                }
            ],
            "includedAuthors": ["<string>"],
            "excludedAuthors": ["<string>"],
            "includedTeams": ["<string>"],
            "excludedTeams": ["<string>"]
        },
        "action": {
            "kind": "bring_to_ready",
            "prompt": "<string>",
            "settings": {
                "inactivityHours": 4,
                "maxRepairRounds": 3,
                "fixCi": True,
                "addressCodeRabbit": True,
                "addressHumanFeedback": True
            }
        },
        "actions": [
            {
                "kind": "bring_to_ready",
                "prompt": "<string>",
                "settings": {
                    "inactivityHours": 4,
                    "maxRepairRounds": 3,
                    "fixCi": True,
                    "addressCodeRabbit": True,
                    "addressHumanFeedback": True
                }
            }
        ]
    },
    "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "search": "<string>",
    "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "limit": 25,
    "org_id": "<string>",
    "org_name": "<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({
    definition: {
      name: '<string>',
      scope: {
        organizationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        connectionId: '<string>',
        providerOrigin: '<string>',
        repositoryIds: ['<string>']
      },
      description: '<string>',
      conditions: '<unknown>',
      filters: {
        when: {mode: 'newly_matches'},
        paths: ['<string>'],
        repositories: [{repositoryId: '<string>', paths: ['<string>']}],
        includedAuthors: ['<string>'],
        excludedAuthors: ['<string>'],
        includedTeams: ['<string>'],
        excludedTeams: ['<string>']
      },
      action: {
        kind: 'bring_to_ready',
        prompt: '<string>',
        settings: {
          inactivityHours: 4,
          maxRepairRounds: 3,
          fixCi: true,
          addressCodeRabbit: true,
          addressHumanFeedback: true
        }
      },
      actions: [
        {
          kind: 'bring_to_ready',
          prompt: '<string>',
          settings: {
            inactivityHours: 4,
            maxRepairRounds: 3,
            fixCi: true,
            addressCodeRabbit: true,
            addressHumanFeedback: true
          }
        }
      ]
    },
    ruleId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    search: '<string>',
    cursor: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    limit: 25,
    org_id: '<string>',
    org_name: '<string>'
  })
};

fetch('https://api.coderabbit.ai/v1/triage/rules/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "change_ids": [
    "<string>"
  ],
  "awaiting_assessment_change_ids": [
    "<string>"
  ],
  "nextCursor": "<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
  }
}

POST

triage

rules

preview

Preview existing changes matching a rule definition

curl --request POST \
  --url https://api.coderabbit.ai/v1/triage/rules/preview \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "definition": {
    "name": "<string>",
    "scope": {
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "connectionId": "<string>",
      "providerOrigin": "<string>",
      "repositoryIds": [
        "<string>"
      ]
    },
    "description": "<string>",
    "conditions": "<unknown>",
    "filters": {
      "when": {
        "mode": "newly_matches"
      },
      "paths": [
        "<string>"
      ],
      "repositories": [
        {
          "repositoryId": "<string>",
          "paths": [
            "<string>"
          ]
        }
      ],
      "includedAuthors": [
        "<string>"
      ],
      "excludedAuthors": [
        "<string>"
      ],
      "includedTeams": [
        "<string>"
      ],
      "excludedTeams": [
        "<string>"
      ]
    },
    "action": {
      "kind": "bring_to_ready",
      "prompt": "<string>",
      "settings": {
        "inactivityHours": 4,
        "maxRepairRounds": 3,
        "fixCi": true,
        "addressCodeRabbit": true,
        "addressHumanFeedback": true
      }
    },
    "actions": [
      {
        "kind": "bring_to_ready",
        "prompt": "<string>",
        "settings": {
          "inactivityHours": 4,
          "maxRepairRounds": 3,
          "fixCi": true,
          "addressCodeRabbit": true,
          "addressHumanFeedback": true
        }
      }
    ]
  },
  "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "search": "<string>",
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "limit": 25,
  "org_id": "<string>",
  "org_name": "<string>"
}
'

import requests

url = "https://api.coderabbit.ai/v1/triage/rules/preview"

payload = {
    "definition": {
        "name": "<string>",
        "scope": {
            "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "connectionId": "<string>",
            "providerOrigin": "<string>",
            "repositoryIds": ["<string>"]
        },
        "description": "<string>",
        "conditions": "<unknown>",
        "filters": {
            "when": { "mode": "newly_matches" },
            "paths": ["<string>"],
            "repositories": [
                {
                    "repositoryId": "<string>",
                    "paths": ["<string>"]
                }
            ],
            "includedAuthors": ["<string>"],
            "excludedAuthors": ["<string>"],
            "includedTeams": ["<string>"],
            "excludedTeams": ["<string>"]
        },
        "action": {
            "kind": "bring_to_ready",
            "prompt": "<string>",
            "settings": {
                "inactivityHours": 4,
                "maxRepairRounds": 3,
                "fixCi": True,
                "addressCodeRabbit": True,
                "addressHumanFeedback": True
            }
        },
        "actions": [
            {
                "kind": "bring_to_ready",
                "prompt": "<string>",
                "settings": {
                    "inactivityHours": 4,
                    "maxRepairRounds": 3,
                    "fixCi": True,
                    "addressCodeRabbit": True,
                    "addressHumanFeedback": True
                }
            }
        ]
    },
    "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "search": "<string>",
    "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "limit": 25,
    "org_id": "<string>",
    "org_name": "<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({
    definition: {
      name: '<string>',
      scope: {
        organizationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        connectionId: '<string>',
        providerOrigin: '<string>',
        repositoryIds: ['<string>']
      },
      description: '<string>',
      conditions: '<unknown>',
      filters: {
        when: {mode: 'newly_matches'},
        paths: ['<string>'],
        repositories: [{repositoryId: '<string>', paths: ['<string>']}],
        includedAuthors: ['<string>'],
        excludedAuthors: ['<string>'],
        includedTeams: ['<string>'],
        excludedTeams: ['<string>']
      },
      action: {
        kind: 'bring_to_ready',
        prompt: '<string>',
        settings: {
          inactivityHours: 4,
          maxRepairRounds: 3,
          fixCi: true,
          addressCodeRabbit: true,
          addressHumanFeedback: true
        }
      },
      actions: [
        {
          kind: 'bring_to_ready',
          prompt: '<string>',
          settings: {
            inactivityHours: 4,
            maxRepairRounds: 3,
            fixCi: true,
            addressCodeRabbit: true,
            addressHumanFeedback: true
          }
        }
      ]
    },
    ruleId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    search: '<string>',
    cursor: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    limit: 25,
    org_id: '<string>',
    org_name: '<string>'
  })
};

fetch('https://api.coderabbit.ai/v1/triage/rules/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "change_ids": [
    "<string>"
  ],
  "awaiting_assessment_change_ids": [
    "<string>"
  ],
  "nextCursor": "<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 /triage/rules/preview --input request.json

To install and sign in to the CLI, see Call from the CLI.

An agent connected to the CodeRabbit MCP server runs this operation as the preview_triage_rule tool. The connection selects the organization, so the arguments have no org_id or org_name.

{
  "method": "tools/call",
  "params": {
    "name": "preview_triage_rule",
    "arguments": {
      "definition": {}
    }
  }
}

Authorizations

x-coderabbitai-api-key

string

header

required

See Authentication for the key types and where to create a key.

Body

application/json

definition

object

required

Show child attributes

ruleId

string<uuid>

string

Maximum string length: 200

cursor

string<uuid>

limit

integer

default:25

Required range: 1 <= x <= 50

org_id

string

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: 1

org_name

string

GitHub organization login, such as coderabbitai, not its display name. Matched case-insensitively within the authenticated workspace. Supply either org_name or org_id, never both; omit for organization keys and MCP connections.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$

Response

change_ids

string[]

required

awaiting_assessment_change_ids

string[]

required

nextCursor

required

Basics

Clients

Guides

API reference

Preview existing changes matching a rule definition

Authorizations

Body

Response