> ## 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. # Update review annotation > Partially update a review annotation. Providing a ground truth value auto-sets `completion_status` to `COMPLETED`. ## OpenAPI ````yaml patch /review-annotations/{annotation_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-annotations/{annotation_id}: patch: tags: - Review Annotations summary: Update review annotation description: > Partially update a review annotation. Providing a ground truth value auto-sets `completion_status` to `COMPLETED`. operationId: updateReviewAnnotation parameters: - name: annotation_id in: path required: true schema: type: string description: The annotation ID - name: project_id in: query required: false schema: type: string description: Optional project ID to apply project-rule-aware completion status requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateReviewAnnotationRequest' examples: set_ground_truth: summary: Set ground truth (auto-completes) value: ground_truth_float_value: 0.85 update_assignee: summary: Reassign annotation value: assignee: new-reviewer@company.com responses: '200': description: Annotation updated successfully content: application/json: schema: $ref: '#/components/schemas/UpdateReviewAnnotationResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' security: - ApiKeyAuth: [] components: schemas: UpdateReviewAnnotationRequest: type: object properties: ground_truth_float_value: type: number format: float nullable: true description: Ground truth numeric value (auto-completes annotation) ground_truth_string_value: type: string nullable: true description: Ground truth string value (auto-completes annotation) ground_truth_subvalues_by_timestamp: type: array nullable: true items: type: object description: Ground truth subvalues reviewer_notes: type: string nullable: true description: Reviewer notes priority: $ref: '#/components/schemas/AnnotationPriority' assignee: type: string nullable: true description: Reassign to a different reviewer UpdateReviewAnnotationResponse: type: object required: - review_annotation properties: review_annotation: $ref: '#/components/schemas/ReviewAnnotationResource' AnnotationPriority: type: string enum: - PRIORITY_PRIMARY - PRIORITY_STANDARD default: PRIORITY_STANDARD description: Annotation priority level ReviewAnnotationResource: type: object description: A single review annotation resource. required: - name - id - simulation_output_id - metric_id - assignee - status - completion_status - priority - create_time - update_time properties: name: type: string description: 'Resource name: review-annotations/{id}' example: review-annotations/abc123def456ghi789jklm id: type: string description: Unique annotation ID example: abc123def456ghi789jklm simulation_output_id: type: string description: Linked simulation output ID metric_id: type: string description: Linked metric ID assignee: type: string description: Email of the assigned reviewer ground_truth_float_value: type: number format: float nullable: true description: Reviewer-provided ground truth numeric value ground_truth_string_value: type: string nullable: true description: Reviewer-provided ground truth string value ground_truth_subvalues_by_timestamp: type: array nullable: true description: Reviewer-provided ground truth subvalues keyed by timestamp items: type: object reviewer_notes: type: string nullable: true description: Free-text reviewer notes status: $ref: '#/components/schemas/AnnotationStatus' completion_status: $ref: '#/components/schemas/CompletionStatus' priority: $ref: '#/components/schemas/AnnotationPriority' 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 AnnotationStatus: type: string enum: - ACTIVE - ARCHIVED description: 'Annotation lifecycle status: ACTIVE (default) or ARCHIVED' CompletionStatus: type: string enum: - PENDING - COMPLETED description: 'Annotation completion status: PENDING or COMPLETED' 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 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 ````