Skip to main content
POST
Create review project

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
blind_labeling_shown_metric_ids
string[] | null

Metric IDs whose machine score stays visible during blind labeling

Response

Project created successfully

review_project
object
required

A single review project resource.