Skip to main content
POST
Create dataset review request

Authorizations

Authorization
string
header
required

API key issued from Settings → API Keys. Pass as Authorization: Bearer <key>.

Path Parameters

id
string
required

Automation id or typed alias, such as workflows.slug or agents.slug.

Body

application/json
title
string
required
Minimum string length: 1
exampleNames
string[]
required
Minimum array length: 1
Minimum string length: 1
instructions
string | null

Note shown to the reviewer for the whole request.

focusFields
object[]

Expected-output paths to highlight. Other fields stay normal unless listed in ignoredFields.

ignoredFields
string[]

Expected-output paths reviewers can skip. Shown muted as not required. Prefixes apply to nested leaves.

Minimum string length: 1
itemNotes
object[]

Optional per-example and per-field notes seeded as commented events at create time.

status
enum<string>
Available options:
draft,
open,
paused

Response

Created dataset review request.

id
string
required
automationId
string
required
title
string
required
instructions
string | null
required
focusFields
object[]
required
ignoredFields
string[]
required
status
enum<string>
required
Available options:
draft,
open,
paused,
closed
exampleNames
string[]
required
progress
object
required
createdBy
string | null
required
createdAt
string
required
closedAt
string | null
required
items
object[]
required
events
object[]