curl --request POST \
--url https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"exampleNames": [
"<string>"
],
"instructions": "<string>",
"focusFields": [
{
"path": "<string>",
"reason": "<string>"
}
],
"ignoredFields": [
"<string>"
],
"itemNotes": [
{
"exampleName": "<string>",
"comment": "<string>",
"fields": [
{
"path": "<string>",
"comment": "<string>"
}
]
}
]
}
'import requests
url = "https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests"
payload = {
"title": "<string>",
"exampleNames": ["<string>"],
"instructions": "<string>",
"focusFields": [
{
"path": "<string>",
"reason": "<string>"
}
],
"ignoredFields": ["<string>"],
"itemNotes": [
{
"exampleName": "<string>",
"comment": "<string>",
"fields": [
{
"path": "<string>",
"comment": "<string>"
}
]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
exampleNames: ['<string>'],
instructions: '<string>',
focusFields: [{path: '<string>', reason: '<string>'}],
ignoredFields: ['<string>'],
itemNotes: [
{
exampleName: '<string>',
comment: '<string>',
fields: [{path: '<string>', comment: '<string>'}]
}
]
})
};
fetch('https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'exampleNames' => [
'<string>'
],
'instructions' => '<string>',
'focusFields' => [
[
'path' => '<string>',
'reason' => '<string>'
]
],
'ignoredFields' => [
'<string>'
],
'itemNotes' => [
[
'exampleName' => '<string>',
'comment' => '<string>',
'fields' => [
[
'path' => '<string>',
'comment' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"exampleNames\": [\n \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"focusFields\": [\n {\n \"path\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ],\n \"ignoredFields\": [\n \"<string>\"\n ],\n \"itemNotes\": [\n {\n \"exampleName\": \"<string>\",\n \"comment\": \"<string>\",\n \"fields\": [\n {\n \"path\": \"<string>\",\n \"comment\": \"<string>\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"exampleNames\": [\n \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"focusFields\": [\n {\n \"path\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ],\n \"ignoredFields\": [\n \"<string>\"\n ],\n \"itemNotes\": [\n {\n \"exampleName\": \"<string>\",\n \"comment\": \"<string>\",\n \"fields\": [\n {\n \"path\": \"<string>\",\n \"comment\": \"<string>\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"exampleNames\": [\n \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"focusFields\": [\n {\n \"path\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ],\n \"ignoredFields\": [\n \"<string>\"\n ],\n \"itemNotes\": [\n {\n \"exampleName\": \"<string>\",\n \"comment\": \"<string>\",\n \"fields\": [\n {\n \"path\": \"<string>\",\n \"comment\": \"<string>\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"automationId": "<string>",
"title": "<string>",
"instructions": "<string>",
"focusFields": [
{
"path": "<string>",
"reason": "<string>"
}
],
"ignoredFields": [
"<string>"
],
"status": "draft",
"exampleNames": [
"<string>"
],
"progress": {
"total": 4503599627370495,
"pending": 4503599627370495,
"approved": 4503599627370495,
"edited": 4503599627370495,
"rejected": 4503599627370495,
"remaining": 4503599627370495,
"complete": true
},
"createdBy": "<string>",
"createdAt": "<string>",
"closedAt": "<string>",
"items": [
{
"id": "<string>",
"reviewId": "<string>",
"exampleName": "<string>",
"snapshotInputJson": {},
"snapshotExpectedJson": null,
"snapshotManifest": {
"expectedFiles": [
{
"name": "<string>"
}
],
"metadata": {},
"inputFileHashes": [
{
"path": "<string>",
"sha256": "<string>"
}
]
},
"status": "pending",
"currentExpectedJson": null,
"fieldDecisions": {},
"inputDrifted": true,
"updatedBy": "<string>",
"updatedAt": "<string>"
}
],
"events": [
{
"id": "<string>",
"reviewId": "<string>",
"itemId": "<string>",
"actorUserId": "<string>",
"action": "created",
"diffSummary": null,
"createdAt": "<string>"
}
]
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}Create dataset review request
Snapshot selected dataset examples into a review request. Include instructions, focusFields to highlight, and ignoredFields for paths reviewers can skip. Optional itemNotes become commented events on those examples.
curl --request POST \
--url https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"exampleNames": [
"<string>"
],
"instructions": "<string>",
"focusFields": [
{
"path": "<string>",
"reason": "<string>"
}
],
"ignoredFields": [
"<string>"
],
"itemNotes": [
{
"exampleName": "<string>",
"comment": "<string>",
"fields": [
{
"path": "<string>",
"comment": "<string>"
}
]
}
]
}
'import requests
url = "https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests"
payload = {
"title": "<string>",
"exampleNames": ["<string>"],
"instructions": "<string>",
"focusFields": [
{
"path": "<string>",
"reason": "<string>"
}
],
"ignoredFields": ["<string>"],
"itemNotes": [
{
"exampleName": "<string>",
"comment": "<string>",
"fields": [
{
"path": "<string>",
"comment": "<string>"
}
]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
exampleNames: ['<string>'],
instructions: '<string>',
focusFields: [{path: '<string>', reason: '<string>'}],
ignoredFields: ['<string>'],
itemNotes: [
{
exampleName: '<string>',
comment: '<string>',
fields: [{path: '<string>', comment: '<string>'}]
}
]
})
};
fetch('https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'exampleNames' => [
'<string>'
],
'instructions' => '<string>',
'focusFields' => [
[
'path' => '<string>',
'reason' => '<string>'
]
],
'ignoredFields' => [
'<string>'
],
'itemNotes' => [
[
'exampleName' => '<string>',
'comment' => '<string>',
'fields' => [
[
'path' => '<string>',
'comment' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"exampleNames\": [\n \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"focusFields\": [\n {\n \"path\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ],\n \"ignoredFields\": [\n \"<string>\"\n ],\n \"itemNotes\": [\n {\n \"exampleName\": \"<string>\",\n \"comment\": \"<string>\",\n \"fields\": [\n {\n \"path\": \"<string>\",\n \"comment\": \"<string>\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"exampleNames\": [\n \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"focusFields\": [\n {\n \"path\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ],\n \"ignoredFields\": [\n \"<string>\"\n ],\n \"itemNotes\": [\n {\n \"exampleName\": \"<string>\",\n \"comment\": \"<string>\",\n \"fields\": [\n {\n \"path\": \"<string>\",\n \"comment\": \"<string>\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eigenpal.com/v1/automations/{id}/dataset-review-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"exampleNames\": [\n \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"focusFields\": [\n {\n \"path\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ],\n \"ignoredFields\": [\n \"<string>\"\n ],\n \"itemNotes\": [\n {\n \"exampleName\": \"<string>\",\n \"comment\": \"<string>\",\n \"fields\": [\n {\n \"path\": \"<string>\",\n \"comment\": \"<string>\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"automationId": "<string>",
"title": "<string>",
"instructions": "<string>",
"focusFields": [
{
"path": "<string>",
"reason": "<string>"
}
],
"ignoredFields": [
"<string>"
],
"status": "draft",
"exampleNames": [
"<string>"
],
"progress": {
"total": 4503599627370495,
"pending": 4503599627370495,
"approved": 4503599627370495,
"edited": 4503599627370495,
"rejected": 4503599627370495,
"remaining": 4503599627370495,
"complete": true
},
"createdBy": "<string>",
"createdAt": "<string>",
"closedAt": "<string>",
"items": [
{
"id": "<string>",
"reviewId": "<string>",
"exampleName": "<string>",
"snapshotInputJson": {},
"snapshotExpectedJson": null,
"snapshotManifest": {
"expectedFiles": [
{
"name": "<string>"
}
],
"metadata": {},
"inputFileHashes": [
{
"path": "<string>",
"sha256": "<string>"
}
]
},
"status": "pending",
"currentExpectedJson": null,
"fieldDecisions": {},
"inputDrifted": true,
"updatedBy": "<string>",
"updatedAt": "<string>"
}
],
"events": [
{
"id": "<string>",
"reviewId": "<string>",
"itemId": "<string>",
"actorUserId": "<string>",
"action": "created",
"diffSummary": null,
"createdAt": "<string>"
}
]
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}Authorizations
API key issued from Settings → API Keys. Pass as Authorization: Bearer <key>.
Path Parameters
Automation id or typed alias, such as workflows.slug or agents.slug.
Body
111Note shown to the reviewer for the whole request.
Expected-output paths to highlight. Other fields stay normal unless listed in ignoredFields.
Show child attributes
Show child attributes
Expected-output paths reviewers can skip. Shown muted as not required. Prefixes apply to nested leaves.
1Optional per-example and per-field notes seeded as commented events at create time.
Show child attributes
Show child attributes
draft, open, paused Response
Created dataset review request.
Show child attributes
Show child attributes
draft, open, paused, closed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes