> ## 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

> Reads one PullRequest by its id: its identity, review_runs and verdict, its section, where its feedback is dispatched, and the org_id it was read in, which the console and review operations take.

Use this tool when you need to:
- Load a pull request's card facts and Aether review runs before reading its review, console or proof
- Learn the org_id and the current head_sha and base_sha the pull request's other operations take
- Follow a review run createPullRequestReviewRun started until it completes

Examples:
- GET /pull-requests/{pullRequestID}
- GET /pull-requests/6f1c2a9e-3b7d-4c55-9a2e-0d8b1f4e7c21?org_id=0b9d3e57-2c1a-4f6e-8d7b-5a4c3e2f1d09

Hints:
- pullRequestID is the pull request's uuid; org_id (uuid) optionally names the owning organization to read in. The schema answers 422 for either when malformed.
- An owning organization is one with a review run of the pull request or a non-archived project on its repository. Omitting org_id is never refused: the owners that admit the caller rank an organization where they hold a product role above one where they are a viewer, then the organization the request acts in, then the one with the newest review run.
- Answers the PullRequest listPullRequests lists: pull_request_id, pr_number, title, html_url, repo_owner, repo_name, head_sha, base_sha, pr_state, draft, review_runs (newest first), verdict, section, dispatch_target (author_task, review_run or none), stack_parent, stack_children and org_id, among others. Nothing is fetched from GitHub.
- Use getPullRequestGithub instead for the merge box (mergeability, checks, GitHub reviews and reviewers), getPullRequestReview for the review page's description, posted reviews and file manifest, and getRepoPullRequest to find the id from a repository and number.
- Any member of an owning organization may call it, a viewer included, and no GitHub connection is needed. A pull request that does not exist, one no organization of the caller owns and an org_id that does not own it answer the same 404.
- When no owner admits the caller, a billing member is refused with 403 org_role_insufficient and a member of a suspended organization with 403 org_suspended; an agent host's grant is refused with 403 agent_host_route_not_allowed, and 503 answers when the membership check is unavailable.



## OpenAPI

