> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runaether.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one pull request's review

> Reads what the review page shows of a pull request beyond the PullRequest: its description, the reviews Aether posted on it with their guides and comments (newest first), its file manifest, its previews and its loop, and the org_id it read in. Any member of an owning organization of the pull request may call it, a viewer included, and no GitHub connection is needed; org_id names the organization to read in, and omitted, the one where the caller holds a product role is preferred. A pull request that does not exist and one no organization of the caller owns answer the same 404. A billing member is refused with 403 org_role_insufficient.



## OpenAPI

````yaml api-reference/openapi.json GET /pull-requests/{pullRequestID}/review
openapi: 3.1.0
info:
  title: Aether API
  version: 0.1.0
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /pull-requests/{pullRequestID}/review:
    get:
      tags:
        - pull-requests
      summary: Get one pull request's review
      description: >-
        Reads what the review page shows of a pull request beyond the
        PullRequest: its description, the reviews Aether posted on it with their
        guides and comments (newest first), its file manifest, its previews and
        its loop, and the org_id it read in. Any member of an owning
        organization of the pull request may call it, a viewer included, and no
        GitHub connection is needed; org_id names the organization to read in,
        and omitted, the one where the caller holds a product role is preferred.
        A pull request that does not exist and one no organization of the caller
        owns answer the same 404. A billing member is refused with 403
        org_role_insufficient.
      operationId: getPullRequestReview
      parameters:
        - in: path
          name: pullRequestID
          required: true
          schema:
            format: uuid
            type: string
        - description: >-
            The pull request's owning organization to act in: the org_id the
            PullRequest carries. Required when more than one of the caller's
            organizations owns the pull request.
          explode: false
          in: query
          name: org_id
          schema:
            description: >-
              The pull request's owning organization to act in: the org_id the
              PullRequest carries. Required when more than one of the caller's
              organizations owns the pull request.
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullRequestReview'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullRequestsErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/PullRequestsErrorResponse'
                  - $ref: '#/components/schemas/OrgAuthorizationErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullRequestsErrorResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullRequestsErrorResponse'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullRequestsErrorResponse'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullRequestsErrorResponse'
          description: Service Unavailable
