Skip to main content
PATCH

Authorizations

X-API-Key
string
header
required

Organization API key for authentication

Path Parameters

project_id
string
required

The project ID (ULID)

Body

application/json
display_name
string | null

Updated project name

Required string length: 1 - 200
description
string | null

Updated description

assignees
string[] | null

Updated assignee list

linked_simulation_ids
string[] | null

Updated simulation IDs

add_linked_simulation_ids
string[] | null

Simulation IDs to add atomically; cannot be combined with other project updates

Minimum array length: 1
remove_linked_simulation_ids
string[] | null

Simulation IDs to remove atomically; cannot be combined with other project updates

Minimum array length: 1
linked_metric_ids
string[] | null

Updated metric IDs

Maximum array length: 25
metric_addition_completion_action
enum<string> | null

Required only when adding metrics to choose whether valid enforced-collaborative completed conversations reopen; omitted keeps completed conversations unchanged

Available options:
KEEP_COMPLETED,
REOPEN_COMPLETED
notifications
boolean | null

Updated notification setting

project_rules
enum<string>[] | null

Updated project rules

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

opted_out_assignees
string[] | null

Assignees who opted out of notifications

enforced_collaboration
boolean
default:false

Enforce claims and explicit single-author completion for collaborative projects

Response

Project updated successfully

review_project
object
required

A single review project resource.