Skip to main content
PATCH
/
v1
/
review-annotations
/
{annotation_id}
curl --request PATCH \ --url https://api.coval.dev/v1/review-annotations/{annotation_id} \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data ' { "ground_truth_float_value": 0.85 } '
{
  "review_annotation": {
    "name": "review-annotations/abc123def456ghi789jklm",
    "id": "abc123def456ghi789jklm",
    "simulation_output_id": "<string>",
    "metric_id": "<string>",
    "assignee": "<string>",
    "status": "ACTIVE",
    "completion_status": "PENDING",
    "priority": "PRIORITY_STANDARD",
    "create_time": "2023-11-07T05:31:56Z",
    "update_time": "2023-11-07T05:31:56Z",
    "ground_truth_float_value": 123,
    "ground_truth_string_value": "<string>",
    "ground_truth_subvalues_by_timestamp": [
      {}
    ],
    "reviewer_notes": "<string>"
  }
}

Authorizations

​
X-API-Key
string
header
required

Organization API key for authentication

Path Parameters

​
annotation_id
string
required

The annotation ID

Body

application/json
​
ground_truth_float_value
number<float> | null

Ground truth numeric value (auto-completes annotation)

​
ground_truth_string_value
string | null

Ground truth string value (auto-completes annotation)

​
ground_truth_subvalues_by_timestamp
object[] | null

Ground truth subvalues

​
reviewer_notes
string | null

Reviewer notes

​
priority
enum<string>
default:PRIORITY_STANDARD

Annotation priority level

Available options:
PRIORITY_PRIMARY,
PRIORITY_STANDARD
​
assignee
string | null

Reassign to a different reviewer

​
completion_status
enum<string>

Annotation completion status: PENDING or COMPLETED

Available options:
PENDING,
COMPLETED

Response

Annotation updated successfully

​
review_annotation
object
required

A single review annotation resource.