````yaml api-reference/openapi.json GET /pull-requests/{pullRequestID}
openapi: 3.1.0
info:
  title: Aether API
  version: 0.1.0
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /pull-requests/{pullRequestID}:
    get:
      tags:
        - pull-requests
      summary: Get one pull request
      description: >-
        Reads one PullRequest by its id: its identity, review_runs and verdict,
        its section, where its feedback is dispatched, and the org_id it was
        read in, which the console and review operations take.


        Use this tool when you need to:

        - Load a pull request's card facts and Aether review runs before reading
        its review, console or proof

        - Learn the org_id and the current head_sha and base_sha the pull
        request's other operations take

        - Follow a review run createPullRequestReviewRun started until it
        completes


        Examples:

        - GET /pull-requests/{pullRequestID}

        - GET
        /pull-requests/6f1c2a9e-3b7d-4c55-9a2e-0d8b1f4e7c21?org_id=0b9d3e57-2c1a-4f6e-8d7b-5a4c3e2f1d09


        Hints:

        - pullRequestID is the pull request's uuid; org_id (uuid) optionally
        names the owning organization to read in. The schema answers 422 for
        either when malformed.

        - An owning organization is one with a review run of the pull request or
        a non-archived project on its repository. Omitting org_id is never
        refused: the owners that admit the caller rank an organization where
        they hold a product role above one where they are a viewer, then the
        organization the request acts in, then the one with the newest review
        run.

        - Answers the PullRequest listPullRequests lists: pull_request_id,
        pr_number, title, html_url, repo_owner, repo_name, head_sha, base_sha,
        pr_state, draft, review_runs (newest first), verdict, section,
        dispatch_target (author_task, review_run or none), stack_parent,
        stack_children and org_id, among others. Nothing is fetched from GitHub.

        - Use getPullRequestGithub instead for the merge box (mergeability,
        checks, GitHub reviews and reviewers), getPullRequestReview for the
        review page's description, posted reviews and file manifest, and
        getRepoPullRequest to find the id from a repository and number.

        - Any member of an owning organization may call it, a viewer included,
        and no GitHub connection is needed. A pull request that does not exist,
        one no organization of the caller owns and an org_id that does not own
        it answer the same 404.

        - When no owner admits the caller, a billing member is refused with 403
        org_role_insufficient and a member of a suspended organization with 403
        org_suspended; an agent host's grant is refused with 403
        agent_host_route_not_allowed, and 503 answers when the membership check
        is unavailable.
      operationId: getPullRequest
      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. Omitted, getPullRequest and the review page's
            operations (its review, file, head snapshot and stack) act in the
            owning organization getPullRequest ranks first, and a console
            operation refuses with 422 org_id_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. Omitted, getPullRequest and the review page's
              operations (its review, file, head snapshot and stack) act in the
              owning organization getPullRequest ranks first, and a console
              operation refuses with 422 org_id_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/PullRequest'
          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
        '410':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullRequestsErrorResponse'
          description: Gone
        '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:
    PullRequest:
      additionalProperties: false
      properties:
        additions:
          format: int64
          minimum: 0
          type: integer
        author_login:
          minLength: 1
          type: string
        base_branch:
          type: string
        base_sha:
          pattern: ^[0-9a-f]{40}$
          type: string
        checks_failed:
          format: int64
          minimum: 0
          type: integer
        checks_passed:
          format: int64
          minimum: 0
          type: integer
        checks_total:
          format: int64
          minimum: 0
          type: integer
        ci_status:
          $ref: '#/components/schemas/TaskCIStatus'
        comment_count:
          format: int64
          minimum: 0
          type:
            - integer
            - 'null'
        deletions:
          format: int64
          minimum: 0
          type: integer
        dispatch_target:
          $ref: '#/components/schemas/PullRequestDispatchTarget'
        draft:
          type: boolean
        github_updated_at:
          format: date-time
          type: string
        guide_outline:
          items:
            $ref: '#/components/schemas/PRReviewGuideOutlineSection'
          maxItems: 50
          minItems: 1
          type: array
        head_branch:
          type: string
        head_sha:
          type: string
        html_url:
          type: string
        latest_created_at:
          format: date-time
          type: string
        merged_at:
          format: date-time
          type: string
        needs_attention:
          type: boolean
        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
        origin_task:
          $ref: '#/components/schemas/PRReviewOriginTask'
        pr_number:
          format: int64
          minimum: 1
          type: integer
        pr_state:
          $ref: '#/components/schemas/TaskGitHubPRState'
        pull_request_id:
          format: uuid
          type: string
        ready_for_merge:
          type: boolean
        repo_name:
          type: string
        repo_owner:
          type: string
        review_runs:
          items:
            $ref: '#/components/schemas/PRReviewRun'
          type: array
        section:
          $ref: '#/components/schemas/PRReviewSection'
        severity_counts:
          $ref: '#/components/schemas/PRReviewSeverityCounts'
        stack_children:
          items:
            $ref: '#/components/schemas/PullRequestStackEdge'
          minItems: 1
          type: array
        stack_parent:
          $ref: '#/components/schemas/PullRequestStackEdge'
        summary_severity:
          $ref: '#/components/schemas/PRReviewSummarySeverity'
        title:
          type: string
        verdict:
          $ref: '#/components/schemas/PRReviewSummaryVerdict'
        viewer_standing:
          $ref: '#/components/schemas/PRReviewViewerStanding'
      required:
        - pull_request_id
        - pr_number
        - title
        - html_url
        - repo_owner
        - repo_name
        - latest_created_at
        - comment_count
        - needs_attention
        - review_runs
        - viewer_standing
        - checks_passed
        - checks_failed
        - checks_total
        - additions
        - deletions
        - draft
        - github_updated_at
        - ready_for_merge
        - org_id
        - section
        - dispatch_target
      type: object
    PullRequestsErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - account_deleting
            - aether_inference_unserved
            - agent_pr_blocked
            - agent_pr_pending
            - agent_profile_changed
            - agent_starts_off
            - app_identity_missing
            - attribution_unavailable
            - bad_gateway
            - bad_request
            - caller_inactive
            - chat_archived
            - chat_settings_fixed
            - chats_not_addable
            - checkout_not_archivable
            - cli_upgrade_required
            - client_outdated
            - computer_cli_outdated
            - computer_starts_no_agents
            - computer_starts_no_forks
            - computer_unreachable
            - conflict
            - connection_creator_only
            - connection_harness_mismatch
            - connection_not_held
            - contents_write_required
            - continuation_failed
            - continuation_unavailable
            - control_forbidden
            - credential_kind_not_admitted
            - download_unsupported
            - 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
            - html_render_nul_byte
            - html_render_too_large
            - idempotency_key_conflict
            - idempotency_key_reused
            - idle_compaction_not_pending
            - idle_compaction_skipped
            - inference_proxy_unavailable
            - insufficient_credits
            - insufficient_inference_balance
            - internal_error
            - invalid_request
            - last_queued_message
            - live_protocol_unsupported
            - main_chat_permanent
            - mcp_server_not_connected
            - merge_when_ready_requires_pr_review
            - message_not_queued
            - method_not_allowed
            - mode_forbidden
            - name_follows_session
            - no_checkout_on_computer
            - 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
            - pending_input_answered
            - pr_automation_unsupported
            - pr_review_actor_required
            - pr_review_connection_spent
            - pr_review_publish_forbidden
            - precondition_failed
            - project_has_no_repository
            - project_required
            - pull_request_closed
            - pull_request_mirror_failed
            - pull_request_not_mirrored
            - question_answers
            - queued_stop_requires_discard
            - rate_limited
            - reasoning_effort_fixed
            - request_canceled
            - request_timeout
            - request_too_large
            - review_name_follows_pull_request
            - sandbox_deleted
            - sandbox_failed
            - sandbox_needs_message
            - 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_backed_by_work_tree
            - task_connection_disconnected
            - task_creator_deleted
            - task_fork_refused
            - task_has_no_repository
            - task_ineligible
            - task_not_accepting_messages
            - task_not_pinnable
            - task_not_started
            - task_settings_changed
            - task_start_failed
            - task_start_pending
            - teleport_unavailable
            - terminal_chat_continuation_refused
            - too_many_live_connections
            - unauthenticated
            - unsigned_aether_head
            - unsigned_commit
            - unsupported_changes
            - unsupported_media_type
            - untyped_error
            - user_suspended
            - validation_failed
            - workspace_git_unavailable
            - workspace_gone
            - 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
            - grant_scope_insufficient
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      type: object
    TaskCIStatus:
      enum:
        - pending
        - passed
        - failed
      type: string
    PullRequestDispatchTarget:
      enum:
        - author_task
        - review_run
        - none
      type: string
    PRReviewGuideOutlineSection:
      additionalProperties: false
      properties:
        paths:
          items:
            minLength: 1
            pattern: "[^\t-\r \N\_  - \L\P  　\uFEFF]"
            type: string
          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
        - paths
      type: object
    PRReviewOriginTask:
      additionalProperties: false
      properties:
        id:
          format: uuid
          type: string
        turn_count:
          format: int64
          minimum: 0
          type: integer
      required:
        - id
        - turn_count
      type: object
    TaskGitHubPRState:
      enum:
        - open
        - closed
        - merged
      type: string
    PRReviewRun:
      additionalProperties: false
      properties:
        agent_type:
          $ref: '#/components/schemas/AgentType'
        created_at:
          format: date-time
          type: string
        duration_seconds:
          format: int64
          minimum: 0
          type: integer
        error:
          type: string
        head_sha:
          type: string
        model:
          minLength: 1
          type: string
        run_number:
          format: int64
          minimum: 1
          type: integer
        status:
          $ref: '#/components/schemas/ReviewRunStatus'
        task_id:
          format: uuid
          type: string
        trigger:
          $ref: '#/components/schemas/TaskReviewTrigger'
      required:
        - task_id
        - run_number
        - status
        - created_at
        - agent_type
        - model
      type: object
    PRReviewSection:
      enum:
        - in_review
        - approved
        - other
      type: string
    PRReviewSeverityCounts:
      additionalProperties: false
      properties:
        confirmed:
          format: int64
          minimum: 0
          type: integer
        nit:
          format: int64
          minimum: 0
          type: integer
        p1:
          format: int64
          minimum: 0
          type: integer
        p2:
          format: int64
          minimum: 0
          type: integer
        question:
          format: int64
          minimum: 0
          type: integer
      required:
        - p1
        - p2
        - nit
        - question
        - confirmed
      type: object
    PullRequestStackEdge:
      additionalProperties: false
      description: >-
        One tracked open pull request on a branch-chain edge: as stack_parent,
        the pull request whose head repository and branch match this pull
        request's base; as an element of stack_children, a pull request whose
        base branch is this pull request's head. Present only when the edge
        exists in Aether's tracked pull-request projection; absence does not
        prove the pull request is unstacked.
      properties:
        html_url:
          format: uri
          pattern: ^[hH][tT][tT][pP][sS]?://
          type: string
        pr_number:
          format: int64
          minimum: 1
          type: integer
        pull_request_id:
          format: uuid
          type: string
        state:
          enum:
            - open
          type: string
        title:
          type: string
      required:
        - pull_request_id
        - pr_number
        - title
        - state
        - html_url
      type: object
    PRReviewSummarySeverity:
      enum:
        - p1
        - p2
        - nit
      type: string
    PRReviewSummaryVerdict:
      enum:
        - approve
        - request_changes
        - comment
        - dismissed
        - superseded
      type: string
    PRReviewViewerStanding:
      enum:
        - author
        - pending
        - approved
        - changes_requested
        - commented
        - dismissed
        - none
      type: string
    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
    AgentType:
      description: >-
        The agent harness that runs a task, a profile or a connection:
        claude-code or claude_code is Claude Code, codex is Codex, opencode is
        OpenCode.
      enum:
        - codex
        - claude-code
        - opencode
        - claude_code
      type: string
    ReviewRunStatus:
      enum:
        - reviewing
        - completed
        - failed
        - cancelled
        - superseded
        - archived
      type: string
    TaskReviewTrigger:
      enum:
        - automatic
        - comment_command
        - manual
      type: string
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

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