Create a new human review task
curl --request POST \
--url https://flows.super.ai/api/human-review-tasks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"flow_execution_id": "550e8400-e29b-41d4-a716-446655440000",
"source_task_execution_idx": 0,
"source_task_name": "process_document",
"target_task_executions": [
{
"task_execution_idx": 0,
"task_name": "extract_doc",
"is_editable": true,
"output_collection_idx": 0,
"output_name": "rows"
}
],
"assigned_users": [
"550e8400-e29b-41d4-a716-446655440000"
],
"assigned_worker_groups": [
"660e8400-e29b-41d4-a716-446655440001"
],
"human_messages": [
"Please verify the total amount",
"Check the invoice date"
],
"instructions": "Please review the document and verify all dates are correct.",
"review_annotations": [
{
"message": "Each line item needs a SKU",
"output_name": "line_items",
"path": [
2,
"sku"
],
"source_task_execution_idx": 2,
"source_task_name": "validate_rows",
"task_execution_idx": 0,
"task_name": "extract_doc"
}
]
}
'import requests
url = "https://flows.super.ai/api/human-review-tasks"
payload = {
"flow_execution_id": "550e8400-e29b-41d4-a716-446655440000",
"source_task_execution_idx": 0,
"source_task_name": "process_document",
"target_task_executions": [
{
"task_execution_idx": 0,
"task_name": "extract_doc",
"is_editable": True,
"output_collection_idx": 0,
"output_name": "rows"
}
],
"assigned_users": ["550e8400-e29b-41d4-a716-446655440000"],
"assigned_worker_groups": ["660e8400-e29b-41d4-a716-446655440001"],
"human_messages": ["Please verify the total amount", "Check the invoice date"],
"instructions": "Please review the document and verify all dates are correct.",
"review_annotations": [
{
"message": "Each line item needs a SKU",
"output_name": "line_items",
"path": [2, "sku"],
"source_task_execution_idx": 2,
"source_task_name": "validate_rows",
"task_execution_idx": 0,
"task_name": "extract_doc"
}
]
}
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({
flow_execution_id: '550e8400-e29b-41d4-a716-446655440000',
source_task_execution_idx: 0,
source_task_name: 'process_document',
target_task_executions: [
{
task_execution_idx: 0,
task_name: 'extract_doc',
is_editable: true,
output_collection_idx: 0,
output_name: 'rows'
}
],
assigned_users: ['550e8400-e29b-41d4-a716-446655440000'],
assigned_worker_groups: ['660e8400-e29b-41d4-a716-446655440001'],
human_messages: ['Please verify the total amount', 'Check the invoice date'],
instructions: 'Please review the document and verify all dates are correct.',
review_annotations: [
{
message: 'Each line item needs a SKU',
output_name: 'line_items',
path: [2, 'sku'],
source_task_execution_idx: 2,
source_task_name: 'validate_rows',
task_execution_idx: 0,
task_name: 'extract_doc'
}
]
})
};
fetch('https://flows.super.ai/api/human-review-tasks', 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://flows.super.ai/api/human-review-tasks",
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([
'flow_execution_id' => '550e8400-e29b-41d4-a716-446655440000',
'source_task_execution_idx' => 0,
'source_task_name' => 'process_document',
'target_task_executions' => [
[
'task_execution_idx' => 0,
'task_name' => 'extract_doc',
'is_editable' => true,
'output_collection_idx' => 0,
'output_name' => 'rows'
]
],
'assigned_users' => [
'550e8400-e29b-41d4-a716-446655440000'
],
'assigned_worker_groups' => [
'660e8400-e29b-41d4-a716-446655440001'
],
'human_messages' => [
'Please verify the total amount',
'Check the invoice date'
],
'instructions' => 'Please review the document and verify all dates are correct.',
'review_annotations' => [
[
'message' => 'Each line item needs a SKU',
'output_name' => 'line_items',
'path' => [
2,
'sku'
],
'source_task_execution_idx' => 2,
'source_task_name' => 'validate_rows',
'task_execution_idx' => 0,
'task_name' => 'extract_doc'
]
]
]),
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://flows.super.ai/api/human-review-tasks"
payload := strings.NewReader("{\n \"flow_execution_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"source_task_execution_idx\": 0,\n \"source_task_name\": \"process_document\",\n \"target_task_executions\": [\n {\n \"task_execution_idx\": 0,\n \"task_name\": \"extract_doc\",\n \"is_editable\": true,\n \"output_collection_idx\": 0,\n \"output_name\": \"rows\"\n }\n ],\n \"assigned_users\": [\n \"550e8400-e29b-41d4-a716-446655440000\"\n ],\n \"assigned_worker_groups\": [\n \"660e8400-e29b-41d4-a716-446655440001\"\n ],\n \"human_messages\": [\n \"Please verify the total amount\",\n \"Check the invoice date\"\n ],\n \"instructions\": \"Please review the document and verify all dates are correct.\",\n \"review_annotations\": [\n {\n \"message\": \"Each line item needs a SKU\",\n \"output_name\": \"line_items\",\n \"path\": [\n 2,\n \"sku\"\n ],\n \"source_task_execution_idx\": 2,\n \"source_task_name\": \"validate_rows\",\n \"task_execution_idx\": 0,\n \"task_name\": \"extract_doc\"\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://flows.super.ai/api/human-review-tasks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"flow_execution_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"source_task_execution_idx\": 0,\n \"source_task_name\": \"process_document\",\n \"target_task_executions\": [\n {\n \"task_execution_idx\": 0,\n \"task_name\": \"extract_doc\",\n \"is_editable\": true,\n \"output_collection_idx\": 0,\n \"output_name\": \"rows\"\n }\n ],\n \"assigned_users\": [\n \"550e8400-e29b-41d4-a716-446655440000\"\n ],\n \"assigned_worker_groups\": [\n \"660e8400-e29b-41d4-a716-446655440001\"\n ],\n \"human_messages\": [\n \"Please verify the total amount\",\n \"Check the invoice date\"\n ],\n \"instructions\": \"Please review the document and verify all dates are correct.\",\n \"review_annotations\": [\n {\n \"message\": \"Each line item needs a SKU\",\n \"output_name\": \"line_items\",\n \"path\": [\n 2,\n \"sku\"\n ],\n \"source_task_execution_idx\": 2,\n \"source_task_name\": \"validate_rows\",\n \"task_execution_idx\": 0,\n \"task_name\": \"extract_doc\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flows.super.ai/api/human-review-tasks")
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 \"flow_execution_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"source_task_execution_idx\": 0,\n \"source_task_name\": \"process_document\",\n \"target_task_executions\": [\n {\n \"task_execution_idx\": 0,\n \"task_name\": \"extract_doc\",\n \"is_editable\": true,\n \"output_collection_idx\": 0,\n \"output_name\": \"rows\"\n }\n ],\n \"assigned_users\": [\n \"550e8400-e29b-41d4-a716-446655440000\"\n ],\n \"assigned_worker_groups\": [\n \"660e8400-e29b-41d4-a716-446655440001\"\n ],\n \"human_messages\": [\n \"Please verify the total amount\",\n \"Check the invoice date\"\n ],\n \"instructions\": \"Please review the document and verify all dates are correct.\",\n \"review_annotations\": [\n {\n \"message\": \"Each line item needs a SKU\",\n \"output_name\": \"line_items\",\n \"path\": [\n 2,\n \"sku\"\n ],\n \"source_task_execution_idx\": 2,\n \"source_task_name\": \"validate_rows\",\n \"task_execution_idx\": 0,\n \"task_name\": \"extract_doc\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-11-07T05:31:56Z",
"flow_execution_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"modified_by": "<string>",
"organization_id": "550e8400-e29b-41d4-a716-446655440000",
"source_task_execution_idx": 0,
"source_task_name": "process_document",
"status": "pending",
"target_task_executions": [
{
"task_execution_idx": 0,
"task_name": "extract_doc",
"is_editable": true,
"output_collection_idx": 0,
"output_name": "rows"
}
],
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2024-01-01T00:00:00Z",
"completed_by": "550e8400-e29b-41d4-a716-446655440000",
"human_messages": [
"Please verify the total amount",
"Check the invoice date"
],
"instructions": "Please review the document and verify all dates are correct.",
"review_annotations": [
{
"message": "Each line item needs a SKU",
"output_name": "line_items",
"path": [
2,
"sku"
],
"source_task_execution_idx": 2,
"source_task_name": "validate_rows",
"task_execution_idx": 0,
"task_name": "extract_doc"
}
],
"review_result": true,
"reviewed_output": [
{
"comments": "All dates are correct.",
"verified": true
}
],
"signal_sent": true,
"task_metadata": {
"priority": "high",
"source": "api"
}
}human-review-tasks
Create a new human review task
Create a new human review task with assigned users.
Creates a new human review task and assigns it to the specified users. Both the task and assignments are created in a single transaction.
Context:
- The task is created with the provided flow and execution information
- All assigned users are linked to the task via assignments
- Organization ID is automatically set from the current user’s context
Use Cases:
- Create a review task for a flow execution
- Assign multiple reviewers to a task
- Track human review workflow state
Related Endpoints:
- GET /human-review-tasks - List all tasks
- GET /human-review-tasks/ - Get task details
POST
/
api
/
human-review-tasks
Create a new human review task
curl --request POST \
--url https://flows.super.ai/api/human-review-tasks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"flow_execution_id": "550e8400-e29b-41d4-a716-446655440000",
"source_task_execution_idx": 0,
"source_task_name": "process_document",
"target_task_executions": [
{
"task_execution_idx": 0,
"task_name": "extract_doc",
"is_editable": true,
"output_collection_idx": 0,
"output_name": "rows"
}
],
"assigned_users": [
"550e8400-e29b-41d4-a716-446655440000"
],
"assigned_worker_groups": [
"660e8400-e29b-41d4-a716-446655440001"
],
"human_messages": [
"Please verify the total amount",
"Check the invoice date"
],
"instructions": "Please review the document and verify all dates are correct.",
"review_annotations": [
{
"message": "Each line item needs a SKU",
"output_name": "line_items",
"path": [
2,
"sku"
],
"source_task_execution_idx": 2,
"source_task_name": "validate_rows",
"task_execution_idx": 0,
"task_name": "extract_doc"
}
]
}
'import requests
url = "https://flows.super.ai/api/human-review-tasks"
payload = {
"flow_execution_id": "550e8400-e29b-41d4-a716-446655440000",
"source_task_execution_idx": 0,
"source_task_name": "process_document",
"target_task_executions": [
{
"task_execution_idx": 0,
"task_name": "extract_doc",
"is_editable": True,
"output_collection_idx": 0,
"output_name": "rows"
}
],
"assigned_users": ["550e8400-e29b-41d4-a716-446655440000"],
"assigned_worker_groups": ["660e8400-e29b-41d4-a716-446655440001"],
"human_messages": ["Please verify the total amount", "Check the invoice date"],
"instructions": "Please review the document and verify all dates are correct.",
"review_annotations": [
{
"message": "Each line item needs a SKU",
"output_name": "line_items",
"path": [2, "sku"],
"source_task_execution_idx": 2,
"source_task_name": "validate_rows",
"task_execution_idx": 0,
"task_name": "extract_doc"
}
]
}
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({
flow_execution_id: '550e8400-e29b-41d4-a716-446655440000',
source_task_execution_idx: 0,
source_task_name: 'process_document',
target_task_executions: [
{
task_execution_idx: 0,
task_name: 'extract_doc',
is_editable: true,
output_collection_idx: 0,
output_name: 'rows'
}
],
assigned_users: ['550e8400-e29b-41d4-a716-446655440000'],
assigned_worker_groups: ['660e8400-e29b-41d4-a716-446655440001'],
human_messages: ['Please verify the total amount', 'Check the invoice date'],
instructions: 'Please review the document and verify all dates are correct.',
review_annotations: [
{
message: 'Each line item needs a SKU',
output_name: 'line_items',
path: [2, 'sku'],
source_task_execution_idx: 2,
source_task_name: 'validate_rows',
task_execution_idx: 0,
task_name: 'extract_doc'
}
]
})
};
fetch('https://flows.super.ai/api/human-review-tasks', 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://flows.super.ai/api/human-review-tasks",
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([
'flow_execution_id' => '550e8400-e29b-41d4-a716-446655440000',
'source_task_execution_idx' => 0,
'source_task_name' => 'process_document',
'target_task_executions' => [
[
'task_execution_idx' => 0,
'task_name' => 'extract_doc',
'is_editable' => true,
'output_collection_idx' => 0,
'output_name' => 'rows'
]
],
'assigned_users' => [
'550e8400-e29b-41d4-a716-446655440000'
],
'assigned_worker_groups' => [
'660e8400-e29b-41d4-a716-446655440001'
],
'human_messages' => [
'Please verify the total amount',
'Check the invoice date'
],
'instructions' => 'Please review the document and verify all dates are correct.',
'review_annotations' => [
[
'message' => 'Each line item needs a SKU',
'output_name' => 'line_items',
'path' => [
2,
'sku'
],
'source_task_execution_idx' => 2,
'source_task_name' => 'validate_rows',
'task_execution_idx' => 0,
'task_name' => 'extract_doc'
]
]
]),
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://flows.super.ai/api/human-review-tasks"
payload := strings.NewReader("{\n \"flow_execution_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"source_task_execution_idx\": 0,\n \"source_task_name\": \"process_document\",\n \"target_task_executions\": [\n {\n \"task_execution_idx\": 0,\n \"task_name\": \"extract_doc\",\n \"is_editable\": true,\n \"output_collection_idx\": 0,\n \"output_name\": \"rows\"\n }\n ],\n \"assigned_users\": [\n \"550e8400-e29b-41d4-a716-446655440000\"\n ],\n \"assigned_worker_groups\": [\n \"660e8400-e29b-41d4-a716-446655440001\"\n ],\n \"human_messages\": [\n \"Please verify the total amount\",\n \"Check the invoice date\"\n ],\n \"instructions\": \"Please review the document and verify all dates are correct.\",\n \"review_annotations\": [\n {\n \"message\": \"Each line item needs a SKU\",\n \"output_name\": \"line_items\",\n \"path\": [\n 2,\n \"sku\"\n ],\n \"source_task_execution_idx\": 2,\n \"source_task_name\": \"validate_rows\",\n \"task_execution_idx\": 0,\n \"task_name\": \"extract_doc\"\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://flows.super.ai/api/human-review-tasks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"flow_execution_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"source_task_execution_idx\": 0,\n \"source_task_name\": \"process_document\",\n \"target_task_executions\": [\n {\n \"task_execution_idx\": 0,\n \"task_name\": \"extract_doc\",\n \"is_editable\": true,\n \"output_collection_idx\": 0,\n \"output_name\": \"rows\"\n }\n ],\n \"assigned_users\": [\n \"550e8400-e29b-41d4-a716-446655440000\"\n ],\n \"assigned_worker_groups\": [\n \"660e8400-e29b-41d4-a716-446655440001\"\n ],\n \"human_messages\": [\n \"Please verify the total amount\",\n \"Check the invoice date\"\n ],\n \"instructions\": \"Please review the document and verify all dates are correct.\",\n \"review_annotations\": [\n {\n \"message\": \"Each line item needs a SKU\",\n \"output_name\": \"line_items\",\n \"path\": [\n 2,\n \"sku\"\n ],\n \"source_task_execution_idx\": 2,\n \"source_task_name\": \"validate_rows\",\n \"task_execution_idx\": 0,\n \"task_name\": \"extract_doc\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flows.super.ai/api/human-review-tasks")
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 \"flow_execution_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"source_task_execution_idx\": 0,\n \"source_task_name\": \"process_document\",\n \"target_task_executions\": [\n {\n \"task_execution_idx\": 0,\n \"task_name\": \"extract_doc\",\n \"is_editable\": true,\n \"output_collection_idx\": 0,\n \"output_name\": \"rows\"\n }\n ],\n \"assigned_users\": [\n \"550e8400-e29b-41d4-a716-446655440000\"\n ],\n \"assigned_worker_groups\": [\n \"660e8400-e29b-41d4-a716-446655440001\"\n ],\n \"human_messages\": [\n \"Please verify the total amount\",\n \"Check the invoice date\"\n ],\n \"instructions\": \"Please review the document and verify all dates are correct.\",\n \"review_annotations\": [\n {\n \"message\": \"Each line item needs a SKU\",\n \"output_name\": \"line_items\",\n \"path\": [\n 2,\n \"sku\"\n ],\n \"source_task_execution_idx\": 2,\n \"source_task_name\": \"validate_rows\",\n \"task_execution_idx\": 0,\n \"task_name\": \"extract_doc\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-11-07T05:31:56Z",
"flow_execution_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"modified_by": "<string>",
"organization_id": "550e8400-e29b-41d4-a716-446655440000",
"source_task_execution_idx": 0,
"source_task_name": "process_document",
"status": "pending",
"target_task_executions": [
{
"task_execution_idx": 0,
"task_name": "extract_doc",
"is_editable": true,
"output_collection_idx": 0,
"output_name": "rows"
}
],
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2024-01-01T00:00:00Z",
"completed_by": "550e8400-e29b-41d4-a716-446655440000",
"human_messages": [
"Please verify the total amount",
"Check the invoice date"
],
"instructions": "Please review the document and verify all dates are correct.",
"review_annotations": [
{
"message": "Each line item needs a SKU",
"output_name": "line_items",
"path": [
2,
"sku"
],
"source_task_execution_idx": 2,
"source_task_name": "validate_rows",
"task_execution_idx": 0,
"task_name": "extract_doc"
}
],
"review_result": true,
"reviewed_output": [
{
"comments": "All dates are correct.",
"verified": true
}
],
"signal_sent": true,
"task_metadata": {
"priority": "high",
"source": "api"
}
}Authorizations
BearerAuthAPIKeyAuth
JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN
Example:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Query Parameters
Controls delivery of large task values stored as GCS references. 'inline' (default) resolves references server-side and returns real values, subject to a per-request size budget (HTTP 413 when exceeded; individual references whose objects no longer exist are replaced by a 'gcs_ref_error' marker). 'refs' returns stored reference envelopes ('gcs_ref') untouched, to be resolved by the client.
Available options:
inline, refs Body
application/json
Request payload for creating a new human review task.
Every new HITL task is keyed on the source task execution that created it ((flow_execution_id, source_task_name, source_task_execution_idx) is unique among non-deleted rows). target_task_executions carries the list of tasks the reviewer should see — single-target executors send a one-element list.
UUID of the flow execution this task is associated with.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Index of the source task execution.
Example:
0
Name of the source task that created this review.
Example:
"process_document"
List of target task executions to review (one or more entries).
Minimum array length:
1Show child attributes
Show child attributes
List of user UUIDs to assign directly to this task.
Example:
["550e8400-e29b-41d4-a716-446655440000"]
List of worker group UUIDs to assign to this task.
Example:
["660e8400-e29b-41d4-a716-446655440001"]
Pre-filtered visible messages to display to the human reviewer.
Example:
[
"Please verify the total amount",
"Check the invoice date"
]
Instructions for the human reviewer on how to complete this task.
Example:
"Please review the document and verify all dates are correct."
Failed validations mapped onto the reviewed outputs; see ReviewAnnotation.
Show child attributes
Show child attributes
Response
Human review task created successfully
Response model for human review task operations.
UUID of the flow execution this task is associated with.
Example:
"550e8400-e29b-41d4-a716-446655440000"
UUID of the organization this task belongs to.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Index of the source task execution that created this review.
Example:
0
Name of the source task that created this review.
Example:
"process_document"
Status of the task. Valid values: 'pending', 'in_progress', 'completed'.
Example:
"pending"
List of target task executions to review. The reviewer sees one card per entry; reviewed_output on completion is a positional list aligned with this list.
Minimum array length:
1Show child attributes
Show child attributes
Timestamp when the task was completed. Null for not completed tasks.
Example:
"2024-01-01T00:00:00Z"
UUID of the user who completed this task. Null for not completed tasks.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Visible messages to display to the human reviewer as contextual information.
Example:
[
"Please verify the total amount",
"Check the invoice date"
]
Instructions for the human reviewer on how to complete this task.
Example:
"Please review the document and verify all dates are correct."
Failed validations mapped onto the reviewed outputs, one entry per failed validation execution and affected target. Null for reviews created before annotations existed.
Show child attributes
Show child attributes
Review result: True for correct, False for incorrect, null for not yet finished.
Example:
true
Output of the completed review. Null for tasks not yet completed. List positionally aligned with target_task_executions; each entry is a reviewed item (a dict, or a scalar for per-item references to scalar outputs).
Example:
[
{
"comments": "All dates are correct.",
"verified": true
}
]
Whether the Temporal resume signal was sent. False when deferred due to concurrency limits.
Additional metadata associated with the human review task.
Example:
{ "priority": "high", "source": "api" }