Skip to main content
POST
Create review project

Authorizations

X-API-Key
string
header
required

Organization API key for authentication

Headers

X-Coval-Workspace-Id
string

Workspace that scopes this operation. When omitted, the organization's active default workspace is used when one can be resolved.

Required string length: 1 - 26

Body

application/json

Select at least one reviewer by legacy email or verified Coval User ID. Nonempty emails and User IDs cannot be combined.

assignees
string[]
required

Legacy reviewer emails; optional when assignee_user_ids selects the reviewers.

Minimum array length: 1
display_name
string
required

Project name

Required string length: 1 - 200
assignee_user_ids
string[] | null

Verified Coval reviewer User IDs. Null uses the legacy email path.

Required array length: 1 - 1000 elements
Required string length: 26
description
string | null

Optional project description

linked_simulation_ids
string[]

Simulation output IDs (at least one required)

Minimum array length: 1
linked_metric_ids
string[]

Metric IDs (at least one required)

Required array length: 1 - 25 elements
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
blind_labeling_shown_metric_ids
string[] | null

Metric IDs whose machine score stays visible during blind labeling

enforced_collaboration
boolean
default:false

Enforce claims and explicit single-author completion for collaborative projects

allow_metric_skipping
boolean
default:false

Allow reviewers to skip linked metrics

review_label_enabled
boolean | null

False pauses conversation triage for everyone while preserving categories, modes, and saved labels. True enables triage. Null uses legacy configuration-based activation.

review_label_input_mode
enum<string> | null
Available options:
OPTION_ONLY,
CUSTOM_ONLY,
OPTION_OR_CUSTOM
review_label_options
string[] | null
review_label_selection_mode
enum<string> | null
Available options:
SINGLE,
MULTIPLE

Response

Project created successfully

review_project
object
required

A single review project resource.