🐰 New: Triage — a self-updating cross-repository queue that prioritizes pull requests by value and risk, so you always know what to review next. Explore Triage →
Read the existing CodeRabbit review status for a pull request
Reads the existing Triage observation after checking current repository and pull-request access. Null means no usable observation is available, not proof that no review ran. The observed target commit can differ from the current provider head. Unconfirmed means progress has not been confirmed recently, not that execution stopped. This does not create or track a new review execution.
GET
/
v1
/
repositories
/
{repository_id}
/
pull-requests
/
{pull_request_number}
/
review
Read the existing CodeRabbit review status for a pull request
curl --request GET \ --url https://api.coderabbit.ai/v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review \ --header 'x-coderabbitai-api-key: <api-key>'
Existing Triage review observation, or null when no usable observation is available. Compare target_commit_sha with head_sha; completion does not prove that the current head was reviewed or that results were published.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CodeRabbit","description":"Guides for Agentic Change Management: review, prioritize, understand, and secure changes across pull requests, your IDE, CLI, and team chat.","colors":{"primary":"#FF570A","light":"#FF570A","dark":"#FF570A"},"logo":{"light":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/coderabbit-logo-light.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=d2bf9e91be0e760ec9cb468676fa6ab6","dark":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/coderabbit-logo-dark.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=feeb1667ed4a2768a15b271f130395c0","href":"/"},"favicon":{"light":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/favicon-light.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=c0b0fbea23b48949cc631606f2a30022","dark":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/favicon-dark.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=4db7fc04860b6907c7f236f05b37f5c6"},"api":{"openapi":"openapi.json","playground":{"display":"simple"}},"navbar":{"primary":{"type":"button","label":"Sign up","href":"https://app.coderabbit.ai/login?free-trial="}},"footer":{"socials":{"x":"https://x.com/coderabbitai","linkedin":"https://www.linkedin.com/company/coderabbitai","github":"https://github.com/coderabbitai","discord":"https://discord.gg/GsXnASn26c"},"links":[{"header":"Resources","items":[{"label":"Blog","href":"https://coderabbit.ai/blog"},{"label":"Pricing","href":"https://www.coderabbit.ai/pricing"},{"label":"Changelog","href":"https://docs.coderabbit.ai/changelog"},{"label":"Support knowledge base","href":"https://kb.coderabbit.ai"}]},{"header":"Quick links","items":[{"label":"Schedule a demo","href":"https://www.coderabbit.ai/contact-us/sales"},{"label":"Get support","href":"https://docs.coderabbit.ai/support"},{"label":"Status page","href":"https://status.coderabbit.ai"},{"label":"Terms of service","href":"https://www.coderabbit.ai/terms-of-service"},{"label":"Privacy Policy","href":"https://coderabbit.ai/privacy-policy"}]}]},"seo":{"metatags":{"description":"Guides for Agentic Change Management: review, prioritize, understand, and secure changes across pull requests, your IDE, CLI, and team chat.","og:type":"website","og:site_name":"CodeRabbit Documentation","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@coderabbitai","canonical":"https://docs.coderabbit.ai"}},"fonts":{"heading":{"family":"Geist"},"body":{"family":"Geist"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"gtm":{"tagId":"GTM-5BWLXJRC"},"posthog":{"apiKey":"phc_6fDZRN9hYzB83I7Fk2GNHYqas4WMIdGBQ58aZ6EOZR0"}},"banner":{"content":"🐰 New: **Triage** — a self-updating cross-repository queue that prioritizes pull requests by value and risk, so you always know what to review next. [Explore Triage →](/triage)","dismissible":true,"type":"info","color":{"light":"#171717","dark":"#171717"}},"errors":{"404":{"redirect":false,"title":"Page Not Found. Sorry!","description":"Try **Search** or **Ask AI** to find what you're looking for.\nPress \u003ckbd>⌘K\u003c/kbd> (Mac) or \u003ckbd>Ctrl+K\u003c/kbd> (Windows/Linux) to open the search.\n\n\nNeed help? [Get support](/support)."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Quickstart","icon":"rocket","hidden":false,"href":"/getting-started/quickstart"},{"anchor":"Blog","icon":"pen-line","hidden":true,"href":"https://coderabbit.ai/blog"},{"anchor":"Changelog","icon":"history","href":"/changelog"},{"anchor":"Support","icon":"life-buoy","href":"/support"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/coderabbit"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"coderabbit","hasAudioNarration":false,"actualSubdomain":"coderabbit","customDomains":["docs.coderabbit.ai"],"gitSource":{"type":"github","owner":"coderabbitai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af307b8e49ad3dd9a8e80c1","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Management","count":241},{"language":"default","tag":"CodeRabbit API","count":188},{"language":"default","tag":"Platform API","count":170},{"language":"default","tag":"Platform API reference","count":165},{"language":"default","tag":"CodeRabbit Platform","count":158},{"language":"default","tag":"Tools","count":62},{"language":"default","tag":"Per-tool guides","count":59},{"language":"default","tag":"Languages","count":39},{"language":"default","tag":"CLI and IDE tools","count":33},{"language":"default","tag":"Security","count":26}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request","slug":"/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request","pageMetadata":{"title":"Read the existing CodeRabbit review status for a pull request","description":"Reads the existing Triage observation after checking current repository and pull-request access. Null means no usable observation is available, not proof that no review ran. The observed target commit can differ from the current provider head. Unconfirmed means progress has not been confirmed recently, not that execution stopped. This does not create or track a new review execution.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review","href":"/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Reads the existing Triage observation after checking current repository and pull-request access. Null means no usable observation is available, not proof that no review ran. The observed target commit can differ from the current provider head. Unconfirmed means progress has not been confirmed recently, not that execution stopped. This does not create or track a new review execution.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Read the existing CodeRabbit review status for a pull request","description":"Reads the existing Triage observation after checking current repository and pull-request access. Null means no usable observation is available, not proof that no review ran. The observed target commit can differ from the current provider head. Unconfirmed means progress has not been confirmed recently, not that execution stopped. This does not create or track a new review execution.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review","href":"/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/coderabbit/c83587702ff75216/inkeep.js","/_mintlify/custom/coderabbit/b7ecafa4358af1c7/yaml-editor.js","/_mintlify/custom/coderabbit/44fd990531d7b83e/acquisition.js"],"openApiReferenceData":{"operation":{"operationId":"get_pull_request_review","summary":"Read the existing CodeRabbit review status for a pull request","description":"Reads the existing Triage observation after checking current repository and pull-request access. Null means no usable observation is available, not proof that no review ran. The observed target commit can differ from the current provider head. Unconfirmed means progress has not been confirmed recently, not that execution stopped. This does not create or track a new review execution.","tags":["Reviews"],"parameters":["99e7bef6-871d-4df0-9a72-fe94fa6686e1","84fb0b69-fb8f-4897-93e6-cd7d50a0ba19","5eb545d0-cffe-4d8a-a688-7bc87a8a19cc"],"responses":{"200":"270fc315-0aae-49f3-8c7e-2643af6faffa","400":"7202edc8-6b0e-40b9-bca4-331b8f411df1","401":"52b1c810-452e-4623-b112-896f512e0b19","403":"60e99d74-dfe5-42df-8a56-dec86a68ca72","404":"5a21ade9-a5a3-4cc5-a564-1bfb150be0a9","409":"1ef5be58-dde5-4cbb-9b92-f2a46fbeaaf6","412":"e1b62404-9a56-4e7a-bb38-a4f422dd6ba9","413":"7f451c03-66e0-4f36-81ed-68211de899bc","429":"c8a398a7-e508-4dab-b71d-9c937d2e872f","500":"b749a9e9-481e-4462-8975-cd60be4ecf7b","503":"86502182-7261-431b-abe7-14081a66cff9"},"x-generated":true,"method":"get","type":"path","servers":["94307302-b1ff-453f-b134-032a703d9dae"],"security":["4f563bbd-7118-4c70-8fb3-c68be1b92b59"],"path":"/v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review","baseUrlOptions":["https://api.coderabbit.ai"],"title":"Read the existing CodeRabbit review status for a pull request","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"99e7bef6-871d-4df0-9a72-fe94fa6686e1":{"name":"repository_id","in":"path","required":true,"schema":{"type":"string","pattern":"^[1-9]\\d*$","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"84fb0b69-fb8f-4897-93e6-cd7d50a0ba19":{"name":"pull_request_number","in":"path","required":true,"schema":{"type":"integer","minimum":0,"maximum":2147483647,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"","typeLabel":"integer"}},"5eb545d0-cffe-4d8a-a688-7bc87a8a19cc":{"name":"org_id","in":"query","schema":{"type":"string","minLength":1,"description":"Git-provider organization ID. Required for workspace keys; omit for organization keys. This differs from the CodeRabbit organization ID in scope.id.","uniqueKey":"","typeLabel":"string"},"allowEmptyValue":true,"allowReserved":true}},"responses":{"270fc315-0aae-49f3-8c7e-2643af6faffa":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"head_sha":{"type":"string","description":"Current pull-request head reported by GitHub.","isRequired":true,"uniqueKey":"head_sha","typeLabel":"string"},"review":{"oneOf":[{"type":"object","description":"Existing Triage review observation, or null when no usable observation is available. Compare target_commit_sha with head_sha; completion does not prove that the current head was reviewed or that results were published.","required":["status","reason","request_id","target_commit_sha","requested_at","updated_at"],"properties":{"status":{"enum":["pending","starting","reviewing","failed","completed","unconfirmed"],"type":"string","description":"Existing review state. Unconfirmed means progress has not been confirmed recently; it does not establish that execution stopped.","example":"reviewing","isRequired":true,"uniqueKey":"review.oneOf.0.status","typeLabel":"enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","description":"Reason recorded by the existing review tracker, when available.","isRequired":true,"uniqueKey":"review.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"string","description":"Reason recorded by the existing review tracker, when available.","enum":[null],"isRequired":true,"uniqueKey":"review.oneOf.0.reason.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Reason recorded by the existing review tracker, when available.","enum":[null],"isRequired":true,"uniqueKey":"review.oneOf.0.reason.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"review.oneOf.0.reason","typeLabel":"string | enum\u003cstring> | null"},"request_id":{"oneOf":[{"type":"string","description":"Existing review request identifier, when available.","isRequired":true,"uniqueKey":"review.oneOf.0.request_id.oneOf.0","typeLabel":"string"},{"type":"string","description":"Existing review request identifier, when available.","enum":[null],"isRequired":true,"uniqueKey":"review.oneOf.0.request_id.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Existing review request identifier, when available.","enum":[null],"isRequired":true,"uniqueKey":"review.oneOf.0.request_id.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"review.oneOf.0.request_id","typeLabel":"string | enum\u003cstring> | null"},"target_commit_sha":{"oneOf":[{"type":"string","description":"Commit associated with the observation; it can differ from head_sha or be unknown.","isRequired":true,"uniqueKey":"review.oneOf.0.target_commit_sha.oneOf.0","typeLabel":"string"},{"type":"string","description":"Commit associated with the observation; it can differ from head_sha or be unknown.","enum":[null],"isRequired":true,"uniqueKey":"review.oneOf.0.target_commit_sha.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Commit associated with the observation; it can differ from head_sha or be unknown.","enum":[null],"isRequired":true,"uniqueKey":"review.oneOf.0.target_commit_sha.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"review.oneOf.0.target_commit_sha","typeLabel":"string | enum\u003cstring> | null"},"requested_at":{"oneOf":[{"type":"string","description":"Original request time, when recorded.","format":"date-time","isRequired":true,"uniqueKey":"review.oneOf.0.requested_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"string","description":"Original request time, when recorded.","enum":[null],"isRequired":true,"uniqueKey":"review.oneOf.0.requested_at.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Original request time, when recorded.","enum":[null],"isRequired":true,"uniqueKey":"review.oneOf.0.requested_at.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"review.oneOf.0.requested_at","typeLabel":"string\u003cdate-time> | enum\u003cstring> | null"},"updated_at":{"type":"string","format":"date-time","description":"Original observation timestamp, not the time this API response was read.","isRequired":true,"uniqueKey":"review.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"review.oneOf.0","typeLabel":"object"},{"type":"string","description":"Existing Triage review observation, or null when no usable observation is available. Compare target_commit_sha with head_sha; completion does not prove that the current head was reviewed or that results were published.","enum":[null],"isRequired":true,"uniqueKey":"review.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Existing Triage review observation, or null when no usable observation is available. Compare target_commit_sha with head_sha; completion does not prove that the current head was reviewed or that results were published.","enum":[null],"isRequired":true,"uniqueKey":"review.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"review","typeLabel":"object | enum\u003cstring> | null"}},"required":["head_sha","review"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"head_sha":"\u003cstring>","review":{"status":"reviewing","reason":"\u003cstring>","request_id":"\u003cstring>","target_commit_sha":"\u003cstring>","requested_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7202edc8-6b0e-40b9-bca4-331b8f411df1":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_request"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retry_after":{"type":"integer","minimum":0,"maximum":9007199254740991,"exclusiveMinimum":true,"uniqueKey":"error.retry_after","typeLabel":"integer"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","retry_after":4503599627370495}}}},"exampleType":"generated"}},"exampleType":"generated"},"52b1c810-452e-4623-b112-896f512e0b19":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["unauthenticated"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retry_after":{"type":"integer","minimum":0,"maximum":9007199254740991,"exclusiveMinimum":true,"uniqueKey":"error.retry_after","typeLabel":"integer"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthenticated","message":"\u003cstring>","retry_after":4503599627370495}}}},"exampleType":"generated"}},"exampleType":"generated"},"60e99d74-dfe5-42df-8a56-dec86a68ca72":{"description":"403","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["forbidden"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retry_after":{"type":"integer","minimum":0,"maximum":9007199254740991,"exclusiveMinimum":true,"uniqueKey":"error.retry_after","typeLabel":"integer"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"\u003cstring>","retry_after":4503599627370495}}}},"exampleType":"generated"}},"exampleType":"generated"},"5a21ade9-a5a3-4cc5-a564-1bfb150be0a9":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["not_found"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retry_after":{"type":"integer","minimum":0,"maximum":9007199254740991,"exclusiveMinimum":true,"uniqueKey":"error.retry_after","typeLabel":"integer"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"\u003cstring>","retry_after":4503599627370495}}}},"exampleType":"generated"}},"exampleType":"generated"},"1ef5be58-dde5-4cbb-9b92-f2a46fbeaaf6":{"description":"409","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["head_changed","conflict"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retry_after":{"type":"integer","minimum":0,"maximum":9007199254740991,"exclusiveMinimum":true,"uniqueKey":"error.retry_after","typeLabel":"integer"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"head_changed","message":"\u003cstring>","retry_after":4503599627370495}}}},"exampleType":"generated"}},"exampleType":"generated"},"e1b62404-9a56-4e7a-bb38-a4f422dd6ba9":{"description":"412","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["precondition_failed"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retry_after":{"type":"integer","minimum":0,"maximum":9007199254740991,"exclusiveMinimum":true,"uniqueKey":"error.retry_after","typeLabel":"integer"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"precondition_failed","message":"\u003cstring>","retry_after":4503599627370495}}}},"exampleType":"generated"}},"exampleType":"generated"},"7f451c03-66e0-4f36-81ed-68211de899bc":{"description":"413","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["payload_too_large"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retry_after":{"type":"integer","minimum":0,"maximum":9007199254740991,"exclusiveMinimum":true,"uniqueKey":"error.retry_after","typeLabel":"integer"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"payload_too_large","message":"\u003cstring>","retry_after":4503599627370495}}}},"exampleType":"generated"}},"exampleType":"generated"},"c8a398a7-e508-4dab-b71d-9c937d2e872f":{"description":"429","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["rate_limit_exceeded"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retry_after":{"type":"integer","minimum":0,"maximum":9007199254740991,"exclusiveMinimum":true,"uniqueKey":"error.retry_after","typeLabel":"integer"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limit_exceeded","message":"\u003cstring>","retry_after":4503599627370495}}}},"exampleType":"generated"}},"exampleType":"generated"},"b749a9e9-481e-4462-8975-cd60be4ecf7b":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["internal_error"],"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retry_after":{"type":"integer","minimum":0,"maximum":9007199254740991,"exclusiveMinimum":true,"uniqueKey":"error.retry_after","typeLabel":"integer"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"internal_error","message":"\u003cstring>","retry_after":4503599627370495}}}},"exampleType":"generated"}},"exampleType":"generated"},"86502182-7261-431b-abe7-14081a66cff9":{"description":"503","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retry_after":{"type":"integer","minimum":0,"maximum":9007199254740991,"exclusiveMinimum":true,"uniqueKey":"error.retry_after","typeLabel":"integer"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unavailable","message":"\u003cstring>","retry_after":4503599627370495}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4f563bbd-7118-4c70-8fb3-c68be1b92b59":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-coderabbitai-api-key","description":"API key for authentication. You can create an API key from the CodeRabbit dashboard.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"94307302-b1ff-453f-b134-032a703d9dae":{"url":"https://api.coderabbit.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-coderabbitai-api-key","description":"API key for authentication. You can create an API key from the CodeRabbit dashboard.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-coderabbitai-api-key","type":"string","description":"API key for authentication. You can create an API key from the CodeRabbit dashboard.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-coderabbitai-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"coderabbit","siteName":"CodeRabbit","title":"Read the existing CodeRabbit review status for a pull request - CodeRabbit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T06:30:08.465Z","originalFileLocation":"api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Reads the existing Triage observation after checking current repository and pull-request access. Null means no usable observation is available, not proof that no review ran. The observed target commit can differ from the current provider head. Unconfirmed means progress has not been confirmed recently, not that execution stopped. This does not create or track a new review execution.\">\u003cmeta data-mint-head name=\"application-name\" content=\"CodeRabbit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read the existing CodeRabbit review status for a pull request - CodeRabbit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reads the existing Triage observation after checking current repository and pull-request access. Null means no usable observation is available, not proof that no review ran. The observed target commit can differ from the current provider head. Unconfirmed means progress has not been confirmed recently, not that execution stopped. This does not create or track a new review execution.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CodeRabbit Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.coderabbit.ai/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://coderabbit.mintlify.site/_mintlify/api/og/v2?division=Reviews\u0026amp;title=Read+the+existing+CodeRabbit+review+status+for+a+pull+request\u0026amp;description=Reads+the+existing+Triage+observation+after+checking+current+repository+and+pull-request+access.+Null+means+no+usable+observation+is+available%2C+not+proof+that+n\u0026amp;theme=e25dc9e67170d7dae31e0b2f\u0026amp;signature=b4b4ceef66fb351420e7d911bbeaa9ef0c01d3cb708857fd5b934edb016bfe2b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Read the existing CodeRabbit review status for a pull request - CodeRabbit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reads the existing Triage observation after checking current repository and pull-request access. Null means no usable observation is available, not proof that no review ran. The observed target commit can differ from the current provider head. Unconfirmed means progress has not been confirmed recently, not that execution stopped. This does not create or track a new review execution.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://coderabbit.mintlify.site/_mintlify/api/og/v2?division=Reviews\u0026amp;title=Read+the+existing+CodeRabbit+review+status+for+a+pull+request\u0026amp;description=Reads+the+existing+Triage+observation+after+checking+current+repository+and+pull-request+access.+Null+means+no+usable+observation+is+available%2C+not+proof+that+n\u0026amp;theme=e25dc9e67170d7dae31e0b2f\u0026amp;signature=b4b4ceef66fb351420e7d911bbeaa9ef0c01d3cb708857fd5b934edb016bfe2b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CodeRabbit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF570A\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.coderabbit.ai/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.coderabbit.ai/#organization\",\"name\":\"CodeRabbit\",\"url\":\"https://docs.coderabbit.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/coderabbit-logo-light.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=d2bf9e91be0e760ec9cb468676fa6ab6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.coderabbit.ai#website\",\"name\":\"CodeRabbit\",\"url\":\"https://docs.coderabbit.ai\",\"publisher\":{\"@id\":\"https://docs.coderabbit.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.coderabbit.ai/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request#webpage\",\"url\":\"https://docs.coderabbit.ai/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request\",\"name\":\"Read the existing CodeRabbit review status for a pull request\",\"description\":\"Reads the existing Triage observation after checking current repository and pull-request access. Null means no usable observation is available, not proof that no review ran. The observed target commit can differ from the current provider head. Unconfirmed means progress has not been confirmed recently, not that execution stopped. This does not create or track a new review execution.\",\"dateModified\":\"2026-11-10T06:30:08.465Z\",\"isPartOf\":{\"@id\":\"https://docs.coderabbit.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.coderabbit.ai/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.coderabbit.ai/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CodeRabbit API\",\"item\":\"https://docs.coderabbit.ai/api/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Platform API\",\"item\":\"https://docs.coderabbit.ai/api/platform-api\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Platform API reference\",\"item\":\"https://docs.coderabbit.ai/api-reference/platform/post-apiv1reportgenerate\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Read the existing CodeRabbit review status for a pull request\",\"item\":\"https://docs.coderabbit.ai/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.coderabbit.ai/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request#apireference\",\"headline\":\"Read the existing CodeRabbit review status for a pull request\",\"name\":\"Read the existing CodeRabbit review status for a pull request\",\"description\":\"Reads the existing Triage observation after checking current repository and pull-request access. Null means no usable observation is available, not proof that no review ran. The observed target commit can differ from the current provider head. Unconfirmed means progress has not been confirmed recently, not that execution stopped. This does not create or track a new review execution.\",\"url\":\"https://docs.coderabbit.ai/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request\",\"mainEntityOfPage\":{\"@id\":\"https://docs.coderabbit.ai/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request#webpage\"},\"dateModified\":\"2026-11-10T06:30:08.465Z\",\"publisher\":{\"@id\":\"https://docs.coderabbit.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.coderabbit.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CodeRabbit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"CodeRabbit","nav":{"global":{"anchors":[{"anchor":"Quickstart","icon":"rocket","hidden":false,"href":"/getting-started/quickstart"},{"anchor":"Blog","icon":"pen-line","hidden":true,"href":"https://coderabbit.ai/blog"},{"anchor":"Changelog","icon":"history","href":"/changelog"},{"anchor":"Support","icon":"life-buoy","href":"/support"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/coderabbit"}]},"tabs":[{"tab":"CodeRabbit Platform","icon":"layers","pages":[{"title":"CodeRabbit Platform","href":""}]},{"tab":"CLI and IDE tools","icon":"square-terminal","pages":[{"title":"CLI and IDE tools","href":"/cli"}]},{"tab":"Coding Agent","icon":"square-code","pages":[{"title":"Coding Agent","href":"/code"}]},{"tab":"Agent for Slack and Discord","icon":"bot","pages":[{"title":"Agent for Slack and Discord","href":"/agent"}]},{"tab":"Management","icon":"wrench","pages":[{"title":"Management overview","sidebarTitle":"Overview","mode":"wide","href":"/management"},{"group":"Repository Configuration","icon":"folder-git-2","pages":[{"title":"Overview","href":"/platforms/overview"},{"group":"Supported Git platforms","expanded":false,"pages":[{"title":"GitHub","icon":"github","href":"/platforms/github-com"},{"title":"GitHub Enterprise Server","icon":"github","href":"/platforms/github-enterprise-server"},{"title":"GitLab","icon":"gitlab","href":"/platforms/gitlab-com"},{"title":"Self-managed GitLab","sidebarTitle":"GitLab self-managed","icon":"gitlab","href":"/platforms/self-hosted-gitlab"},{"title":"Azure DevOps","icon":"microsoft","href":"/platforms/azure-devops"},{"title":"Bitbucket Cloud","icon":"bitbucket","href":"/platforms/bitbucket-cloud"},{"title":"Bitbucket Data Center","icon":"bitbucket","href":"/platforms/bitbucket-data-center"}]}]},{"group":"Subscription \u0026 billing","icon":"credit-card","pages":[{"title":"Plans and pricing","sidebarTitle":"Plans and pricing","href":"/management/plans"},{"title":"Review rate limits","sidebarTitle":"Rate limits","href":"/management/rate-limits"},{"title":"Billing and changing plans","sidebarTitle":"Billing and changing plans","href":"/management/billing"},{"title":"Enterprise seat true-up","sidebarTitle":"Enterprise seat true-up","href":"/management/enterprise-seat-true-up"},{"title":"Usage-based reviews","sidebarTitle":"Usage-based reviews","href":"/management/usage-based-addon"},{"title":"Subscription management","sidebarTitle":"Subscription management","href":"/management/subscription-management"}]},{"group":"Connections","icon":"plug","pages":[{"title":"Connections","sidebarTitle":"Connections","href":"/connections/index"},{"title":"Scopes overview","sidebarTitle":"Scopes","href":"/connections/scopes"},{"title":"Review scopes","sidebarTitle":"Review scopes","href":"/connections/scopes-review"},{"title":"Connect MCP servers","sidebarTitle":"MCP servers","href":"/connections/mcp-servers"},{"group":"Issue trackers","root":{"title":"Issue trackers","href":"/connections/issue-trackers"},"pages":[{"title":"Jira Integration","icon":"jira","href":"/connections/jira"},{"title":"Linear Integration","icon":"linear","href":"/connections/linear"}]},{"group":"CI/CD tools","pages":[{"title":"CircleCI integration","sidebarTitle":"CircleCI","href":"/connections/circleci"},{"title":"Jenkins integration","sidebarTitle":"Jenkins","href":"/connections/jenkins"}]}]},{"group":"Dashboard","icon":"layout-dashboard","pages":[{"title":"Overview","href":"/guides/dashboard"},{"title":"Git platform review metrics","href":"/guides/dashboard-metrics"},{"title":"IDE/CLI review metrics","href":"/guides/ide-cli-dashboard-metrics"},{"title":"Review Usage dashboard","sidebarTitle":"Review Usage","href":"/management/review-usage-dashboard"},{"title":"Data Export","href":"/guides/data-export"}]},{"group":"Reports","icon":"text-search","pages":[{"title":"Reports Overview","sidebarTitle":"Overview","href":"/management/reports/index"},{"title":"Schedule reports","href":"/guides/scheduled-reports"},{"title":"Legacy Report Testing","href":"/guides/ondemand-reports"},{"title":"Customize CodeRabbit pull request reports with prompts","sidebarTitle":"Custom reports","href":"/guides/custom-reports"}]},{"group":"Organization administration","icon":"user-cog","pages":[{"title":"Seat assignment","href":"/management/seat-assignment"},{"title":"Role-based access","href":"/management/roles"},{"title":"Custom roles and permissions","href":"/management/custom-roles"},{"title":"Set up Multi-Org","sidebarTitle":"Multiple organizations","href":"/management/multi-org"},{"title":"Add organizations","href":"/management/adding-organizations"},{"title":"Set permissions","href":"/management/upgrading-permissions"},{"title":"Audit Logs","href":"/management/audit-logs"}]},{"group":"Enterprise SSO","icon":"key","pages":[{"title":"Enterprise SSO","sidebarTitle":"Overview","href":"/management/sso/index"},{"title":"Okta SAML SSO setup","sidebarTitle":"Okta SAML","href":"/management/sso/okta-saml"},{"title":"Google Workspace self-serve SSO setup","sidebarTitle":"Google Workspace","href":"/management/sso/google-workspace-saml"},{"title":"Microsoft Entra ID SSO setup","sidebarTitle":"Microsoft Entra ID","href":"/management/sso/microsoft-entra-saml"},{"title":"SAML 2.0 provider SSO setup","sidebarTitle":"Other SAML 2.0 providers","href":"/management/sso/custom-saml"},{"title":"Prepare self-hosted Git providers for SSO","sidebarTitle":"Self-hosted Git providers","href":"/management/sso/self-hosted-git-providers"},{"title":"Azure DevOps Server setup","sidebarTitle":"Azure DevOps Server","href":"/management/sso/azure-devops-server"},{"title":"SCIM directory sync","sidebarTitle":"SCIM directory sync","href":"/management/sso/scim"},{"title":"SSO user management API","sidebarTitle":"User management API","href":"/management/sso/user-management-api"}]},{"group":"Self-hosted CodeRabbit","icon":"server","pages":[{"title":"Self-hosted CodeRabbit","sidebarTitle":"Overview","href":"/self-hosted/overview"},{"group":"Reverse Tunnel","pages":[{"title":"CodeRabbit Reverse Tunnel","sidebarTitle":"Reverse Tunnel overview","href":"/self-hosted/coderabbit-reverse-tunnel"},{"title":"Reverse Tunnel connector configuration","sidebarTitle":"Connector configuration","href":"/self-hosted/reverse-tunnel-connector-configuration"}]}]},{"group":"CodeRabbit API","icon":"braces","pages":[{"title":"CodeRabbit API","sidebarTitle":"Overview","href":"/api/index"},{"title":"Workspace API tokens","href":"/api/workspace-api-tokens"},{"group":"Platform API","pages":[{"title":"Platform API","href":"/api/platform-api"},{"title":"Authenticate to the Platform API","href":"/api/platform-authentication"},{"title":"Platform API workflows","href":"/api/platform-workflows"},{"title":"Read repositories","href":"/api/platform-repositories"},{"title":"Read pull requests","href":"/api/platform-pull-requests"},{"group":"Platform API reference","pages":[{"group":"API Reference","pages":[{"title":"","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/report.generate","href":"/api-reference/platform/post-apiv1reportgenerate"},{"title":"Metrics Data","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/metrics/reviews","href":"/api-reference/platform/metrics-data"},{"title":"Roles","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/users/roles","href":"/api-reference/platform/roles"}]},{"group":"User Management","pages":[{"title":"List all users in the organization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/users","href":"/api-reference/platform/user-management/list-all-users-in-the-organization"},{"title":"Add users and assign seats for a self-hosted organization","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/users","href":"/api-reference/platform/user-management/add-users-and-assign-seats-for-a-self-hosted-organization"},{"title":"Assign or unassign seats for multiple users","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/users/seats","href":"/api-reference/platform/user-management/assign-or-unassign-seats-for-multiple-users"},{"title":"Update the seat assignment mode","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/users/seats/assignment","href":"/api-reference/platform/user-management/update-the-seat-assignment-mode"}]},{"group":"Audit Logs","pages":[{"title":"List audit log entries","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/audit-logs","href":"/api-reference/platform/audit-logs/list-audit-log-entries"}]},{"group":"Learnings","pages":[{"title":"List learnings for an organization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/learnings","href":"/api-reference/platform/learnings/list-learnings-for-an-organization"},{"title":"Delete a learning","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/learnings/{learning_id}","href":"/api-reference/platform/learnings/delete-a-learning"},{"title":"Update a learning","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/learnings/{learning_id}","href":"/api-reference/platform/learnings/update-a-learning"},{"title":"List saved Learnings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/learnings","href":"/api-reference/platform/learnings/list-saved-learnings"},{"title":"Save Learnings","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge/learnings","href":"/api-reference/platform/learnings/save-learnings"},{"title":"Read a saved Learning","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/learnings/{learning_id}","href":"/api-reference/platform/learnings/read-a-saved-learning"},{"title":"Delete a Learning","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/knowledge/learnings/{learning_id}","href":"/api-reference/platform/learnings/delete-a-learning-1"},{"title":"Update a Learning","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/knowledge/learnings/{learning_id}","href":"/api-reference/platform/learnings/update-a-learning-1"},{"title":"Read recorded Learning usage statistics","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/learnings/statistics","href":"/api-reference/platform/learnings/read-recorded-learning-usage-statistics"},{"title":"Read available Learning filters","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/learnings/filters","href":"/api-reference/platform/learnings/read-available-learning-filters"},{"title":"Export saved Learnings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/learnings/export","href":"/api-reference/platform/learnings/export-saved-learnings"}]},{"group":"Organizations","pages":[{"title":"List onboarded organizations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations","href":"/api-reference/platform/organizations/list-onboarded-organizations"},{"title":"List onboarded repositories for an organization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/repositories","href":"/api-reference/platform/organizations/list-onboarded-repositories-for-an-organization"}]},{"group":"Metrics","pages":[{"title":"Get MCP server usage by pull request","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/metrics/mcp","href":"/api-reference/platform/metrics/get-mcp-server-usage-by-pull-request"},{"title":"Get review comment metrics for merged pull requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/metrics/review-comments","href":"/api-reference/platform/metrics/get-review-comment-metrics-for-merged-pull-requests"}]},{"group":"Security","pages":[{"title":"List or export AI Deep Scan code findings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/scans/code","href":"/api-reference/platform/security/list-or-export-ai-deep-scan-code-findings"},{"title":"Export a software bill of materials","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/sbom/export","href":"/api-reference/platform/security/export-a-software-bill-of-materials"},{"title":"List code and secret findings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/findings","href":"/api-reference/platform/security/list-code-and-secret-findings"},{"title":"List vulnerable dependencies","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/dependencies","href":"/api-reference/platform/security/list-vulnerable-dependencies"},{"title":"List software bill of materials components","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/sbom","href":"/api-reference/platform/security/list-software-bill-of-materials-components"},{"title":"List security scan activity","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/scans","href":"/api-reference/platform/security/list-security-scan-activity"},{"title":"Request security scans for installed repositories","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/security/scans","href":"/api-reference/platform/security/request-security-scans-for-installed-repositories"},{"title":"Read an existing security scan","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/scans/{scan_id}","href":"/api-reference/platform/security/read-an-existing-security-scan"},{"title":"Estimate an AI Deep Scan","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/scans/quote","href":"/api-reference/platform/security/estimate-an-ai-deep-scan"},{"title":"Request an AI fix for a security finding","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/security/repositories/{repository_id}/findings/{finding_id}/fix","href":"/api-reference/platform/security/request-an-ai-fix-for-a-security-finding"},{"title":"Dismiss a security finding","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/security/repositories/{repository_id}/findings/{finding_id}/dismiss","href":"/api-reference/platform/security/dismiss-a-security-finding"},{"title":"Reopen a code security finding","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/security/repositories/{repository_id}/findings/{finding_id}/reopen","href":"/api-reference/platform/security/reopen-a-code-security-finding"},{"title":"Read a code security finding","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/findings/{finding_id}","href":"/api-reference/platform/security/read-a-code-security-finding"},{"title":"Read a secret finding","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/secrets/{finding_id}","href":"/api-reference/platform/security/read-a-secret-finding"},{"title":"Read a dependency and its advisories","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/dependencies/{dependency_id}","href":"/api-reference/platform/security/read-a-dependency-and-its-advisories"},{"title":"List secret scanner findings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/secrets","href":"/api-reference/platform/security/list-secret-scanner-findings"},{"title":"Read a runtime validation result","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/validations/{validation_id}","href":"/api-reference/platform/security/read-a-runtime-validation-result"},{"title":"List runtime validation attempts for a finding","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/validations","href":"/api-reference/platform/security/list-runtime-validation-attempts-for-a-finding"},{"title":"Read runtime validation availability for a finding","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/security/repositories/{repository_id}/findings/{finding_id}/validation-capability","href":"/api-reference/platform/security/read-runtime-validation-availability-for-a-finding"}]},{"group":"Bug Scan","pages":[{"title":"List or export Bug Scan findings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/bug-scan/findings","href":"/api-reference/platform/bug-scan/list-or-export-bug-scan-findings"}]},{"group":"Repositories","pages":[{"title":"List linked repositories","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/linked-repositories","href":"/api-reference/platform/repositories/list-linked-repositories"},{"title":"List accessible installed repositories","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories","href":"/api-reference/platform/repositories/list-accessible-installed-repositories"},{"title":"Get an accessible installed repository","description":"Returns 404 for repositories that are not installed in the selected organization or that the current user cannot read.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}","href":"/api-reference/platform/repositories/get-an-accessible-installed-repository"}]},{"group":"Reviews","pages":[{"title":"Read the existing CodeRabbit review status for a pull request","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review","href":"/api-reference/platform/reviews/read-the-existing-coderabbit-review-status-for-a-pull-request"},{"title":"Request a review of the current pull-request head","description":"Reuses the existing manual review dispatcher after checking the caller's current repository access. Does not accept an older commit, create a new review registry, or guarantee completion. Read the current review observation afterward.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review","href":"/api-reference/platform/reviews/request-a-review-of-the-current-pull-request-head"}]},{"group":"Pull requests","pages":[{"title":"List an accessible repository's pull requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/pull-requests","href":"/api-reference/platform/pull-requests/list-an-accessible-repositorys-pull-requests"},{"title":"Read an accessible pull request and its current checks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/pull-requests/{pull_request_number}","href":"/api-reference/platform/pull-requests/read-an-accessible-pull-request-and-its-current-checks"}]},{"group":"Identity","pages":[{"title":"Get the authenticated principal and selected organization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/me","href":"/api-reference/platform/identity/get-the-authenticated-principal-and-selected-organization"}]},{"group":"Usage","pages":[{"title":"Read permitted credit balances","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/credits","href":"/api-reference/platform/usage/read-permitted-credit-balances"},{"title":"Read current usage and permitted credit balances","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage","href":"/api-reference/platform/usage/read-current-usage-and-permitted-credit-balances"},{"title":"Read current usage budget policy and consumption","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/budget","href":"/api-reference/platform/usage/read-current-usage-budget-policy-and-consumption"},{"title":"Read paginated member usage budgets","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/budget/members","href":"/api-reference/platform/usage/read-paginated-member-usage-budgets"}]},{"group":"Architecture knowledge","pages":[{"title":"Read available architecture knowledge scopes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/architecture/capabilities","href":"/api-reference/platform/architecture-knowledge/read-available-architecture-knowledge-scopes"},{"title":"List repositories with architecture knowledge","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/architecture/repositories","href":"/api-reference/platform/architecture-knowledge/list-repositories-with-architecture-knowledge"},{"title":"List the current architecture knowledge document tree","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/architecture/tree","href":"/api-reference/platform/architecture-knowledge/list-the-current-architecture-knowledge-document-tree"},{"title":"Read an architecture knowledge document at an observed revision","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/architecture/document","href":"/api-reference/platform/architecture-knowledge/read-an-architecture-knowledge-document-at-an-observed-revision"}]},{"group":"Triage","pages":[{"title":"List the caller's accessible Triage changes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/changes","href":"/api-reference/platform/triage/list-the-callers-accessible-triage-changes"},{"title":"Read an accessible Triage change","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/changes/{id}","href":"/api-reference/platform/triage/read-an-accessible-triage-change"},{"title":"Read the recorded priority and close-candidacy history","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/changes/{id}/history","href":"/api-reference/platform/triage/read-the-recorded-priority-and-close-candidacy-history"},{"title":"List accessible Triage teams","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/teams","href":"/api-reference/platform/triage/list-accessible-triage-teams"}]},{"group":"Triage rules","pages":[{"title":"List Triage rules","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/rules","href":"/api-reference/platform/triage-rules/list-triage-rules"},{"title":"Create a Triage rule","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/triage/rules","href":"/api-reference/platform/triage-rules/create-a-triage-rule"},{"title":"Read a Triage rule and its definition","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/rules/{ruleId}","href":"/api-reference/platform/triage-rules/read-a-triage-rule-and-its-definition"},{"title":"Replace a Triage rule definition","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/triage/rules/{ruleId}","href":"/api-reference/platform/triage-rules/replace-a-triage-rule-definition"},{"title":"Delete a Triage rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/triage/rules/{ruleId}","href":"/api-reference/platform/triage-rules/delete-a-triage-rule"},{"title":"Preview existing changes matching a rule definition","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/triage/rules/preview","href":"/api-reference/platform/triage-rules/preview-existing-changes-matching-a-rule-definition"},{"title":"Activate, pause, or resume a Triage rule","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/triage/rules/{ruleId}/transition","href":"/api-reference/platform/triage-rules/activate-pause-or-resume-a-triage-rule"},{"title":"Read executions for a rule revision","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/triage/rules/{ruleId}/executions","href":"/api-reference/platform/triage-rules/read-executions-for-a-rule-revision"}]},{"group":"Knowledge","pages":[{"title":"List connected knowledge repositories","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge/connected-repositories","href":"/api-reference/platform/knowledge/list-connected-knowledge-repositories"},{"title":"Connect an installed repository as a knowledge source","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge/connected-repositories","href":"/api-reference/platform/knowledge/connect-an-installed-repository-as-a-knowledge-source"},{"title":"Request a connected repository index refresh","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge/connected-repositories/{repository_id}/reindex","href":"/api-reference/platform/knowledge/request-a-connected-repository-index-refresh"},{"title":"Disconnect a knowledge repository","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/knowledge/connected-repositories/{repository_id}","href":"/api-reference/platform/knowledge/disconnect-a-knowledge-repository"}]},{"group":"Automations","pages":[{"title":"List accessible automations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/automations","href":"/api-reference/platform/automations/list-accessible-automations"},{"title":"Create an ordinary Automation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/automations","href":"/api-reference/platform/automations/create-an-ordinary-automation"},{"title":"Read an ordinary Automation and its editable definition","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/automations/{automation_id}","href":"/api-reference/platform/automations/read-an-ordinary-automation-and-its-editable-definition"},{"title":"Replace an ordinary Automation definition at its observed revision","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/automations/{automation_id}","href":"/api-reference/platform/automations/replace-an-ordinary-automation-definition-at-its-observed-revision"},{"title":"List recorded ordinary Automation runs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/automations/{automation_id}/runs","href":"/api-reference/platform/automations/list-recorded-ordinary-automation-runs"},{"title":"Run, pause, resume, or delete an ordinary Automation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/automations/{automation_id}/commands","href":"/api-reference/platform/automations/run-pause-resume-or-delete-an-ordinary-automation"}]},{"group":"Configuration","pages":[{"title":"Read organization review configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/configuration/organization","href":"/api-reference/platform/configuration/read-organization-review-configuration"},{"title":"Replace organization review configuration","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/configuration/organization","href":"/api-reference/platform/configuration/replace-organization-review-configuration"},{"title":"Read workspace review configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/configuration/workspace","href":"/api-reference/platform/configuration/read-workspace-review-configuration"},{"title":"Read the effective review configuration and its layers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/configuration/effective","href":"/api-reference/platform/configuration/read-the-effective-review-configuration-and-its-layers"},{"title":"Read repository review configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/configuration","href":"/api-reference/platform/configuration/read-repository-review-configuration"},{"title":"Replace repository review configuration","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/repositories/{repository_id}/configuration","href":"/api-reference/platform/configuration/replace-repository-review-configuration"},{"title":"Preview effective repository configuration without saving","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/repositories/{repository_id}/configuration/preview","href":"/api-reference/platform/configuration/preview-effective-repository-configuration-without-saving"},{"title":"Read a repository's configuration source","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/repositories/{repository_id}/configuration/source","href":"/api-reference/platform/configuration/read-a-repositorys-configuration-source"},{"title":"Set a repository's configuration source","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/repositories/{repository_id}/configuration/source","href":"/api-reference/platform/configuration/set-a-repositorys-configuration-source"},{"title":"Read the workspace configuration-default policy","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/configuration/workspace-defaults","href":"/api-reference/platform/configuration/read-the-workspace-configuration-default-policy"},{"title":"Set the workspace configuration-default policy","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/configuration/workspace-defaults","href":"/api-reference/platform/configuration/set-the-workspace-configuration-default-policy"}]},{"group":"Connections","pages":[{"title":"List accessible workspace connections","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/connections","href":"/api-reference/platform/connections/list-accessible-workspace-connections"},{"title":"Create a workspace connection","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/connections","href":"/api-reference/platform/connections/create-a-workspace-connection"},{"title":"List pending workspace connection requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/connections/requests","href":"/api-reference/platform/connections/list-pending-workspace-connection-requests"},{"title":"Read an existing connection-request intent","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/connections/requests/{intent}","href":"/api-reference/platform/connections/read-an-existing-connection-request-intent"},{"title":"Submit an existing connection-request intent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/connections/requests/{intent}","href":"/api-reference/platform/connections/submit-an-existing-connection-request-intent"},{"title":"Verify a saved connection and complete matching requests","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/connections/{connectionId}/complete-requests","href":"/api-reference/platform/connections/verify-a-saved-connection-and-complete-matching-requests"},{"title":"Read masked saved-connection configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/connections/{connectionId}","href":"/api-reference/platform/connections/read-masked-saved-connection-configuration"},{"title":"Update a workspace connection","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/connections/{connectionId}","href":"/api-reference/platform/connections/update-a-workspace-connection"},{"title":"Delete a workspace connection","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/connections/{connectionId}","href":"/api-reference/platform/connections/delete-a-workspace-connection"},{"title":"Update a connection's name or description","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/connections/{connectionId}","href":"/api-reference/platform/connections/update-a-connections-name-or-description"},{"title":"Test a connection with existing credential and provider checks","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/connections/test","href":"/api-reference/platform/connections/test-a-connection-with-existing-credential-and-provider-checks"},{"title":"Discover tools from a configured MCP connection","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/connections/mcp/tools","href":"/api-reference/platform/connections/discover-tools-from-a-configured-mcp-connection"}]},{"group":"Coding","pages":[{"title":"List accessible coding tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks","href":"/api-reference/platform/coding/list-accessible-coding-tasks"},{"title":"Create a coding task","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks","href":"/api-reference/platform/coding/create-a-coding-task"},{"title":"Read an accessible coding task","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}","href":"/api-reference/platform/coding/read-an-accessible-coding-task"},{"title":"Read a stored coding plan version","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/plan","href":"/api-reference/platform/coding/read-a-stored-coding-plan-version"},{"title":"Approve or withdraw approval of a coding plan","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/code/tasks/{task_id}/plan/approval","href":"/api-reference/platform/coding/approve-or-withdraw-approval-of-a-coding-plan"},{"title":"Read a coding task's stored patch","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/patch","href":"/api-reference/platform/coding/read-a-coding-tasks-stored-patch"},{"title":"Read queued coding task messages","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/queue","href":"/api-reference/platform/coding/read-queued-coding-task-messages"},{"title":"Deliver a task patch using the caller's existing repository write authorization","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks/{task_id}/delivery","href":"/api-reference/platform/coding/deliver-a-task-patch-using-the-callers-existing-repository-write-authorization"},{"title":"Read existing autofix status for a task or pull request","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/autofix","href":"/api-reference/platform/coding/read-existing-autofix-status-for-a-task-or-pull-request"},{"title":"Enable, disable, resume or recover existing autofix","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/autofix/commands","href":"/api-reference/platform/coding/enable-disable-resume-or-recover-existing-autofix"},{"title":"List retained coding execution turns","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/turns","href":"/api-reference/platform/coding/list-retained-coding-execution-turns"},{"title":"Queue a follow-up coding message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks/{task_id}/turns","href":"/api-reference/platform/coding/queue-a-follow-up-coding-message"},{"title":"Read a retained coding execution turn by its native start sequence","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/turns/{turn_start_seq}","href":"/api-reference/platform/coding/read-a-retained-coding-execution-turn-by-its-native-start-sequence"},{"title":"Queue a plan revision using the existing replan operation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks/{task_id}/plan/revisions","href":"/api-reference/platform/coding/queue-a-plan-revision-using-the-existing-replan-operation"},{"title":"Implement a stored plan after its existing readiness checks","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks/{task_id}/plan/implementation","href":"/api-reference/platform/coding/implement-a-stored-plan-after-its-existing-readiness-checks"},{"title":"Read questions recorded in a task's recent execution history","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/questions","href":"/api-reference/platform/coding/read-questions-recorded-in-a-tasks-recent-execution-history"},{"title":"Answer an existing coding task interaction","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks/{task_id}/questions/{interaction_id}/answers","href":"/api-reference/platform/coding/answer-an-existing-coding-task-interaction"},{"title":"Request the existing human Stop action for a coding task","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/tasks/{task_id}/cancel","href":"/api-reference/platform/coding/request-the-existing-human-stop-action-for-a-coding-task"},{"title":"Read feedback on a specific stored plan version","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/tasks/{task_id}/plan/comments","href":"/api-reference/platform/coding/read-feedback-on-a-specific-stored-plan-version"}]},{"group":"Verify","pages":[{"title":"Update or archive a user journey with native revision checks","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/verify/repositories/{repository_id}/journeys/{cuj_id}","href":"/api-reference/platform/verify/update-or-archive-a-user-journey-with-native-revision-checks"},{"title":"List registered Verify repositories","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories","href":"/api-reference/platform/verify/list-registered-verify-repositories"},{"title":"Register an accessible repository with an existing execution environment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/verify/repositories","href":"/api-reference/platform/verify/register-an-accessible-repository-with-an-existing-execution-environment"},{"title":"Read a Verify repository and its recent jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}","href":"/api-reference/platform/verify/read-a-verify-repository-and-its-recent-jobs"},{"title":"Configure an existing Verify repository","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/verify/repositories/{repository_id}","href":"/api-reference/platform/verify/configure-an-existing-verify-repository"},{"title":"List registered user journeys","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/journeys","href":"/api-reference/platform/verify/list-registered-user-journeys"},{"title":"Create a user journey","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/verify/repositories/{repository_id}/journeys","href":"/api-reference/platform/verify/create-a-user-journey"},{"title":"List Verify jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/jobs","href":"/api-reference/platform/verify/list-verify-jobs"},{"title":"Start an existing Verify authoring, testability or execution operation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/verify/repositories/{repository_id}/jobs","href":"/api-reference/platform/verify/start-an-existing-verify-authoring-testability-or-execution-operation"},{"title":"Read a Verify job and execution statuses","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/jobs/{job_id}","href":"/api-reference/platform/verify/read-a-verify-job-and-execution-statuses"},{"title":"List Verify schedules","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/schedules","href":"/api-reference/platform/verify/list-verify-schedules"},{"title":"Read Verify schedule occurrences","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/schedules/{schedule_id}/history","href":"/api-reference/platform/verify/read-verify-schedule-occurrences"},{"title":"Create, update or delete a Verify schedule with native revision checks","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/verify/repositories/{repository_id}/schedules/changes","href":"/api-reference/platform/verify/create-update-or-delete-a-verify-schedule-with-native-revision-checks"},{"title":"Read observed bugs from a Verify job","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/jobs/{job_id}/bugs","href":"/api-reference/platform/verify/read-observed-bugs-from-a-verify-job"},{"title":"Read a Verify bug's observed history","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/bugs/{bug_id}/history","href":"/api-reference/platform/verify/read-a-verify-bugs-observed-history"},{"title":"Read a Verify execution result","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/executions/{execution_id}","href":"/api-reference/platform/verify/read-a-verify-execution-result"},{"title":"Read published Verify evidence metadata","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/executions/{execution_id}/evidence/{artifact_id}","href":"/api-reference/platform/verify/read-published-verify-evidence-metadata"},{"title":"List current Verify findings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/findings","href":"/api-reference/platform/verify/list-current-verify-findings"},{"title":"Download published Verify evidence","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/verify/repositories/{repository_id}/executions/{execution_id}/evidence/{artifact_id}/content","href":"/api-reference/platform/verify/download-published-verify-evidence"}]},{"group":"Coding environments","pages":[{"title":"List existing repository environment assignments","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/environment-assignments","href":"/api-reference/platform/coding-environments/list-existing-repository-environment-assignments"},{"title":"List coding environments","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/environments","href":"/api-reference/platform/coding-environments/list-coding-environments"},{"title":"Create a coding environment with existing preparation behavior","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/environments","href":"/api-reference/platform/coding-environments/create-a-coding-environment-with-existing-preparation-behavior"},{"title":"Read environment configuration without secret values","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/code/environments/{environmentId}","href":"/api-reference/platform/coding-environments/read-environment-configuration-without-secret-values"},{"title":"Update environment configuration with native revision checks","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/code/environments/{environmentId}","href":"/api-reference/platform/coding-environments/update-environment-configuration-with-native-revision-checks"},{"title":"Archive a coding environment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/code/environments/{environmentId}","href":"/api-reference/platform/coding-environments/archive-a-coding-environment"},{"title":"Assign a repository to a coding environment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/code/environments/{environmentId}/repositories","href":"/api-reference/platform/coding-environments/assign-a-repository-to-a-coding-environment"},{"title":"Update repository setup using its native revision check","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/code/environments/{environmentId}/repositories/{repositoryAssignmentId}","href":"/api-reference/platform/coding-environments/update-repository-setup-using-its-native-revision-check"},{"title":"Remove a repository environment assignment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/code/environments/{environmentId}/repositories/{repositoryAssignmentId}","href":"/api-reference/platform/coding-environments/remove-a-repository-environment-assignment"},{"title":"Set an environment variable using existing encrypted storage","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/code/environments/{environmentId}/variables","href":"/api-reference/platform/coding-environments/set-an-environment-variable-using-existing-encrypted-storage"},{"title":"Delete an environment variable","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/code/environments/{environmentId}/variables/{variableId}","href":"/api-reference/platform/coding-environments/delete-an-environment-variable"}]},{"group":"Reports","pages":[{"title":"List existing report configurations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/reports","href":"/api-reference/platform/reports/list-existing-report-configurations"},{"title":"Create an on-demand or scheduled report","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/reports","href":"/api-reference/platform/reports/create-an-on-demand-or-scheduled-report"},{"title":"Read an existing report configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/reports/{report_id}","href":"/api-reference/platform/reports/read-an-existing-report-configuration"},{"title":"Replace a recurring report configuration","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/reports/{report_id}","href":"/api-reference/platform/reports/replace-a-recurring-report-configuration"},{"title":"Delete a report configuration","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/reports/{report_id}","href":"/api-reference/platform/reports/delete-a-report-configuration"},{"title":"Enable or disable a report schedule","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/reports/{report_id}","href":"/api-reference/platform/reports/enable-or-disable-a-report-schedule"}]},{"group":"Administration","pages":[{"title":"List organization roles","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/configuration/roles","href":"/api-reference/platform/administration/list-organization-roles"},{"title":"Create a custom role by copying an existing role","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/configuration/roles","href":"/api-reference/platform/administration/create-a-custom-role-by-copying-an-existing-role"},{"title":"Read a role and its permissions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/configuration/roles/{roleId}","href":"/api-reference/platform/administration/read-a-role-and-its-permissions"},{"title":"Delete an unassigned custom role","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/configuration/roles/{roleId}","href":"/api-reference/platform/administration/delete-an-unassigned-custom-role"},{"title":"Update a custom role","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/configuration/roles/{roleId}","href":"/api-reference/platform/administration/update-a-custom-role"},{"title":"List supported role permissions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/configuration/roles/permissions","href":"/api-reference/platform/administration/list-supported-role-permissions"}]}]}]},{"group":"API Reference","expanded":false,"pages":[{"group":"Metrics","pages":[{"openapi":"get /v1/metrics/reviews","title":"Metrics Data","href":"/api-reference/metrics-data-api"},{"openapi":"get /v1/metrics/review-comments","title":"Review comment metrics","href":"/api-reference/review-comment-metrics"},{"openapi":"get /v1/metrics/mcp","title":"MCP server usage","href":"/api-reference/mcp-metrics"}]},{"group":"Learnings","pages":[{"openapi":"get /v1/learnings","title":"Learnings","href":"/api-reference/learnings-list"},{"openapi":"patch /v1/learnings/{learning_id}","title":"Update Learning","href":"/api-reference/learnings-update"},{"openapi":"delete /v1/learnings/{learning_id}","title":"Delete Learning","href":"/api-reference/learnings-delete"}]},{"group":"Security","pages":[{"openapi":"get /v1/security/scans/code","title":"Deep Scan code findings","href":"/api-reference/security-scans-code-list"}]},{"group":"Organizations","pages":[{"title":"List organizations","openapi":"get /v1/organizations","href":"/api-reference/organizations-list"},{"title":"List organization repositories","openapi":"get /v1/organizations/{organization_id}/repositories","href":"/api-reference/organization-repositories-list"},{"title":"List linked repositories","openapi":"get /v1/linked-repositories","href":"/api-reference/linked-repositories-list"}]},{"group":"User Management","pages":[{"openapi":"get /v1/users","title":"Users","href":"/api-reference/users-list"},{"openapi":"post /v1/users/seats","title":"Seats","href":"/api-reference/users-manage-seats"},{"openapi":"post /v1/users/seats/assignment","title":"Seat Assignment Mode","href":"/api-reference/users-seat-assignment-mode"}]},{"group":"Roles","pages":[{"openapi":"post /v1/users/roles","title":"Assign roles","href":"/api-reference/users-change-roles"}]},{"group":"Audit Logs","pages":[{"openapi":"get /v1/audit-logs","title":"Audit Logs","href":"/api-reference/audit-logs"}]},{"group":"Legacy APIs","pages":[{"openapi":"post /api/v1/report.generate","title":"","href":"/api-reference/report-generate"}]}]}]},{"title":"Caching","href":"/reference/caching"},{"title":"Early Access Program","href":"/early-access"}]}]},"basePath":"","title":"Read the existing CodeRabbit review status for a pull request - CodeRabbit","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-DV-WToSZ.js","dist-CBUH0-zX.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-CR-RHrVC.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","AssistantPageLink-BmARFYNC.js"]}