> ## 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 a saved Change Stack overview and layers (beta)

> Omit snapshot_id for the latest saved artifact or supply one to pin an exact retained snapshot. Outdated artifacts remain readable. Null means no saved artifact exists; this operation never starts generation.

Open Beta (This feature is currently in open beta. We are actively improving it based on your feedback. If you encounter any issues or have suggestions, please share them on our Discord community or visit the support page.)

> [tab] CLI Tool
>
> ```bash
> coderabbit api request "/repositories/$REPOSITORY_ID/pull-requests/$PULL_REQUEST_NUMBER/change-stack"
> ```
>
> To install and sign in to the CLI, see [Call from the CLI](https://docs.coderabbit.ai/api/cli.md).

> [tab] MCP Server
>
> An agent connected to the [CodeRabbit MCP server](https://docs.coderabbit.ai/api/mcp.md) runs this operation as the `get_pull_request_change_stack` tool. The connection selects the organization, so the arguments have no `org_id` or `org_name`.
>
> ```json
> {
>   "method": "tools/call",
>   "params": {
>     "name": "get_pull_request_change_stack",
>     "arguments": {
>       "repository_id": "<repository_id>",
>       "pull_request_number": 1
>     }
>   }
> }
> ```


## OpenAPI

````yaml /openapi.json get /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/change-stack
openapi: 3.0.0
info:
  title: CodeRabbit API
  version: 1.0.0
  description: >-
    Read and manage CodeRabbit reviews, coding tasks, Verify, Triage, security
    findings, Knowledge Base, configuration, and users for your organization.
servers:
  - url: https://api.coderabbit.ai
    description: US region
  - url: https://api.eu.coderabbit.ai
    description: EU region
security:
  - ApiKeyAuth: []
tags:
  - name: Organizations and repositories
  - name: Pull requests and reviews
  - name: Coding Agent
  - name: Coding environments
  - name: Verify
  - name: Triage
  - name: Security
  - name: Knowledge Base
  - name: Automations
  - name: Reports
  - name: Configuration
  - name: Connections
  - name: Users and roles
  - name: Usage and metrics
paths:
  /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/change-stack:
    get:
      tags:
        - Pull requests and reviews
      summary: Read a saved Change Stack overview and layers
      description: >-
        Omit snapshot_id for the latest saved artifact or supply one to pin an
        exact retained snapshot. Outdated artifacts remain readable. Null means
        no saved artifact exists; this operation never starts generation.
      operationId: get_pull_request_change_stack
      parameters:
        - name: repository_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: pull_request_number
          in: path
          required: true
          schema:
            type: integer
            minimum: 0
            maximum: 2147483647
            exclusiveMinimum: true
        - name: org_id
          in: query
          schema:
            type: string
            minLength: 1
            description: >-
              Organization for a workspace key: the Git-provider organization ID
              (scope.provider_organization_id) or the CodeRabbit organization ID
              (scope.id, or id from list organizations). Supply either org_id or
              org_name, never both. Omit for organization keys and MCP
              connections.
          allowEmptyValue: true
          allowReserved: true
        - name: org_name
          in: query
          schema:
            type: string
            pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$
            description: >-
              GitHub organization login, such as coderabbitai, not its display
              name. Matched case-insensitively within the authenticated
              workspace. Supply either org_name or org_id, never both; omit for
              organization keys and MCP connections.
          allowEmptyValue: true
          allowReserved: true
        - name: snapshot_id
          in: query
          schema:
            type: string
            minLength: 1
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  current_head_sha:
                    type: string
                  artifact:
                    anyOf:
                      - type: object
                        properties:
                          snapshot_id:
                            anyOf:
                              - type: string
                              - type: string
                                nullable: true
                                enum:
                                  - null
                          created_at:
                            type: string
                          base_sha:
                            anyOf:
                              - type: string
                              - type: string
                                nullable: true
                                enum:
                                  - null
                          reviewed_head_sha:
                            anyOf:
                              - type: string
                              - type: string
                                nullable: true
                                enum:
                                  - null
                          title:
                            type: string
                          summary:
                            type: string
                          groups:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                title:
                                  type: string
                                summary:
                                  type: string
                                layers:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                      title:
                                        type: string
                                      summary:
                                        type: string
                                      order:
                                        type: integer
                                        minimum: 0
                                      depends_on:
                                        type: array
                                        items:
                                          type: string
                                      diagrams:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            format:
                                              enum:
                                                - mermaid
                                            title:
                                              type: string
                                            source:
                                              type: string
                                          required:
                                            - format
                                            - title
                                            - source
                                      files:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            path:
                                              type: string
                                            ranges:
                                              type: array
                                              items:
                                                type: object
                                                properties:
                                                  side:
                                                    enum:
                                                      - old
                                                      - new
                                                    type: string
                                                  start_line:
                                                    anyOf:
                                                      - type: integer
                                                        minimum: 0
                                                        exclusiveMinimum: true
                                                      - type: string
                                                        nullable: true
                                                        enum:
                                                          - null
                                                  end_line:
                                                    anyOf:
                                                      - type: integer
                                                        minimum: 0
                                                        exclusiveMinimum: true
                                                      - type: string
                                                        nullable: true
                                                        enum:
                                                          - null
                                                  summary:
                                                    type: string
                                                required:
                                                  - side
                                                  - start_line
                                                  - end_line
                                                  - summary
                                          required:
                                            - path
                                            - ranges
                                    required:
                                      - id
                                      - title
                                      - summary
                                      - order
                                      - depends_on
                                      - diagrams
                                      - files
                              required:
                                - id
                                - title
                                - summary
                                - layers
                          coverage:
                            type: object
                            properties:
                              unassigned_ranges:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    side:
                                      enum:
                                        - old
                                        - new
                                      type: string
                                    start_line:
                                      anyOf:
                                        - type: integer
                                          minimum: 0
                                          exclusiveMinimum: true
                                        - type: string
                                          nullable: true
                                          enum:
                                            - null
                                    end_line:
                                      anyOf:
                                        - type: integer
                                          minimum: 0
                                          exclusiveMinimum: true
                                        - type: string
                                          nullable: true
                                          enum:
                                            - null
                                    summary:
                                      type: string
                                    path:
                                      type: string
                                  required:
                                    - side
                                    - start_line
                                    - end_line
                                    - summary
                                    - path
                              excluded_files:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    path:
                                      type: string
                                  required:
                                    - path
                            required:
                              - unassigned_ranges
                              - excluded_files
                          freshness:
                            enum:
                              - current
                              - outdated
                              - unknown
                            type: string
                        required:
                          - snapshot_id
                          - created_at
                          - base_sha
                          - reviewed_head_sha
                          - title
                          - summary
                          - groups
                          - coverage
                          - freshness
                      - type: string
                        nullable: true
                        enum:
                          - null
                required:
                  - current_head_sha
                  - artifact
        '400':
          description: Bad request
          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
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '401':
          description: Unauthorized
          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
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '403':
          description: Forbidden
          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
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '404':
          description: Not found
          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
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '409':
          description: Conflict
          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
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '412':
          description: Precondition failed
          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
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '413':
          description: Content too large
          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
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '429':
          description: Too many requests
          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
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '500':
          description: Internal server error
          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
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '503':
          description: Service unavailable
          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
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-coderabbitai-api-key
      description: >-
        See [Authentication](/api/authentication) for the key types and where to
        create a key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.