components:
  schemas:
    PullRequestReview:
      additionalProperties: false
      properties:
        description:
          type: string
        file_manifest:
          $ref: '#/components/schemas/PRHeadFileManifest'
        loop:
          $ref: '#/components/schemas/PRReviewLoop'
        loop_cost:
          $ref: '#/components/schemas/PRReviewLoopCost'
        org_id:
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
        posted_reviews:
          items:
            $ref: '#/components/schemas/PRReviewPostedReview'
          type: array
        preview_workspace:
          $ref: '#/components/schemas/PRReviewPreviewWorkspace'
        previews:
          items:
            $ref: '#/components/schemas/DeclaredPreview'
          type: array
      required:
        - org_id
        - description
        - posted_reviews
        - previews
      type: object
    PullRequestsErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - account_deleting
            - aether_inference_unserved
            - agent_pr_blocked
            - agent_pr_pending
            - agent_profile_changed
            - app_identity_missing
            - attribution_unavailable
            - bad_gateway
            - bad_request
            - caller_inactive
            - conflict
            - connection_harness_mismatch
            - connection_not_held
            - contents_write_required
            - continuation_failed
            - continuation_unavailable
            - control_forbidden
            - embeddings_unavailable
            - fix_not_requested
            - fix_requests_unrecorded
            - forbidden
            - fork_branch_delete_unsupported
            - fork_forbidden
            - gateway_timeout
            - github_failed
            - github_identity_required
            - github_push_access_required
            - gone
            - handed_branch_protected
            - head_moved
            - idempotency_key_conflict
            - idempotency_key_reused
            - inference_proxy_unavailable
            - insufficient_credits
            - insufficient_inference_balance
            - internal_error
            - invalid_request
            - mcp_server_not_connected
            - message_not_queued
            - method_not_allowed
            - mode_forbidden
            - no_dispatch_target
            - not_acceptable
            - not_found
            - not_implemented
            - onboarding_already_completed
            - onboarding_requirements_missing
            - org_id_required
            - org_role_insufficient
            - org_suspended
            - payment_required
            - pr_review_actor_required
            - pr_review_publish_forbidden
            - precondition_failed
            - project_has_no_repository
            - project_required
            - pull_request_closed
            - pull_request_mirror_failed
            - pull_request_not_mirrored
            - queued_stop_requires_discard
            - rate_limited
            - request_canceled
            - request_timeout
            - request_too_large
            - service_unavailable
            - stack_cycle
            - stack_too_large
            - stack_two_parents
            - stale_execution
            - stale_or_indeterminate
            - stale_pending_input
            - stream_delivery_gap
            - stream_event_conflict
            - task_awaiting_message
            - task_awaiting_tool_response
            - task_connection_disconnected
            - task_creator_deleted
            - task_has_no_repository
            - task_ineligible
            - task_not_accepting_messages
            - task_not_pinnable
            - task_settings_changed
            - teleport_unavailable
            - unauthenticated
            - unsigned_aether_head
            - unsigned_commit
            - unsupported_changes
            - unsupported_media_type
            - untyped_error
            - validation_failed
            - workspace_git_unavailable
            - workspace_rejected
          minLength: 1
          type: string
        error:
          minLength: 1
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
      required:
        - error
        - code
      type: object
    OrgAuthorizationErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - org_membership_required
            - org_role_insufficient
            - org_suspended
            - account_deleting
            - agent_host_route_not_allowed
            - credential_kind_not_admitted
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      type: object
    PRHeadFileManifest:
      discriminator:
        mapping:
          complete: '#/components/schemas/PRHeadFileManifestComplete'
          truncated: '#/components/schemas/PRHeadFileManifestTruncated'
        propertyName: kind
      oneOf:
        - $ref: '#/components/schemas/PRHeadFileManifestComplete'
        - $ref: '#/components/schemas/PRHeadFileManifestTruncated'
    PRReviewLoop:
      additionalProperties: false
      properties:
        last_human_event_at:
          format: date-time
          type: string
        rounds_since_human:
          format: int64
          minimum: 0
          type: integer
      required:
        - rounds_since_human
      type: object
    PRReviewLoopCost:
      additionalProperties: false
      properties:
        author_vm_seconds:
          format: int64
          minimum: 0
          type: integer
        credits_author:
          format: double
          minimum: 0
          type: number
        credits_reviewer:
          format: double
          minimum: 0
          type: number
        reviewer_vm_seconds:
          format: int64
          minimum: 0
          type: integer
        settled_through:
          format: date-time
          type: string
      required:
        - author_vm_seconds
        - reviewer_vm_seconds
        - credits_author
        - credits_reviewer
      type: object
    PRReviewPostedReview:
      additionalProperties: false
      properties:
        body:
          type: string
        comments:
          items:
            $ref: '#/components/schemas/PRReviewPostedReviewComment'
          type: array
        github_review_id:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        guide:
          items:
            $ref: '#/components/schemas/PRReviewGuideSection'
          maxItems: 50
          type: array
        head_sha:
          maxLength: 40
          minLength: 40
          pattern: ^[0-9a-f]{40}$
          type: string
        html_url:
          type: string
        posted_at:
          format: date-time
          type: string
        review_event:
          $ref: '#/components/schemas/PRReviewPostedReviewEvent'
        run:
          $ref: '#/components/schemas/ReviewRunRef'
        summary_severity:
          $ref: '#/components/schemas/PRReviewSummarySeverity'
      required:
        - github_review_id
        - html_url
        - body
        - review_event
        - posted_at
        - guide
      type: object
    PRReviewPreviewWorkspace:
      additionalProperties: false
      properties:
        display_state:
          enum:
            - deleted
            - idle
            - starting
            - stopping
            - suspending
            - ready
            - preparing
            - error
            - stopped
            - suspended
          type: string
      required:
        - display_state
      type: object
    DeclaredPreview:
      additionalProperties: false
      properties:
        name:
          maxLength: 200
          minLength: 1
          pattern: \S
          type: string
        port:
          maximum: 65535
          minimum: 1
          type: integer
        url:
          format: uri
          type: string
      required:
        - name
        - port
        - url
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    PRHeadFileManifestComplete:
      additionalProperties: false
      properties:
        files:
          items:
            $ref: '#/components/schemas/PRHeadFileManifestFile'
          maxItems: 2999
          type: array
        head_sha:
          maxLength: 40
          minLength: 40
          pattern: ^[0-9a-f]{40}$
          type: string
        kind:
          enum:
            - complete
          type: string
      required:
        - head_sha
        - kind
        - files
      type: object
    PRHeadFileManifestTruncated:
      additionalProperties: false
      properties:
        files:
          items:
            $ref: '#/components/schemas/PRHeadFileManifestFile'
          maxItems: 3000
          minItems: 3000
          type: array
        head_sha:
          maxLength: 40
          minLength: 40
          pattern: ^[0-9a-f]{40}$
          type: string
        kind:
          enum:
            - truncated
          type: string
      required:
        - head_sha
        - kind
        - files
      type: object
    PRReviewPostedReviewComment:
      additionalProperties: false
      properties:
        body:
          type: string
        github_comment_id:
          format: int64
          maximum: 9007199254740991
          minimum: 1
          type: integer
        html_url:
          type: string
        line:
          format: int64
          minimum: 1
          type: integer
        path:
          type: string
        severity:
          $ref: '#/components/schemas/PRReviewFindingSeverity'
        side:
          $ref: '#/components/schemas/PRReviewCommentSide'
      required:
        - github_comment_id
        - path
        - body
        - html_url
      type: object
    PRReviewGuideSection:
      additionalProperties: false
      properties:
        explanation:
          maxLength: 4000
          minLength: 1
          pattern: "[^\t-\r \N\_  - \L\P  　\uFEFF]"
          type: string
          x-aether-string-length-unit: unicode-code-point
        refs:
          items:
            $ref: '#/components/schemas/PRReviewGuideRef'
          maxItems: 20
          type: array
        title:
          maxLength: 200
          minLength: 1
          pattern: "[^\t-\r \N\_  - \L\P  　\uFEFF]"
          type: string
          x-aether-string-length-unit: unicode-code-point
      required:
        - title
        - explanation
        - refs
      type: object
    PRReviewPostedReviewEvent:
      enum:
        - COMMENT
        - APPROVE
        - REQUEST_CHANGES
      type: string
    ReviewRunRef:
      additionalProperties: false
      properties:
        run_number:
          format: int64
          minimum: 1
          type: integer
        task_id:
          format: uuid
          type: string
      required:
        - task_id
        - run_number
      type: object
    PRReviewSummarySeverity:
      enum:
        - p1
        - p2
        - nit
      type: string
    PRHeadFileManifestFile:
      additionalProperties: false
      properties:
        additions:
          format: int64
          minimum: 0
          type: integer
        category:
          $ref: '#/components/schemas/PRReviewFileCategory'
        deletions:
          format: int64
          minimum: 0
          type: integer
        path:
          minLength: 1
          type: string
        status:
          $ref: '#/components/schemas/PRReviewDiffFileStatus'
      required:
        - path
        - status
        - category
        - additions
        - deletions
      type: object
    PRReviewFindingSeverity:
      enum:
        - p1
        - p2
        - nit
        - question
        - confirmed
      type: string
    PRReviewCommentSide:
      enum:
        - LEFT
        - RIGHT
      type: string
    PRReviewGuideRef:
      discriminator:
        mapping:
          file: '#/components/schemas/PRReviewGuideFileRef'
          range: '#/components/schemas/PRReviewGuideRangeRef'
        propertyName: kind
      oneOf:
        - $ref: '#/components/schemas/PRReviewGuideFileRef'
        - $ref: '#/components/schemas/PRReviewGuideRangeRef'
    PRReviewFileCategory:
      enum:
        - implementation
        - tests
        - documentation
        - generated
      type: string
    PRReviewDiffFileStatus:
      enum:
        - added
        - removed
        - modified
        - renamed
        - copied
        - changed
        - unchanged
      type: string
    PRReviewGuideFileRef:
      additionalProperties: false
      properties:
        kind:
          enum:
            - file
          type: string
        path:
          minLength: 1
          pattern: "[^\t-\r \N\_  - \L\P  　\uFEFF]"
          type: string
        side:
          $ref: '#/components/schemas/PRReviewCommentSide'
      required:
        - kind
        - path
        - side
      type: object
    PRReviewGuideRangeRef:
      additionalProperties: false
      properties:
        end_line:
          format: int64
          maximum: 2147483647
          minimum: 1
          type: integer
        kind:
          enum:
            - range
          type: string
        path:
          minLength: 1
          pattern: "[^\t-\r \N\_  - \L\P  　\uFEFF]"
          type: string
        side:
          $ref: '#/components/schemas/PRReviewCommentSide'
        start_line:
          format: int64
          maximum: 2147483647
          minimum: 1
          type: integer
      required:
        - kind
        - path
        - side
        - start_line
        - end_line
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

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