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

# Get review project progress

> Project-level human-review completion (total vs completed tasks and percentage) for one review project, so a consumer can poll a project until the humans are done and then pull the labels. Per-reviewer progress is not exposed.



## OpenAPI

````yaml /api-reference/v1/reviews-v1.yaml get /review-projects/{project_id}/progress
openapi: 3.0.3
info:
  title: Coval Reviews API
  version: 1.0.0
  description: >
    Manage human review annotations and projects for AI evaluation quality
    assurance.


    **Annotations** are individual review tasks assigned to reviewers, linked to
    a

    simulation output and metric. Reviewers provide ground-truth values and
    notes.


    **Projects** group annotations by linking sets of simulations, metrics, and

    assignees. Creating a project auto-generates annotations for every

    (simulation, metric, assignee) combination.


    Key concepts:

    - Ground truth updates auto-complete annotations (FR-4)

    - Resource naming: `review-annotations/{id}`, `review-projects/{id}`
  contact:
    name: Coval API Support
    email: support@coval.dev
    url: https://docs.coval.ai
  license:
    name: Proprietary
    url: https://coval.dev/terms
servers:
  - url: https://api.coval.dev/v1
    description: Production API
security:
  - ApiKeyAuth: []
tags:
  - name: Review Annotations
    description: Annotation CRUD operations
  - name: Review Projects
    description: Project CRUD operations
paths:
  /review-projects/{project_id}/progress:
    get:
      tags:
        - Review Projects
      summary: Get review project progress
      description: >-
        Project-level human-review completion (total vs completed tasks and
        percentage) for one review project, so a consumer can poll a project
        until the humans are done and then pull the labels. Per-reviewer
        progress is not exposed.
      operationId: getReviewProjectProgress
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
          description: The project ID (ULID)
      responses:
        '200':
          description: Progress computed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProjectProgress'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ReviewProjectProgress:
      type: object
      required:
        - project_id
        - display_name
        - project_type
        - simulation_count
        - metric_count
        - assignee_count
        - total_tasks
        - completed_tasks
        - completion_percentage
      properties:
        project_id:
          type: string
        display_name:
          type: string
        project_type:
          type: string
          description: COLLABORATIVE or INDIVIDUAL.
        simulation_count:
          type: integer
        metric_count:
          type: integer
        assignee_count:
          type: integer
        total_tasks:
          type: integer
          description: Total (simulation x metric x assignee) review tasks for the project.
        completed_tasks:
          type: integer
        completion_percentage:
          type: number
          format: float
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code
              example: INVALID_ARGUMENT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameter
            details:
              type: array
              description: Detailed error information
              items:
                type: object
                properties:
                  field:
                    type: string
                    nullable: true
                    description: Field that caused the error
                  description:
                    type: string
                    description: Detailed error description
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: INVALID_ARGUMENT
              message: Invalid request body
              details:
                - field: simulation_output_id
                  description: simulation_output_id is required
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: UNAUTHENTICATED
              message: Authentication failed
              details:
                - field: X-API-Key
                  description: Invalid or missing API key
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: PERMISSION_DENIED
              message: Insufficient permissions
              details:
                - field: permissions
                  description: >-
                    The API key does not include the required reviews
                    permission.
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              details:
                - field: annotation_id
                  description: Annotation not found or not accessible by your organization
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: INTERNAL
              message: Internal server error
              details:
                - description: An unexpected error occurred
    ServiceUnavailable:
      description: Service temporarily unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: INTERNAL
              message: Service temporarily unavailable
              details:
                - description: Database routing is temporarily unavailable. Please retry.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Organization API key for authentication

````