Skip to main content
PATCH
/
v2
/
human-eval-sets
/
{id}
Update a human review set
curl --request PATCH \
  --url https://api.orq.ai/v2/human-eval-sets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "human_eval_ids": [
    "<string>"
  ],
  "filter_type": "span_type",
  "filter_values": [
    "<string>"
  ],
  "description": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "_id": "<string>",
  "display_name": "<string>",
  "human_eval_ids": [
    "<string>"
  ],
  "workspace_id": "<string>",
  "filter_type": "span_type",
  "filter_values": [
    "<string>"
  ],
  "description": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_id": "<string>",
  "updated_by_id": "<string>",
  "created": "2026-03-19T13:03:29.125Z",
  "updated": "2026-03-19T13:03:29.127Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The ID of the human review set to retrieve

Body

application/json
​
display_name
string
required

Display name of the human review set

Required string length: 1 - 255
​
human_eval_ids
string<ulid>[]
required

Array of human review IDs to be applied to matching spans

Minimum array length: 1

The id of the resource

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
​
filter_type
enum<string>
required
Available options:
span_type
​
filter_values
string[]
required

Array of span types to match

Minimum array length: 1
​
description
string

Detailed description of the human review set

​
project_id

Optional project ID to scope this human review set to a specific project

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

200 - application/json

Successfully updated the human review set

​
_id
string<ulid>
required

The id of the resource

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
​
display_name
string
required

Display name of the human review set

Required string length: 1 - 255
​
human_eval_ids
string<ulid>[]
required

Array of human review IDs to be applied to matching spans

Minimum array length: 1

The id of the resource

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
​
workspace_id
string
required
​
filter_type
enum<string>
required
Available options:
span_type
​
filter_values
string[]
required

Array of span types to match

Minimum array length: 1
​
description
string

Detailed description of the human review set

​
project_id

Optional project ID to scope this human review set to a specific project

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
​
created_by_id
string
​
updated_by_id
string
​
created
default:2026-03-19T13:03:29.125Z

The date and time the resource was created

​
updated
default:2026-03-19T13:03:29.127Z

The date and time the resource was last updated