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

> Get a single review project by ID.



## OpenAPI

````yaml get /review-projects/{project_id}
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}:
    get:
      tags:
        - Review Projects
      summary: Get review project
      description: Get a single review project by ID.
      operationId: getReviewProject
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
          description: The project ID (ULID)
      responses:
        '200':
          description: Project retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReviewProjectResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    GetReviewProjectResponse:
      type: object
      required:
        - review_project
      properties:
        review_project:
          $ref: '#/components/schemas/ReviewProjectResource'
    ReviewProjectResource:
      type: object
      description: A single review project resource.
      required:
        - name
        - id
        - display_name
        - assignees
        - linked_simulation_ids
        - linked_metric_ids
        - project_type
        - notifications
        - create_time
        - update_time
      properties:
        name:
          type: string
          description: 'Resource name: review-projects/{id}'
          example: review-projects/01HXYZ1234567890ABCDEF
        id:
          type: string
          description: Unique project ID (ULID)
          example: 01HXYZ1234567890ABCDEF
        display_name:
          type: string
          description: Human-readable project name
        description:
          type: string
          nullable: true
          description: Optional project description
        assignees:
          type: array
          items:
            type: string
          description: List of reviewer email addresses
        linked_simulation_ids:
          type: array
          items:
            type: string
          description: Simulation output IDs included in this project
        linked_metric_ids:
          type: array
          items:
            type: string
          description: Metric IDs included in this project
        project_type:
          $ref: '#/components/schemas/ProjectType'
        notifications:
          type: boolean
          description: Whether notifications are enabled
        project_rules:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/ProjectRule'
          description: Rules applied to this project (e.g. require notes on disagreement)
        create_time:
          type: string
          format: date-time
          description: Creation timestamp (ISO 8601)
        update_time:
          type: string
          format: date-time
          description: Last update timestamp (ISO 8601)
    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
    ProjectType:
      type: string
      enum:
        - PROJECT_COLLABORATIVE
        - PROJECT_INDIVIDUAL
      default: PROJECT_INDIVIDUAL
      description: >-
        Project type: COLLABORATIVE (shared annotations) or INDIVIDUAL
        (per-assignee annotations)
    ProjectRule:
      type: string
      enum:
        - require_disagreement_notes
      description: >-
        Project rule: require_disagreement_notes requires reviewer notes when
        ground truth disagrees with model output
  responses:
    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
    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
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Organization API key for authentication

````