Skip to main content
POST
/
v1
/
review-projects
Create review project
curl --request POST \
  --url https://api.coval.dev/v1/review-projects \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "display_name": "Q1 Voice Agent Review",
  "assignees": [
    "alice@company.com",
    "bob@company.com"
  ],
  "linked_simulation_ids": [
    "sim-output-001",
    "sim-output-002"
  ],
  "linked_metric_ids": [
    "metric-accuracy",
    "metric-latency"
  ]
}
'
{
  "review_project": {
    "name": "review-projects/01HXYZ1234567890ABCDEF",
    "id": "01HXYZ1234567890ABCDEF",
    "display_name": "<string>",
    "assignees": [
      "<string>"
    ],
    "linked_simulation_ids": [
      "<string>"
    ],
    "linked_metric_ids": [
      "<string>"
    ],
    "project_type": "PROJECT_INDIVIDUAL",
    "notifications": true,
    "create_time": "2023-11-07T05:31:56Z",
    "update_time": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "project_rules": []
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.coval.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Organization API key for authentication

Body

application/json
​
display_name
string
required

Project name

Required string length: 1 - 200
​
assignees
string[]
required

Reviewer emails (at least one required)

Minimum array length: 1
​
linked_simulation_ids
string[]
required

Simulation output IDs (at least one required)

Minimum array length: 1
​
linked_metric_ids
string[]
required

Metric IDs (at least one required)

Minimum array length: 1
​
description
string | null

Optional project description

​
project_type
enum<string>
default:PROJECT_INDIVIDUAL

Project type: COLLABORATIVE (shared annotations) or INDIVIDUAL (per-assignee annotations)

Available options:
PROJECT_COLLABORATIVE,
PROJECT_INDIVIDUAL
​
notifications
boolean
default:true

Enable notifications for assignees

​
project_rules
enum<string>[] | null

Rules to apply to this project

Project rule: require_disagreement_notes requires reviewer notes when ground truth disagrees with model output

Available options:
require_disagreement_notes

Response

Project created successfully

​
review_project
object
required

A single review project resource.