🐰 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 →
Use the repository’s Git provider ID and the PR’s local number. Review and merge fields are observations; they do not establish canonical CodeRabbit review completion. See how to interpret the response and continue threads.
{"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-pull-requests-get","slug":"/api-reference/platform-pull-requests-get","pageMetadata":{"openapi":"get /v1/repositories/{repository_id}/pull-requests/{pull_request_number}","title":"Read a pull request","description":"Inspect current PR metadata, review observations, checks, and review threads.","href":"/api-reference/platform-pull-requests-get"},"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: \"Inspect current PR metadata, review observations, checks, and review threads.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const GitHubBadge=({tip=`This feature is available on GitHub and GitHub Enterprise.`,title=`GitHub`,cta,href,disabled=false})=>{const{Badge,Tooltip}=_provideComponents()||{};if(!Badge)_missingMdxReference(`Badge`,true);if(!Tooltip)_missingMdxReference(`Tooltip`,true);return _jsx(Tooltip,{tip,cta,href,children:_jsx(Badge,{icon:`github`,disabled:disabled||undefined,children:title})})};function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{_MdxComponentBoundary}=_components;if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_MdxComponentBoundary,{name:`GitHubBadge`,children:_jsx(GitHubBadge,{title:`GitHub Cloud`,tip:`Available for GitHub Cloud.`})}),`\n`,_jsxs(_components.p,{children:[`Use the repository’s Git provider ID and the PR’s local number. Review and merge fields are observations; they do not establish canonical CodeRabbit review completion. See `,_jsx(_components.a,{href:`/api/platform-pull-requests`,children:`how to interpret the response and continue threads`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{GitHubBadge,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /v1/repositories/{repository_id}/pull-requests/{pull_request_number}","title":"Read a pull request","description":"Inspect current PR metadata, review observations, checks, and review threads.","href":"/api-reference/platform-pull-requests-get"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[147,526,")=>null;function _cr"]]},"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_repository_pull_request","summary":"Read an accessible pull request and its current checks","description":"Inspect current PR metadata, review observations, checks, and review threads.","tags":["Pull requests"],"parameters":["1830067a-0be9-4925-b251-c4157ef787ac","61df71d3-8826-4dbc-81c9-51baed780e73","956fb344-5be6-4690-a6f2-3d72561af5ab","e24c8666-cfde-40b6-b3cb-6939b778e3d3","225e1685-1e3d-4d4f-b573-33ac87c587e2","8ada436d-64eb-474f-a146-196dec34d02a","b6375460-8fe0-46f4-9400-138492619b53","d08a1fc6-f6be-491a-83d8-240d216323e9","4082aaf8-0872-48a6-b7a7-4edc1852b113","ee4142d5-2d0a-4dc7-b12b-6b94086aad80","121d01f8-2129-4f18-a448-848ae6aec5be"],"responses":{"200":"48829961-7c38-4cfa-b109-b520ae493020","400":"8f8b9c98-6ea4-47d1-ae20-e3598a700ea4","401":"c2fe1793-86b6-4df9-9cf4-2bbf859d1302","403":"2997a8c2-df11-4275-8500-b12371369619","404":"5d9be22d-231b-4176-b246-973e3d39217b","409":"b2dcfca9-8367-4588-922c-b11a02e4156b","412":"63ec652c-993e-43c1-bfb6-b6c6dcaa1aac","413":"d96d3954-0e51-49f2-8363-a67bc662a02f","429":"c396046b-84ec-446d-a370-ad32bf29bf1f","500":"c920ae79-3ce2-4ed7-8c63-7baaaedc00a9","503":"59facbc7-89dc-460e-b345-f37617e45e3b"},"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}","baseUrlOptions":["https://api.coderabbit.ai"],"title":"Read an accessible pull request and its current checks","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1830067a-0be9-4925-b251-c4157ef787ac":{"name":"repository_id","in":"path","required":true,"schema":{"type":"string","pattern":"^[1-9]\\d*$","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"61df71d3-8826-4dbc-81c9-51baed780e73":{"name":"pull_request_number","in":"path","required":true,"schema":{"type":"integer","minimum":0,"maximum":2147483647,"exclusiveMinimum":true,"description":"Repository-local PR number, within the provider's GraphQL Int range.","isRequired":true,"uniqueKey":"","typeLabel":"integer"}},"956fb344-5be6-4690-a6f2-3d72561af5ab":{"name":"org_id","in":"query","schema":{"type":"string","minLength":1,"description":"Git-provider organization ID. Required for workspace keys; omit for organization keys.","uniqueKey":"","typeLabel":"string"},"allowEmptyValue":true,"allowReserved":true},"e24c8666-cfde-40b6-b3cb-6939b778e3d3":{"name":"expected_head_sha","in":"query","schema":{"type":"string","pattern":"^[a-f0-9]{40}$","uniqueKey":"","typeLabel":"string"},"allowEmptyValue":true,"allowReserved":true},"225e1685-1e3d-4d4f-b573-33ac87c587e2":{"name":"include","in":"query","schema":{"oneOf":[{"type":"string","description":"Optional sections; defaults to checks. Use none for core metadata only, or repeat the query parameter to include both checks and threads.","enum":["checks","threads","none"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"array","items":{"enum":["checks","threads","none"],"type":"string","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Optional sections; defaults to checks. Use none for core metadata only, or repeat the query parameter to include both checks and threads.","maxItems":2,"minItems":1,"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>[]"}],"uniqueKey":"","typeLabel":"enum\u003cstring> | enum\u003cstring>[]"},"style":"form","explode":true,"allowEmptyValue":true,"allowReserved":true},"8ada436d-64eb-474f-a146-196dec34d02a":{"name":"thread_author","in":"query","schema":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9-]{0,38}(?:\\[bot\\])?$","uniqueKey":"","typeLabel":"string"},"allowEmptyValue":true,"allowReserved":true},"b6375460-8fe0-46f4-9400-138492619b53":{"name":"thread_state","in":"query","schema":{"enum":["unresolved","resolved","all"],"type":"string","uniqueKey":"","typeLabel":"enum\u003cstring>"},"allowEmptyValue":true,"allowReserved":true},"d08a1fc6-f6be-491a-83d8-240d216323e9":{"name":"thread_page_size","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"uniqueKey":"","typeLabel":"integer"},"allowEmptyValue":true,"allowReserved":true},"4082aaf8-0872-48a6-b7a7-4edc1852b113":{"name":"thread_page_token","in":"query","schema":{"type":"string","minLength":1,"maxLength":4096,"uniqueKey":"","typeLabel":"string"},"allowEmptyValue":true,"allowReserved":true},"ee4142d5-2d0a-4dc7-b12b-6b94086aad80":{"name":"thread_include_outdated","in":"query","schema":{"type":"boolean","uniqueKey":"","typeLabel":"boolean"},"allowEmptyValue":true,"allowReserved":true},"121d01f8-2129-4f18-a448-848ae6aec5be":{"name":"thread_include_replies","in":"query","schema":{"type":"boolean","uniqueKey":"","typeLabel":"boolean"},"allowEmptyValue":true,"allowReserved":true}},"responses":{"48829961-7c38-4cfa-b109-b520ae493020":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pull_request":{"type":"object","properties":{"id":{"type":"string","description":"Opaque Git-provider pull-request ID; distinct from its repository-local number.","isRequired":true,"uniqueKey":"pull_request.id","typeLabel":"string"},"number":{"type":"integer","minimum":0,"maximum":9007199254740991,"exclusiveMinimum":true,"description":"Pull-request number within the repository.","isRequired":true,"uniqueKey":"pull_request.number","typeLabel":"integer"},"url":{"type":"string","maxLength":2048,"format":"uri","isRequired":true,"uniqueKey":"pull_request.url","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"pull_request.title","typeLabel":"string"},"repository":{"type":"string","description":"Current GitHub owner/repository name.","isRequired":true,"uniqueKey":"pull_request.repository","typeLabel":"string"},"author":{"oneOf":[{"type":"object","required":["login"],"properties":{"login":{"type":"string","isRequired":true,"uniqueKey":"pull_request.author.oneOf.0.login","typeLabel":"string"}},"isRequired":true,"uniqueKey":"pull_request.author.oneOf.0","typeLabel":"object"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"pull_request.author.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"pull_request.author.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"pull_request.author","typeLabel":"object | enum\u003cstring> | null"},"state":{"enum":["open","closed","merged"],"type":"string","isRequired":true,"uniqueKey":"pull_request.state","typeLabel":"enum\u003cstring>"},"draft":{"type":"boolean","isRequired":true,"uniqueKey":"pull_request.draft","typeLabel":"boolean"},"head_branch":{"type":"string","isRequired":true,"uniqueKey":"pull_request.head_branch","typeLabel":"string"},"head_owner":{"oneOf":[{"type":"string","description":"Source repository owner, or null when unavailable.","isRequired":true,"uniqueKey":"pull_request.head_owner.oneOf.0","typeLabel":"string"},{"type":"string","description":"Source repository owner, or null when unavailable.","enum":[null],"isRequired":true,"uniqueKey":"pull_request.head_owner.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Source repository owner, or null when unavailable.","enum":[null],"isRequired":true,"uniqueKey":"pull_request.head_owner.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"pull_request.head_owner","typeLabel":"string | enum\u003cstring> | null"},"base_branch":{"type":"string","isRequired":true,"uniqueKey":"pull_request.base_branch","typeLabel":"string"},"head_sha":{"type":"string","pattern":"^[a-f0-9]{40}$","description":"Head commit observed for this read.","isRequired":true,"uniqueKey":"pull_request.head_sha","typeLabel":"string"},"base_sha":{"type":"string","pattern":"^[a-f0-9]{40}$","description":"Base commit observed for this read.","isRequired":true,"uniqueKey":"pull_request.base_sha","typeLabel":"string"},"updated_at":{"type":"string","description":"Last update timestamp reported by the Git provider.","isRequired":true,"uniqueKey":"pull_request.updated_at","typeLabel":"string"},"description":{"type":"string","isRequired":true,"uniqueKey":"pull_request.description","typeLabel":"string"}},"required":["id","number","url","title","repository","author","state","draft","head_branch","head_owner","base_branch","head_sha","base_sha","updated_at","description"],"isRequired":true,"uniqueKey":"pull_request","typeLabel":"object"},"reviews":{"type":"object","properties":{"decision":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"reviews.decision.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"reviews.decision.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"reviews.decision.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reviews.decision","typeLabel":"string | enum\u003cstring> | null"},"items":{"type":"array","items":{"type":"object","properties":{"author":{"oneOf":[{"type":"object","required":["login"],"properties":{"login":{"type":"string","isRequired":true,"uniqueKey":"reviews.\\items.items.[INDEX].author.oneOf.0.login","typeLabel":"string"}},"isRequired":true,"uniqueKey":"reviews.\\items.items.[INDEX].author.oneOf.0","typeLabel":"object"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"reviews.\\items.items.[INDEX].author.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"reviews.\\items.items.[INDEX].author.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reviews.\\items.items.[INDEX].author","typeLabel":"object | enum\u003cstring> | null"},"state":{"type":"string","isRequired":true,"uniqueKey":"reviews.\\items.items.[INDEX].state","typeLabel":"string"},"commit_sha":{"oneOf":[{"type":"string","pattern":"^[a-f0-9]{40}$","isRequired":true,"uniqueKey":"reviews.\\items.items.[INDEX].commit_sha.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"reviews.\\items.items.[INDEX].commit_sha.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"reviews.\\items.items.[INDEX].commit_sha.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reviews.\\items.items.[INDEX].commit_sha","typeLabel":"string | enum\u003cstring> | null"}},"required":["author","state","commit_sha"],"uniqueKey":"reviews.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"reviews.\\items","typeLabel":"object[]"},"complete":{"type":"boolean","isRequired":true,"uniqueKey":"reviews.complete","typeLabel":"boolean"},"coderabbit":{"type":"object","properties":{"status":{"enum":["in_progress_observed","unknown"],"type":"string","description":"A progress marker is observed historical evidence, not proof that a review is running on the current head. Unknown never means completed.","isRequired":true,"uniqueKey":"reviews.coderabbit.status","typeLabel":"enum\u003cstring>"},"reviewed_sha":{"oneOf":[{"type":"string","pattern":"^[a-f0-9]{40}$","isRequired":true,"uniqueKey":"reviews.coderabbit.reviewed_sha.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"reviews.coderabbit.reviewed_sha.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"reviews.coderabbit.reviewed_sha.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reviews.coderabbit.reviewed_sha","typeLabel":"string | enum\u003cstring> | null"},"source_url":{"oneOf":[{"type":"string","format":"uri","maxLength":2048,"isRequired":true,"uniqueKey":"reviews.coderabbit.source_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"reviews.coderabbit.source_url.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"reviews.coderabbit.source_url.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reviews.coderabbit.source_url","typeLabel":"string\u003curi> | enum\u003cstring> | null"}},"required":["status","reviewed_sha","source_url"],"isRequired":true,"uniqueKey":"reviews.coderabbit","typeLabel":"object"}},"required":["decision","items","complete","coderabbit"],"isRequired":true,"uniqueKey":"reviews","typeLabel":"object"},"merge":{"type":"object","properties":{"mergeable":{"enum":["mergeable","conflicting","unknown"],"type":"string","isRequired":true,"uniqueKey":"merge.mergeable","typeLabel":"enum\u003cstring>"},"provider_state":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"merge.provider_state.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"merge.provider_state.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"merge.provider_state.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"merge.provider_state","typeLabel":"string | enum\u003cstring> | null"},"queue_entry":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"merge.queue_entry.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"merge.queue_entry.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"merge.queue_entry.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"merge.queue_entry","typeLabel":"string | enum\u003cstring> | null"},"queue_known":{"type":"boolean","isRequired":true,"uniqueKey":"merge.queue_known","typeLabel":"boolean"},"requirements_known":{"type":"boolean","description":"False unless all merge requirements and the current actor's bypass rules are established.","isRequired":true,"uniqueKey":"merge.requirements_known","typeLabel":"boolean"}},"required":["mergeable","provider_state","queue_entry","queue_known","requirements_known"],"isRequired":true,"uniqueKey":"merge","typeLabel":"object"},"blockers":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","isRequired":true,"uniqueKey":"blockers.items.[INDEX].kind","typeLabel":"string"},"source":{"type":"string","isRequired":true,"uniqueKey":"blockers.items.[INDEX].source","typeLabel":"string"}},"required":["kind","source"],"uniqueKey":"blockers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"blockers","typeLabel":"object[]"},"coverage":{"type":"object","properties":{"complete":{"type":"boolean","isRequired":true,"uniqueKey":"coverage.complete","typeLabel":"boolean"},"limitations":{"type":"array","items":{"type":"string","uniqueKey":"coverage.limitations.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"coverage.limitations","typeLabel":"string[]"}},"required":["complete","limitations"],"isRequired":true,"uniqueKey":"coverage","typeLabel":"object"},"head_sha":{"type":"string","pattern":"^[a-f0-9]{40}$","isRequired":true,"uniqueKey":"head_sha","typeLabel":"string"},"fetched_at":{"type":"string","isRequired":true,"uniqueKey":"fetched_at","typeLabel":"string"},"head_changed":{"type":"boolean","description":"Whether the observed head differs from expected_head_sha; not a review-completion signal.","isRequired":true,"uniqueKey":"head_changed","typeLabel":"boolean"},"expected_head_sha":{"type":"string","pattern":"^[a-f0-9]{40}$","uniqueKey":"expected_head_sha","typeLabel":"string"},"checks":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].status","typeLabel":"string"},"conclusion":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].conclusion.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].conclusion.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].conclusion.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].conclusion","typeLabel":"string | enum\u003cstring> | null"},"details_url":{"oneOf":[{"type":"string","format":"uri","maxLength":2048,"isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].details_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].details_url.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].details_url.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].details_url","typeLabel":"string\u003curi> | enum\u003cstring> | null"},"commit_sha":{"type":"string","pattern":"^[a-f0-9]{40}$","isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].commit_sha","typeLabel":"string"},"required":{"oneOf":[{"type":"boolean","description":"Null when branch rules and actor bypass have not been evaluated.","isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].required.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"Null when branch rules and actor bypass have not been evaluated.","enum":[null],"isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].required.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Null when branch rules and actor bypass have not been evaluated.","enum":[null],"isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].required.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"checks.\\items.items.[INDEX].required","typeLabel":"boolean | enum\u003cstring> | null"}},"required":["id","name","status","conclusion","details_url","commit_sha","required"],"uniqueKey":"checks.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"checks.\\items","typeLabel":"object[]"},"complete":{"type":"boolean","isRequired":true,"uniqueKey":"checks.complete","typeLabel":"boolean"},"requiredness_known":{"type":"boolean","description":"Whether the required status of checks is established independently of their result.","isRequired":true,"uniqueKey":"checks.requiredness_known","typeLabel":"boolean"}},"required":["items","complete","requiredness_known"],"uniqueKey":"checks","typeLabel":"object"},"threads":{"type":"object","properties":{"returned":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"threads.returned","typeLabel":"integer"},"coverage":{"type":"object","properties":{"complete":{"type":"boolean","isRequired":true,"uniqueKey":"threads.coverage.complete","typeLabel":"boolean"},"limitations":{"type":"array","items":{"type":"string","uniqueKey":"threads.coverage.limitations.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"threads.coverage.limitations","typeLabel":"string[]"}},"required":["complete","limitations"],"isRequired":true,"uniqueKey":"threads.coverage","typeLabel":"object"},"head_sha":{"type":"string","pattern":"^[a-f0-9]{40}$","isRequired":true,"uniqueKey":"threads.head_sha","typeLabel":"string"},"fetched_at":{"type":"string","isRequired":true,"uniqueKey":"threads.fetched_at","typeLabel":"string"},"head_changed":{"type":"boolean","description":"Whether the observed head differs from expected_head_sha; not a review-completion signal.","isRequired":true,"uniqueKey":"threads.head_changed","typeLabel":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].id","typeLabel":"string"},"path":{"type":"string","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].path","typeLabel":"string"},"line":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].line.oneOf.0","typeLabel":"integer"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].line.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].line.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].line","typeLabel":"integer | enum\u003cstring> | null"},"start_line":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].start_line.oneOf.0","typeLabel":"integer"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].start_line.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].start_line.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].start_line","typeLabel":"integer | enum\u003cstring> | null"},"original_line":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].original_line.oneOf.0","typeLabel":"integer"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].original_line.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].original_line.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].original_line","typeLabel":"integer | enum\u003cstring> | null"},"original_start_line":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].original_start_line.oneOf.0","typeLabel":"integer"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].original_start_line.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].original_start_line.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].original_start_line","typeLabel":"integer | enum\u003cstring> | null"},"side":{"type":"string","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].side","typeLabel":"string"},"resolved":{"type":"boolean","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].resolved","typeLabel":"boolean"},"outdated":{"type":"boolean","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].outdated","typeLabel":"boolean"},"root":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.id","typeLabel":"string"},"author":{"oneOf":[{"type":"object","required":["login"],"properties":{"login":{"type":"string","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.author.oneOf.0.login","typeLabel":"string"}},"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.author.oneOf.0","typeLabel":"object"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.author.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.author.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.author","typeLabel":"object | enum\u003cstring> | null"},"body":{"type":"string","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.body","typeLabel":"string"},"url":{"type":"string","maxLength":2048,"format":"uri","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.url","typeLabel":"string\u003curi>"},"created_at":{"type":"string","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.created_at","typeLabel":"string"},"commit_sha":{"oneOf":[{"type":"string","pattern":"^[a-f0-9]{40}$","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.commit_sha.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.commit_sha.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.commit_sha.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.commit_sha","typeLabel":"string | enum\u003cstring> | null"},"original_commit_sha":{"oneOf":[{"type":"string","pattern":"^[a-f0-9]{40}$","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.original_commit_sha.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.original_commit_sha.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.original_commit_sha.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root.original_commit_sha","typeLabel":"string | enum\u003cstring> | null"}},"required":["id","author","body","url","created_at","commit_sha","original_commit_sha"],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].root","typeLabel":"object"},"replies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].id","typeLabel":"string"},"author":{"oneOf":[{"type":"object","required":["login"],"properties":{"login":{"type":"string","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].author.oneOf.0.login","typeLabel":"string"}},"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].author.oneOf.0","typeLabel":"object"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].author.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].author.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].author","typeLabel":"object | enum\u003cstring> | null"},"body":{"type":"string","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].body","typeLabel":"string"},"url":{"type":"string","maxLength":2048,"format":"uri","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].url","typeLabel":"string\u003curi>"},"created_at":{"type":"string","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].created_at","typeLabel":"string"},"commit_sha":{"oneOf":[{"type":"string","pattern":"^[a-f0-9]{40}$","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].commit_sha.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].commit_sha.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].commit_sha.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].commit_sha","typeLabel":"string | enum\u003cstring> | null"},"original_commit_sha":{"oneOf":[{"type":"string","pattern":"^[a-f0-9]{40}$","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].original_commit_sha.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].original_commit_sha.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].original_commit_sha.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX].original_commit_sha","typeLabel":"string | enum\u003cstring> | null"}},"required":["id","author","body","url","created_at","commit_sha","original_commit_sha"],"uniqueKey":"threads.data.items.[INDEX].replies.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies","typeLabel":"object[]"},"replies_complete":{"type":"boolean","isRequired":true,"uniqueKey":"threads.data.items.[INDEX].replies_complete","typeLabel":"boolean"},"reply_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"threads.data.items.[INDEX].reply_count","typeLabel":"integer"}},"required":["id","path","line","start_line","original_line","original_start_line","side","resolved","outdated","root","replies","replies_complete","reply_count"],"uniqueKey":"threads.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"threads.data","typeLabel":"object[]"},"next_page_token":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"threads.next_page_token.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"threads.next_page_token.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"threads.next_page_token.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"threads.next_page_token","typeLabel":"string | enum\u003cstring> | null"},"applied_filters":{"type":"object","properties":{"page_size":{"type":"integer","minimum":1,"maximum":100,"isRequired":true,"uniqueKey":"threads.applied_filters.page_size","typeLabel":"integer"},"author":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9-]{0,38}(?:\\[bot\\])?$","default":"coderabbit","description":"Filter the thread root author: coderabbit, all, or a GitHub login. Replies retain all authors.","uniqueKey":"threads.applied_filters.author","typeLabel":"string"},"state":{"enum":["unresolved","resolved","all"],"type":"string","default":"unresolved","uniqueKey":"threads.applied_filters.state","typeLabel":"enum\u003cstring>"},"include_outdated":{"type":"boolean","default":false,"uniqueKey":"threads.applied_filters.include_outdated","typeLabel":"boolean"},"include_replies":{"type":"boolean","default":true,"description":"Include bounded reply context. Check replies_complete and reply_count; use the source link when truncated.","uniqueKey":"threads.applied_filters.include_replies","typeLabel":"boolean"}},"required":["page_size"],"additionalProperties":false,"isRequired":true,"uniqueKey":"threads.applied_filters","typeLabel":"object"}},"required":["returned","coverage","head_sha","fetched_at","head_changed","data","next_page_token","applied_filters"],"uniqueKey":"threads","typeLabel":"object"}},"required":["pull_request","reviews","merge","blockers","coverage","head_sha","fetched_at","head_changed"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"pull_request":{"id":"\u003cstring>","number":4503599627370495,"url":"\u003cstring>","title":"\u003cstring>","repository":"\u003cstring>","author":{"login":"\u003cstring>"},"state":"open","draft":true,"head_branch":"\u003cstring>","head_owner":"\u003cstring>","base_branch":"\u003cstring>","head_sha":"\u003cstring>","base_sha":"\u003cstring>","updated_at":"\u003cstring>","description":"\u003cstring>"},"reviews":{"decision":"\u003cstring>","items":[{"author":{"login":"\u003cstring>"},"state":"\u003cstring>","commit_sha":"\u003cstring>"}],"complete":true,"coderabbit":{"status":"in_progress_observed","reviewed_sha":"\u003cstring>","source_url":"\u003cstring>"}},"merge":{"mergeable":"mergeable","provider_state":"\u003cstring>","queue_entry":"\u003cstring>","queue_known":true,"requirements_known":true},"blockers":[{"kind":"\u003cstring>","source":"\u003cstring>"}],"coverage":{"complete":true,"limitations":["\u003cstring>"]},"head_sha":"\u003cstring>","fetched_at":"\u003cstring>","head_changed":true,"expected_head_sha":"\u003cstring>","checks":{"items":[{"id":"\u003cstring>","name":"\u003cstring>","status":"\u003cstring>","conclusion":"\u003cstring>","details_url":"\u003cstring>","commit_sha":"\u003cstring>","required":true}],"complete":true,"requiredness_known":true},"threads":{"returned":4503599627370495,"coverage":{"complete":true,"limitations":["\u003cstring>"]},"head_sha":"\u003cstring>","fetched_at":"\u003cstring>","head_changed":true,"data":[{"id":"\u003cstring>","path":"\u003cstring>","line":0,"start_line":0,"original_line":0,"original_start_line":0,"side":"\u003cstring>","resolved":true,"outdated":true,"root":{"id":"\u003cstring>","author":{"login":"\u003cstring>"},"body":"\u003cstring>","url":"\u003cstring>","created_at":"\u003cstring>","commit_sha":"\u003cstring>","original_commit_sha":"\u003cstring>"},"replies":[{"id":"\u003cstring>","author":{"login":"\u003cstring>"},"body":"\u003cstring>","url":"\u003cstring>","created_at":"\u003cstring>","commit_sha":"\u003cstring>","original_commit_sha":"\u003cstring>"}],"replies_complete":true,"reply_count":4503599627370495}],"next_page_token":"\u003cstring>","applied_filters":{"page_size":50,"author":"coderabbit","state":"unresolved","include_outdated":false,"include_replies":true}}}}},"exampleType":"generated"}},"exampleType":"generated"},"8f8b9c98-6ea4-47d1-ae20-e3598a700ea4":{"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"},"c2fe1793-86b6-4df9-9cf4-2bbf859d1302":{"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"},"2997a8c2-df11-4275-8500-b12371369619":{"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"},"5d9be22d-231b-4176-b246-973e3d39217b":{"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"},"b2dcfca9-8367-4588-922c-b11a02e4156b":{"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"},"63ec652c-993e-43c1-bfb6-b6c6dcaa1aac":{"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"},"d96d3954-0e51-49f2-8363-a67bc662a02f":{"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"},"c396046b-84ec-446d-a370-ad32bf29bf1f":{"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"},"c920ae79-3ce2-4ed7-8c63-7baaaedc00a9":{"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"},"59facbc7-89dc-460e-b345-f37617e45e3b":{"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 a pull request - CodeRabbit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T06:30:37.664Z","originalFileLocation":"api-reference/platform-pull-requests-get.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=\"Inspect current PR metadata, review observations, checks, and review threads.\">\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 a pull request - CodeRabbit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Inspect current PR metadata, review observations, checks, and review threads.\">\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-pull-requests-get\">\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=Documentation\u0026amp;title=Read+a+pull+request\u0026amp;description=Inspect+current+PR+metadata%2C+review+observations%2C+checks%2C+and+review+threads.\u0026amp;theme=e25dc9e67170d7dae31e0b2f\u0026amp;signature=335bfd3461f051b9deda74535774dbdab48c3a4c4eafa2759896011c474af2c4\">\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 a pull request - CodeRabbit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Inspect current PR metadata, review observations, checks, and review threads.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://coderabbit.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Read+a+pull+request\u0026amp;description=Inspect+current+PR+metadata%2C+review+observations%2C+checks%2C+and+review+threads.\u0026amp;theme=e25dc9e67170d7dae31e0b2f\u0026amp;signature=335bfd3461f051b9deda74535774dbdab48c3a4c4eafa2759896011c474af2c4\">\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-pull-requests-get\">\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-pull-requests-get.md\">\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","groups":[{"group":"Platform","icon":"layers","pages":[{"title":"Agentic Change Management","sidebarTitle":"Overview","mode":"wide","href":""},{"title":"The System Behind Every Review Comment","sidebarTitle":"Architecture","mode":"wide","href":"/overview/architecture"},{"group":"Platform Tour","expanded":false,"pages":[{"title":"Pull Request Reviews","mode":"wide","href":"/overview/pull-request-review"},{"title":"Code reviews in IDE and CLI","sidebarTitle":"IDE and CLI reviews","mode":"wide","href":"/overview/ide-cli-review"},{"title":"CodeRabbit Plan","sidebarTitle":"CodeRabbit Plan","mode":"wide","href":"/overview/coderabbit-plan"},{"title":"CodeRabbit Agent for Slack","sidebarTitle":"Agent for Slack","mode":"wide","href":"/overview/slack-agent"}]}]},{"group":"Getting Started","icon":"rocket","pages":[{"title":"Quickstart","sidebarTitle":"Quickstart","href":"/getting-started/quickstart"},{"group":"Hands-on Guide","root":{"title":"Hands-on guide","href":"/guide/index"},"expanded":false,"pages":[{"title":"Repository setup","sidebarTitle":"Add repository","href":"/guide/repository"},{"title":"Code Review","sidebarTitle":"Code Review","href":"/guide/code-review"},{"title":"Interactive code review chat","sidebarTitle":"Chat","href":"/guide/chat"},{"title":"Improvements","sidebarTitle":"Improvements","href":"/guide/improvements"},{"title":"You're Ready to Ship Better Code!","sidebarTitle":"Success","href":"/guide/complete"}]}]},{"group":"Triage","icon":"list-filter","pages":[{"title":"Triage","sidebarTitle":"Triage overview","href":"/triage/index"},{"title":"Your Triage view","sidebarTitle":"Your Triage view","href":"/triage/your-triage-view"},{"title":"How Triage prioritizes","sidebarTitle":"Prioritization","href":"/triage/prioritization"},{"title":"Actions on a pull request","sidebarTitle":"Actions","href":"/triage/actions"},{"title":"Triage settings","sidebarTitle":"Rules and automation","href":"/triage/rules"},{"title":"Triage in Slack","sidebarTitle":"Triage in Slack","href":"/triage/slack"},{"title":"Requirements and FAQ","sidebarTitle":"Requirements and FAQ","href":"/triage/faq"},{"title":"Troubleshooting Triage","sidebarTitle":"Troubleshooting","href":"/triage/troubleshooting"}]},{"group":"Pull Request Reviews","icon":"git-pull-request","pages":[{"title":"Overview","href":"/guides/code-review-overview"},{"title":"PR Summaries","href":"/pr-reviews/summaries"},{"title":"PR Walkthroughs","href":"/pr-reviews/walkthroughs"},{"title":"Merge Risk","sidebarTitle":"Merge Risk","href":"/pr-reviews/merge-risk"},{"title":"CI/CD Pipeline Analysis","href":"/pr-reviews/cicd-pipeline-analysis"},{"title":"PR validation using linked issues","sidebarTitle":"Linked Issues","href":"/issues/pr-validation"},{"title":"Slop Detection","sidebarTitle":"Slop Detection","href":"/pr-reviews/slop-detection"},{"title":"Path-based review instructions","href":"/configuration/path-instructions"},{"title":"AST-based path instructions","href":"/configuration/ast-grep-instructions"},{"title":"Automatic review controls","sidebarTitle":"Automatic review controls","href":"/configuration/auto-review"},{"title":"CodeRabbit status check","sidebarTitle":"Status check","href":"/pr-reviews/status-check"},{"title":"Manage code reviews","href":"/guides/commands"},{"title":"Review commands","sidebarTitle":"Review commands","href":"/reference/review-commands"}]},{"group":"Change Stack","icon":"layers","pages":[{"title":"Change Stack","sidebarTitle":"Change Stack overview","href":"/change-stack/index"},{"title":"Navigate a change","sidebarTitle":"Navigation","href":"/change-stack/navigation"},{"title":"Read changes","href":"/change-stack/reading-diffs"},{"title":"Understand findings","sidebarTitle":"Findings","href":"/change-stack/findings"},{"title":"Review and merge","sidebarTitle":"Review and merge","href":"/change-stack/reviewing"},{"title":"Ask about the change","sidebarTitle":"Chat","href":"/change-stack/chat"},{"title":"Collaborate in Slack and Discord","sidebarTitle":"Slack and Discord collaboration","href":"/change-stack/notifications"},{"title":"Snapshots and freshness","sidebarTitle":"Snapshots","href":"/change-stack/snapshots"},{"title":"Provider support","href":"/change-stack/provider-support"}]},{"group":"Available actions","icon":"message-square-diff","pages":[{"title":"Create issues","sidebarTitle":"Issue creation","href":"/issues/creation"}]},{"group":"Pre-Merge Checks","icon":"shield","pages":[{"title":"Built-in Pre-Merge Checks","sidebarTitle":"Built-in Checks","href":"/pr-reviews/pre-merge-checks"},{"title":"Custom checks","href":"/pr-reviews/custom-checks"}]},{"group":"Approvals","icon":"badge-check","pages":[{"title":"Automatic Approvals","sidebarTitle":"Automatic Approvals","href":"/pr-reviews/automatic-approvals"},{"title":"Approval risk limits","sidebarTitle":"Risk limits","href":"/pr-reviews/approval-risk-limits"},{"title":"Choose an approval policy","sidebarTitle":"Approval policies","href":"/pr-reviews/approval-policies"}]},{"group":"Post-Merge Actions","icon":"rocket","pages":[{"title":"Post-Merge Actions","sidebarTitle":"Post-Merge Actions","href":"/pr-reviews/post-merge-actions"}]},{"group":"Finishing touches","icon":"paintbrush","pages":[{"title":"Finishing Touches overview","sidebarTitle":"Overview","href":"/finishing-touches/index"},{"title":"Fix comments: apply CodeRabbit code fixes to pull requests","sidebarTitle":"Fix comments","href":"/finishing-touches/autofix"},{"title":"Fix CI failures","href":"/finishing-touches/fix-ci"},{"title":"Resolve Merge Conflicts","href":"/finishing-touches/resolve-merge-conflict"},{"title":"Generate unit tests","href":"/finishing-touches/unit-test-generation"},{"title":"Custom Finishing Touch recipes","sidebarTitle":"Custom recipes","href":"/finishing-touches/custom-finishing-touches"},{"title":"Simplify code","href":"/finishing-touches/simplify"},{"title":"Generate docstrings","href":"/finishing-touches/docstrings"}]},{"group":"Knowledge Base","icon":"brain","pages":[{"title":"Knowledge Base overview","sidebarTitle":"Overview","href":"/knowledge-base/index"},{"title":"Learnings","href":"/knowledge-base/learnings"},{"title":"Code Guidelines","href":"/knowledge-base/code-guidelines"},{"title":"Multi-Repo Analysis","href":"/knowledge-base/multi-repo-analysis"},{"title":"Knowledge repositories","href":"/knowledge-base/connected-repositories"},{"title":"MCP Servers","href":"/knowledge-base/mcp-context"},{"title":"Web Search","href":"/knowledge-base/web-search"}]},{"group":"CodeRabbit Security","icon":"shield-check","pages":[{"title":"CodeRabbit Security","sidebarTitle":"Security overview","href":"/security/index"},{"title":"CodeRabbit Security check","sidebarTitle":"Pull request check","href":"/security/pull-request-check"},{"title":"Attack surface and continuous posture","sidebarTitle":"Attack surface","href":"/security/attack-surface"},{"title":"Delta scans","href":"/security/delta-scans"},{"title":"Security Blast Radius","sidebarTitle":"Blast Radius","href":"/security/blast-radius"},{"title":"Steer Deep Scans","href":"/security/steer-scans"},{"title":"Runtime verification","href":"/security/runtime-verification"},{"title":"Security Architecture Review","sidebarTitle":"Architecture Review","href":"/security/architecture-review"}]},{"group":"Configuration","icon":"settings","pages":[{"title":"Configuration overview","sidebarTitle":"Configuration overview","href":"/guides/configuration-overview"},{"title":"Configuration inheritance","href":"/configuration/configuration-inheritance"},{"group":"Configuration file","expanded":false,"pages":[{"title":"Configuration via YAML file","href":"/getting-started/yaml-configuration"},{"title":"Configuration via TypeScript file","sidebarTitle":"TypeScript configuration","href":"/configuration/typescript-configuration"},{"title":"Central configuration","href":"/configuration/central-configuration"},{"title":"YAML validator","href":"/configuration/yaml-validator"}]},{"group":"Configuration UI","expanded":false,"pages":[{"title":"Repository settings","href":"/guides/repository-settings"},{"title":"Organization settings","href":"/guides/organization-settings"}]},{"group":"Configuration Examples","root":{"title":"Configuration examples","href":"/configuration/example/index"},"expanded":false,"pages":[{"title":"Sample configuration for React Native + Expo","sidebarTitle":"React Native + Expo","mode":"wide","href":"/configuration/example/typescript/expo"},{"title":"Sample configuration for Django","sidebarTitle":"Python + Django","mode":"wide","href":"/configuration/example/python/django"},{"title":"Sample configuration for Mintlify-based documentation website","sidebarTitle":"Mintlify Documentation","mode":"wide","href":"/configuration/example/other/mintlify-documentation"}]}]},{"group":"Tools","icon":"wrench","expanded":false,"pages":[{"title":"Third-party tools overview","sidebarTitle":"Third-party tools","href":"/tools/index"},{"title":"Tool catalog","href":"/tools/list"},{"group":"Per-tool guides","expanded":false,"pages":[{"group":"Multipurpose","pages":[{"title":"ast-grep","href":"/tools/ast-grep"},{"title":"Semgrep","href":"/tools/semgrep"},{"title":"OpenGrep","href":"/tools/opengrep"}]},{"group":"Security","pages":[{"title":"Betterleaks","href":"/tools/betterleaks"},{"title":"SkillSpector","href":"/tools/skillspector"},{"title":"TruffleHog","href":"/tools/trufflehog"},{"title":"Microsoft Presidio Analyzer","sidebarTitle":"Presidio","href":"/tools/presidio"},{"title":"OSV-Scanner","href":"/tools/osv-scanner"},{"title":"Brakeman","href":"/tools/brakeman"}]},{"group":"Languages","pages":[{"title":"ESLint","href":"/tools/eslint"},{"title":"Biome","href":"/tools/biome"},{"title":"Oxlint","href":"/tools/oxlint"},{"title":"React Doctor","href":"/tools/react-doctor"},{"title":"Ruff","href":"/tools/ruff"},{"title":"Pylint","href":"/tools/pylint"},{"title":"Flake8","href":"/tools/flake8"},{"title":"golangci-lint","href":"/tools/golangci-lint"},{"title":"Clippy","href":"/tools/clippy"},{"title":"RuboCop","href":"/tools/rubocop"},{"title":"SwiftLint","href":"/tools/swiftlint"},{"title":"PHPStan","href":"/tools/phpstan"},{"title":"PHPMD","href":"/tools/phpmd"},{"title":"PHPCS","href":"/tools/phpcs"},{"title":"PMD","href":"/tools/pmd"},{"title":"detekt","href":"/tools/detekt"},{"title":"Clang-Tidy","href":"/tools/clang-tidy"},{"title":"Cppcheck","href":"/tools/cppcheck"},{"title":"Verilator","href":"/tools/verilator"},{"title":"Infer","href":"/tools/fbinfer"},{"title":"Luacheck","href":"/tools/luacheck"},{"title":"ShellCheck","href":"/tools/shellcheck"},{"title":"Blinter","href":"/tools/blinter"},{"title":"Fortitude","href":"/tools/fortitude"},{"title":"Regal","href":"/tools/regal"},{"title":"PSScriptAnalyzer","href":"/tools/psscriptanalyzer"},{"title":"smarty-lint","href":"/tools/smarty-lint"},{"title":"SQLFluff","href":"/tools/sqlfluff"},{"title":"Squawk","href":"/tools/squawk"},{"title":"Prisma Lint","href":"/tools/prisma-lint"},{"title":"Stylelint","href":"/tools/stylelint"},{"title":"HTMLHint","href":"/tools/htmlhint"},{"title":"ember-template-lint","href":"/tools/ember-template-lint"},{"title":"YAMLlint","href":"/tools/yamllint"},{"title":"Dotenv Linter","href":"/tools/dotenv"},{"title":"Buf","href":"/tools/buf"},{"title":"oasdiff","href":"/tools/oasdiff"},{"title":"Checkmake","href":"/tools/checkmake"},{"title":"Shopify Theme Check","href":"/tools/shopify-cli"}]},{"group":"Infrastructure as code","pages":[{"title":"Checkov","href":"/tools/checkov"},{"title":"Trivy","href":"/tools/trivy"},{"title":"TFLint","href":"/tools/tflint"},{"title":"Hadolint","href":"/tools/hadolint"}]},{"group":"CI/CD","pages":[{"title":"actionlint","href":"/tools/actionlint"},{"title":"zizmor","href":"/tools/zizmor"},{"title":"CircleCI","href":"/tools/circleci"},{"title":"GitHub Checks","href":"/tools/github-checks"}]},{"group":"Docs and prose","pages":[{"title":"markdownlint","href":"/tools/markdownlint"},{"title":"LanguageTool","href":"/tools/languagetool"},{"title":"Vale","href":"/tools/vale"}]}]},{"title":"Tools configuration reference","sidebarTitle":"Tools configuration","mode":"wide","href":"/tools/reference"}]},{"group":"CodeRabbit Plan","icon":"list-check","pages":[{"title":"CodeRabbit Plan overview","sidebarTitle":"Overview","href":"/plan/index"},{"title":"Create a plan","sidebarTitle":"Create a plan","href":"/plan/create-plan"},{"title":"Plan structure and refinement","sidebarTitle":"Plan refinement","href":"/plan/plan-refinement"},{"title":"Agent Handoff","sidebarTitle":"Agent Handoff","href":"/plan/agent-handoff"},{"group":"Issue Planner","root":{"title":"Issue Planner","href":"/issues/planner/index"},"expanded":false,"pages":[{"title":"Planning on GitHub","icon":"github","sidebarTitle":"GitHub guide","href":"/issues/planner/github"},{"title":"Planning on GitLab","sidebarTitle":"GitLab guide","icon":"gitlab","href":"/issues/planner/gitlab"},{"title":"Planning on Azure DevOps","sidebarTitle":"Azure DevOps guide","icon":"microsoft","href":"/issues/planner/azure-devops"},{"title":"Planning on Jira","sidebarTitle":"Jira guide","icon":"jira","href":"/issues/planner/jira"},{"title":"Planning on Linear","sidebarTitle":"Linear guide","icon":"linear","href":"/issues/planner/linear"}]}]},{"group":"Issue Management","icon":"clipboard-check","pages":[{"title":"Issue Enrichment","href":"/issues/enrichment"}]},{"group":"Resources","icon":"book-open","pages":[{"title":"Configuration reference","href":"/reference/configuration"},{"title":"CodeRabbit glossary: review, Git, and code analysis terms","sidebarTitle":"Glossary","href":"/reference/glossary"},{"title":"CodeRabbit FAQs: reviews, pricing, security, and setup","sidebarTitle":"CodeRabbit FAQ","href":"/faq"}]}]},{"tab":"CLI and IDE tools","icon":"square-terminal","pages":[{"group":"Command-Line Review Tool","icon":"square-terminal","pages":[{"title":"Command-Line Review Tool","sidebarTitle":"CLI Tool","href":"/cli"},{"group":"Integrations","pages":[{"title":"CodeRabbit Skills","sidebarTitle":"Skills","href":"/cli/skills"},{"title":"Claude Code integration","href":"/cli/claude-code-integration"},{"title":"Cursor integration","sidebarTitle":"Cursor integration","href":"/cli/cursor-integration"},{"title":"Codex integration","href":"/cli/codex-integration"},{"title":"Gemini integration","href":"/cli/gemini-integration"},{"title":"Antigravity integration","sidebarTitle":"Antigravity integration","href":"/cli/antigravity"}]},{"title":"Headless CLI integration","href":"/cli/headless-cli-integration"},{"title":"Agent mode output and exit codes","sidebarTitle":"Agent mode","href":"/cli/agent-mode"},{"title":"Install CLI on Windows","sidebarTitle":"Windows installation (Native)","href":"/cli/windows"},{"title":"Run Coding Agent tasks from the CLI","sidebarTitle":"Coding Agent tasks","href":"/cli/cloud-tasks"},{"title":"Deploy CodeRabbit CLI with Jamf Pro","sidebarTitle":"Jamf-managed macOS","href":"/cli/jamf-managed-macos"},{"title":"CLI network requirements","sidebarTitle":"Network requirements","href":"/cli/network-requirements"},{"title":"Use with self-hosted CodeRabbit","href":"/cli/cli-with-self-hosted-CodeRabbit"},{"title":"CLI Command Reference","sidebarTitle":"Command Reference","href":"/cli/reference"}]},{"group":"IDE Extension","icon":"code","pages":[{"title":"CodeRabbit IDE extension","sidebarTitle":"Overview","href":"/ide/index"},{"title":"Install the IDE extension","sidebarTitle":"Install","href":"/ide/install"},{"title":"Sign in and manage your account","sidebarTitle":"Sign in and account","href":"/ide/sign-in"},{"title":"Review local changes in your editor","sidebarTitle":"Run a review","href":"/ide/review"},{"title":"Work with review findings","sidebarTitle":"Work with findings","href":"/ide/findings"},{"title":"Fix findings with your AI agent","sidebarTitle":"Fix with AI","href":"/ide/fix-with-ai"},{"title":"IDE extension settings and commands","sidebarTitle":"Settings and commands","href":"/ide/settings"},{"title":"Update or uninstall the IDE extension","sidebarTitle":"Update and uninstall","href":"/ide/update-uninstall"},{"title":"Data, privacy, and network access","sidebarTitle":"Privacy and network","href":"/ide/privacy"},{"title":"Troubleshoot the IDE extension","sidebarTitle":"Troubleshooting","href":"/ide/troubleshooting"},{"title":"Use the IDE extension with self-hosted CodeRabbit","sidebarTitle":"Self-hosted CodeRabbit","href":"/ide/self-hosted"},{"title":"IDE extension release notes","sidebarTitle":"Release notes","href":"/ide/release-notes"}]},{"group":"JetBrains Plugin","icon":"puzzle","pages":[{"title":"CodeRabbit for JetBrains IDEs","sidebarTitle":"Overview","href":"/ide/jetbrains/index"},{"title":"Install and set up the JetBrains plugin","sidebarTitle":"Install and set up","href":"/ide/jetbrains/install"},{"title":"Review changes in a JetBrains IDE","sidebarTitle":"Run a review","href":"/ide/jetbrains/review"},{"title":"Work with findings in JetBrains IDEs","sidebarTitle":"Findings and Fix with AI","href":"/ide/jetbrains/findings"},{"title":"Data, privacy, and network access for the JetBrains plugin","sidebarTitle":"Privacy and network","href":"/ide/jetbrains/privacy"},{"title":"Troubleshoot the JetBrains plugin","sidebarTitle":"Troubleshooting","href":"/ide/jetbrains/troubleshooting"}]}]},{"tab":"Coding Agent","icon":"square-code","pages":[{"title":"Coding Agent","sidebarTitle":"Coding Agent overview","href":"/code"},{"title":"Start a coding task","sidebarTitle":"Start a task","href":"/code/start-a-task"},{"title":"Work with a running task","sidebarTitle":"Work with a task","href":"/code/work-with-a-task"},{"title":"Deliver a task's changes","sidebarTitle":"Deliver changes","href":"/code/deliver-changes"},{"title":"Coding environments","sidebarTitle":"Coding environments","href":"/code/environments"},{"title":"Coding Agent skills","sidebarTitle":"Skills","href":"/code/skills"},{"title":"Access and billing","sidebarTitle":"Access and billing","href":"/code/access-and-billing"}]},{"tab":"Agent for Slack and Discord","icon":"bot","groups":[{"group":"CodeRabbit Agent","icon":"bot","pages":[{"title":"CodeRabbit Agent overview","sidebarTitle":"Overview","href":"/agent"}]},{"group":"Agent for Slack","icon":"slack","pages":[{"title":"CodeRabbit Agent for Slack","sidebarTitle":"Overview","href":"/slack-agent/index"},{"title":"Quickstart","sidebarTitle":"Quickstart","href":"/slack-agent/onboarding"},{"title":"Working in Slack","sidebarTitle":"Working in Slack","href":"/slack-agent/use-in-slack"},{"title":"Connections and scopes","sidebarTitle":"Connections and scopes","href":"/slack-agent/connections-and-scopes"},{"group":"Use CodeRabbit Agent","expanded":false,"pages":[{"title":"Automations","sidebarTitle":"Automations","href":"/slack-agent/automations"},{"title":"Automation use cases","sidebarTitle":"Automation use cases","href":"/slack-agent/automation-use-cases"},{"title":"Coding Plans","sidebarTitle":"Coding Plans","href":"/slack-agent/plans"},{"title":"Knowledge Base","sidebarTitle":"Knowledge Base","href":"/slack-agent/knowledge-base"},{"title":"Agent skills","sidebarTitle":"Agent skills","href":"/agent/skills"}]},{"group":"Inspect and manage","expanded":false,"pages":[{"title":"Thread reviews","sidebarTitle":"Thread reviews","href":"/slack-agent/thread-reviews"},{"title":"Usage","sidebarTitle":"Usage","href":"/slack-agent/usage"},{"title":"Sandboxes","sidebarTitle":"Sandboxes","href":"/slack-agent/sandboxes"}]},{"group":"Admin","expanded":false,"pages":[{"title":"Admin roles and security","sidebarTitle":"Admin and security","href":"/slack-agent/admin-and-security"},{"title":"Slack permissions","sidebarTitle":"Slack permissions","href":"/slack-agent/slack-permissions"},{"title":"Self-managed GitLab setup","sidebarTitle":"GitLab self-managed","href":"/slack-agent/gitlab-self-hosted"}]}]},{"group":"Agent for Discord","icon":"discord","pages":[{"title":"CodeRabbit Agent for Discord","sidebarTitle":"Overview","href":"/discord-agent/index"},{"title":"Set up CodeRabbit Agent for Discord","sidebarTitle":"Setup","href":"/discord-agent/setup"},{"title":"Connections and scopes","sidebarTitle":"Connections and scopes","href":"/discord-agent/connections-and-scopes"},{"title":"Automations","sidebarTitle":"Automations","href":"/discord-agent/automations"},{"title":"Usage and limits","href":"/discord-agent/usage-and-limits"}]}]},{"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","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","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 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"]}