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

# Get review status and results

> Poll a submitted review until it is completed or failed.



## OpenAPI

````yaml GET /v1/reviews/{review_id}
openapi: 3.1.0
info:
  title: Propel API
  description: >-
    API for managing review API tokens and running asynchronous diff-based code
    reviews.
  version: 1.0.0
servers:
  - url: https://api.propelcode.ai
    description: Production
  - url: http://localhost:6060
    description: Local
security: []
paths:
  /v1/reviews/{review_id}:
    get:
      summary: Get review status and results
      description: Retrieve status and comments for a submitted review.
      parameters:
        - name: review_id
          in: path
          required: true
          schema:
            type: string
          description: Review ID returned by POST /v1/reviews.
      responses:
        '200':
          description: Review status and comments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewJobResponse'
        '401':
          description: Missing or invalid authorization token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Token expired or missing required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Review not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - reviewBearerAuth: []
components:
  schemas:
    ReviewJobResponse:
      type: object
      required:
        - review_id
        - status
        - created_at
        - updated_at
      properties:
        review_id:
          type: string
        status:
          type: string
          enum:
            - queued
            - running
            - completed
            - failed
        repository:
          type: string
        base_commit:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        started_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
        comments:
          type: array
          items:
            $ref: '#/components/schemas/ReviewComment'
        error:
          $ref: '#/components/schemas/ReviewJobError'
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        message:
          type: string
      additionalProperties: true
    ReviewComment:
      type: object
      required:
        - file_path
        - line
        - message
        - severity
      properties:
        file_path:
          type: string
        line:
          type: integer
        message:
          type: string
        severity:
          type: string
      additionalProperties: false
    ReviewJobError:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
      additionalProperties: false
  securitySchemes:
    reviewBearerAuth:
      type: http
      scheme: bearer
      description: Review API token created through /v1/auth/tokens.

````