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

> Compact unresolved-disagreement state for review-note enforcement, for a set of review projects. Only projects with the `require_disagreement_notes` rule are reported. Issued via POST because the project id set is supplied in the body. Latency scales with the total scanned simulations x metrics across the requested projects.



## OpenAPI

````yaml /api-reference/v1/reviews-v1.yaml post /review-projects/disagreement-state
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/disagreement-state:
    post:
      tags:
        - Review Projects
      summary: Get review disagreement state
      description: >-
        Compact unresolved-disagreement state for review-note enforcement, for a
        set of review projects. Only projects with the
        `require_disagreement_notes` rule are reported. Issued via POST because
        the project id set is supplied in the body. Latency scales with the
        total scanned simulations x metrics across the requested projects.
      operationId: getReviewDisagreementState
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetReviewDisagreementStateRequest'
            examples:
              basic:
                summary: Disagreement state for two projects
                value:
                  project_ids:
                    - 01KRPCANWQVHVZ48YEMJ70VK52
                  include_unresolved_ids: true
      responses:
        '200':
          description: Disagreement state computed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewDisagreementStateResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    GetReviewDisagreementStateRequest:
      type: object
      required:
        - project_ids
      properties:
        project_ids:
          type: array
          items:
            type: string
          minItems: 1
          maxItems: 1000
          description: >-
            Review project IDs (ULIDs). Projects without the
            require_disagreement_notes rule are ignored.
        selected_project_id:
          type: string
          nullable: true
          description: >-
            When set with include_unresolved_ids, only this project returns its
            id lists.
        include_unresolved_ids:
          type: boolean
          default: false
          description: >-
            Include the unresolved simulation/annotation id lists (otherwise
            counts only).
    ReviewDisagreementStateResponse:
      type: object
      required:
        - projects
      properties:
        projects:
          type: array
          items:
            $ref: '#/components/schemas/ReviewDisagreementProjectState'
    ReviewDisagreementProjectState:
      type: object
      required:
        - project_id
      properties:
        project_id:
          type: string
        unresolved_simulation_count:
          type: integer
        unresolved_simulation_ids:
          type: array
          items:
            type: string
          description: >-
            Populated only when include_unresolved_ids=true (and
            selected_project_id, if set).
        unresolved_annotation_ids:
          type: array
          items:
            type: string
          description: >-
            Populated only when include_unresolved_ids=true (and
            selected_project_id, if set).
    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.
    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

````