> ## Documentation Index > Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt > Use this file to discover all available pages before exploring further. # Read workspace review configuration ## OpenAPI ````yaml /openapi.json get /v1/configuration/workspace openapi: 3.0.3 info: title: CodeRabbit API spec version: 1.0.0 servers: - url: https://api.coderabbit.ai security: - ApiKeyAuth: [] paths: /v1/configuration/workspace: get: tags: - Configuration summary: Read workspace review configuration operationId: get_workspace_configuration parameters: - name: org_id in: query schema: type: string minLength: 1 description: >- Git-provider organization ID. Required for workspace keys; omit for organization keys. This differs from the CodeRabbit organization ID in scope.id. allowEmptyValue: true allowReserved: true responses: '200': description: OK content: application/json: schema: type: object properties: workspace_id: type: string format: uuid settings: type: object properties: language: enum: - de - de-DE - de-AT - de-CH - en - en-US - en-AU - en-GB - en-CA - en-NZ - en-ZA - es - es-AR - fr - fr-CA - fr-CH - fr-BE - nl - nl-BE - pt-AO - pt - pt-BR - pt-MZ - pt-PT - ar - ast-ES - ast - be-BY - be - br-FR - br - ca-ES - ca - ca-ES-valencia - ca-ES-balear - da-DK - da - de-DE-x-simple-language - el-GR - el - eo - fa - ga-IE - ga - gl-ES - gl - it - ja-JP - ja - km-KH - km - ko-KR - ko - pl-PL - pl - ro-RO - ro - ru-RU - ru - sk-SK - sk - sl-SI - sl - sv - ta-IN - ta - tl-PH - tl - tr - uk-UA - uk - zh-CN - zh - zh-TW - crh-UA - crh - cs-CZ - cs - nb - 'no' - nl-NL - de-DE-x-simple-language-DE - es-ES - it-IT - fa-IR - sv-SE - de-LU - fr-FR - bg-BG - bg - he-IL - he - hi-IN - hi - vi-VN - vi - th-TH - th - bn-BD - bn type: string default: en-US description: >- Set the language for reviews by using the corresponding ISO language code. tone_instructions: type: string maxLength: 250 default: '' description: >- Set the tone of reviews and chat. Example: 'You must talk like Mr. T. I pity the fool who doesn't!' early_access: type: boolean default: false description: Enable early-access features. enable_free_tier: type: boolean default: true description: >- Enable free tier features for users not on a paid plan. inheritance: type: boolean default: false description: >- Inheritance | Use parent settings for any values not defined here. Inheritance only propagates upward if enabled at each level. reviews: {} chat: type: object properties: art: type: boolean default: true description: Generate art in chat responses (ASCII or emoji). allow_non_org_members: type: boolean default: true description: >- Allow non-organization members to interact with CodeRabbit in comment chat. Set to false to restrict issue/review comment interactions to organization members on GitHub organization repositories. This does not affect automatic PR review eligibility. auto_reply: type: boolean default: true description: >- Let CodeRabbit reply automatically without requiring a mention/tag. integrations: type: object properties: jira: type: object properties: usage: enum: - auto - enabled - disabled type: string default: auto description: >- Jira | Allow creating Jira issues from chat. 'auto' disables the integration for public repositories. issue_template: type: string maxLength: 3000 default: '' description: >- Jira Issue Template | Structure to use for the description of Jira issues created from chat. Provide the headings your team expects, one per line, for example '## Goal', '## Description', '## Acceptance Criteria'. Leave empty to let CodeRabbit choose the structure. default: {} linear: type: object properties: usage: enum: - auto - enabled - disabled type: string default: auto description: >- Linear | Allow creating Linear issues from chat. 'auto' disables the integration for public repositories. default: {} default: {} default: {} knowledge_base: type: object properties: opt_out: type: boolean default: false description: >- Opt Out | Disable knowledge base features that require data retention. Opting out removes any existing stored knowledge base data. web_search: type: object properties: enabled: type: boolean default: true description: >- Web Search | Use web search to gather additional context. default: {} code_guidelines: type: object properties: enabled: type: boolean default: true description: >- Enabled | Apply your organization's coding standards during reviews. filePatterns: type: array items: anyOf: - type: string - type: object properties: files: type: string description: >- Files | Comma-separated glob patterns for guideline files (e.g., `**/AGENTS.md`). Multiple patterns supported. File names are case-sensitive. applyTo: type: string description: >- Apply To | Comma-separated glob patterns for files these guidelines applies to (e.g., `**/*.ts`). Multiple patterns supported. File names are case-sensitive. required: - files - applyTo default: [] description: >- File Patterns | Patterns for your coding guideline documents. CodeRabbit scans these files to learn your standards and apply them during reviews. Multiple files supported; file names are case-sensitive. An entry may also reference another repository the CodeRabbit installation can read, as repo:path or owner/repo:path (e.g. engineering-standards:frontend/react.md, globs supported); such files are read at that repository's default branch. A bare repo name uses the reviewed repository's owner. On GitHub.com, owner/repo:path may reference another organization when the CodeRabbit App is installed there with access to the source repository. Every cross-organization source requires author and review-actor read access under the existing identity rules, even when named by trusted target configuration. Other providers require the same organization. Defaults include: (**/.cursorrules, .github/copilot-instructions.md, .github/instructions/**/*.instructions.md, **/CLAUDE.md, **/.claude/rules/**/*.md, **/GEMINI.md, .gemini/styleguide.md, **/.cursor/rules/*, **/.cursor/BUGBOT.md, **/.windsurfrules, **/.clinerules/*, **/.rules/*, **/AGENT.md, **/AGENTS.md, **/REVIEW.md, **/.greptile/rules.md). default: {} description: >- Use your coding guideline documents (see File Patterns) as review criteria. learnings: type: object properties: scope: enum: - local - global - auto type: string default: auto description: >- Learnings | Choose scope: 'local' (repo), 'global' (org), or 'auto' (local for public repos, global for private repos). approval_delay: type: integer minimum: 0 maximum: 30 default: 0 description: >- Days admins have to approve or reject a learning before it is automatically applied. Must be an integer between 0 and 30. Set to 0 to apply learnings immediately without approval. default: {} issues: type: object properties: scope: enum: - local - global - auto type: string default: auto description: >- Issues | Choose scope for GitHub/GitLab issues: 'local' (repo), 'global' (org), or 'auto' (local for public repos, global for private repos). default: {} jira: type: object properties: usage: enum: - auto - enabled - disabled type: string default: auto description: >- Jira | Use Jira as a knowledge source. 'auto' disables the integration for public repositories. project_keys: type: array items: type: string default: [] description: >- Jira Project Keys | Restrict Jira context to these projects. excluded_project_keys: type: array items: type: string default: [] description: >- Jira Excluded Project Keys | Never use these Jira projects as CodeRabbit context, regardless of repository allowlists. Managed at the workspace level as a security policy; exclusions always take precedence over any allowlist. default: {} linear: type: object properties: usage: enum: - auto - enabled - disabled type: string default: auto description: >- Linear | Use Linear as a knowledge source. 'auto' disables the integration for public repositories. team_keys: type: array items: type: string default: [] description: >- Linear Team Keys | Restrict Linear context to these teams (e.g. 'ENG'). default: {} pull_requests: type: object properties: scope: enum: - local - global - auto type: string default: auto description: >- PRs | Choose scope: 'local' (repo), 'global' (org), or 'auto' (local for public repos, global for private repos). default: {} mcp: type: object properties: usage: enum: - auto - enabled - disabled type: string default: auto description: >- MCP | Use MCP servers as a knowledge source. 'auto' disables the integration for public repositories. disabled_servers: default: [] description: >- Disabled MCP Servers | Specify MCP server labels to disable (case-insensitive). These servers will be excluded from reviews and knowledge base queries. additionalProperties: false default: {} automatic_linking_mode: enum: - auto - enabled - disabled type: string default: disabled description: >- Automatic Linking Mode | For Auto, private repositories may automatically link to public or private repositories, while public repositories may automatically link only to public repositories. Enabled uses context from any eligible repository in the organization, whether public or private. Disabled creates no automatic repository links. Manual repository links configured below are unaffected. automatic_repository_linking: type: boolean default: false description: >- Automatic Repository Linking | Deprecated. This setting has no effect. Use `knowledge_base.automatic_linking_mode` instead. linked_repositories: type: array maxItems: 20 items: type: object properties: repository: type: string pattern: >- ^[a-zA-Z0-9](?:[\w .-]*[\w.-])?(?:\/(?:[a-zA-Z0-9](?:[\w .-]*[\w.-])?|\.[a-zA-Z0-9](?:[\w .-]*[\w.-])?))+$ description: >- Repository name in owner/repo format (e.g., GitHub: myorg/backend-api, Azure DevOps: My Project/backend-api, GitLab: group/subgroup/repo, Bitbucket: workspace/repo) instructions: type: string maxLength: 2000 default: '' description: >- Optionally provide description and guidance on what this repository contains for CodeRabbit to consider during reviews. Example: 'Contains REST API endpoints and database models.' required: - repository additionalProperties: false default: [] description: >- Linked Repositories | Repositories that CodeRabbit should consider when reviewing PRs in this repo. Use this to surface cross-repo dependencies and catch breaking changes across related codebases. default: {} code_generation: type: object properties: docstrings: type: object properties: language: enum: - de - de-DE - de-AT - de-CH - en - en-US - en-AU - en-GB - en-CA - en-NZ - en-ZA - es - es-AR - fr - fr-CA - fr-CH - fr-BE - nl - nl-BE - pt-AO - pt - pt-BR - pt-MZ - pt-PT - ar - ast-ES - ast - be-BY - be - br-FR - br - ca-ES - ca - ca-ES-valencia - ca-ES-balear - da-DK - da - de-DE-x-simple-language - el-GR - el - eo - fa - ga-IE - ga - gl-ES - gl - it - ja-JP - ja - km-KH - km - ko-KR - ko - pl-PL - pl - ro-RO - ro - ru-RU - ru - sk-SK - sk - sl-SI - sl - sv - ta-IN - ta - tl-PH - tl - tr - uk-UA - uk - zh-CN - zh - zh-TW - crh-UA - crh - cs-CZ - cs - nb - 'no' - nl-NL - de-DE-x-simple-language-DE - es-ES - it-IT - fa-IR - sv-SE - de-LU - fr-FR - bg-BG - bg - he-IL - he - hi-IN - hi - vi-VN - vi - th-TH - th - bn-BD - bn type: string default: en-US description: >- Language for generated docstrings (ISO language code). path_instructions: type: array items: type: object properties: path: type: string description: >- File path glob pattern. Example: `**/*.js`. instructions: type: string maxLength: 20000 description: >- Additional docstring-generation guidelines for matching paths. required: - path - instructions default: [] description: >- Path Instructions | Add path-specific guidelines for docstring generation. default: path_instructions: [] description: >- Docstring Generation | Settings for generating docstrings. unit_tests: type: object properties: path_instructions: type: array items: type: object properties: path: type: string description: >- File path glob pattern. Example: `**/*.js`. instructions: type: string maxLength: 20000 description: >- Additional unit-test-generation guidelines for matching paths. required: - path - instructions default: [] description: >- Path Instructions | Add path-specific guidelines for unit test generation. default: path_instructions: [] description: >- Unit Test Generation | Settings for generating unit tests. default: {} issue_enrichment: type: object properties: auto_enrich: type: object properties: enabled: type: boolean default: false description: >- Automatic Issue Enrichment | Analyze and enrich issues with additional context (related code, potential solutions, complexity assessment). default: {} description: Settings for automatic issue enrichment. planning: type: object properties: enabled: type: boolean default: true description: >- Issue Planning | Generate an implementation plan for issues (early preview). auto_planning: type: object properties: enabled: type: boolean default: true description: >- Automatic Planning | Trigger issue planning based on labels. labels: type: array items: type: string default: [] description: >- Labels that trigger automatic issue planning. Labels starting with '!' are negative matches. Examples: ['feature', 'enhancement'] plans issues with either label. ['!wip'] plans all issues except those labeled 'wip'. ['feature', '!wip'] plans issues labeled 'feature' but not 'wip'. default: {} default: {} description: Settings for issue planning. labeling: type: object properties: labeling_instructions: type: array items: type: object properties: label: type: string description: >- Label to suggest for the issue. Example: enhancement instructions: type: string maxLength: 3000 description: >- Instructions for the label. Example: New feature or request. required: - label - instructions default: [] description: >- Labeling Instructions | Define issue labels to suggest and when to suggest them. auto_apply_labels: type: boolean default: false description: >- Automatically apply suggested labels to the issue. When enabled without labeling instructions, labels are auto-suggested based on similar issues. default: {} description: Settings for issue labeling. default: {} additionalProperties: {} settings_yaml: anyOf: - type: string - type: string nullable: true enum: - null data_opt_out: type: boolean global_override_settings: anyOf: - type: object additionalProperties: anyOf: - type: string - type: number - type: boolean - type: string nullable: true enum: - null - type: array items: anyOf: - type: string - type: number - type: boolean - type: string nullable: true enum: - null - type: array items: anyOf: - {} - type: string nullable: true enum: - null - type: object additionalProperties: {} - type: object additionalProperties: anyOf: - type: string - type: number - type: boolean - type: string nullable: true enum: - null - type: array items: anyOf: - {} - type: string nullable: true enum: - null - type: object additionalProperties: {} - type: string nullable: true enum: - null global_override_settings_yaml: anyOf: - type: string - type: string nullable: true enum: - null required: - workspace_id - settings - data_opt_out '400': description: '400' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - invalid_request type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '401': description: '401' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - unauthenticated type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '403': description: '403' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - forbidden type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '404': description: '404' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - not_found type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '409': description: '409' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - head_changed - conflict type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '412': description: '412' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - precondition_failed type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '413': description: '413' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - payload_too_large type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '429': description: '429' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - rate_limit_exceeded type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '500': description: '500' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - internal_error type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '503': description: '503' content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - unavailable message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false components: securitySchemes: 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.