Skip to main content
POST
Complete a human review task

Authorizations

X-API-Key
string
header
required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

Authorization
string
header
required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Path Parameters

task_id
string
required

Body

application/json

Request payload for completing a human review task.

review_result
boolean
required

Review result: True for correct, False for incorrect.

Example:

true

reviewed_output
Reviewed Output · object
required

JSON output of the completed review.

Example:

Response

Human review task completed successfully

Response model for human review task operations.

created_at
string<date-time>
required
flow_execution_id
string<uuid>
required

UUID of the flow execution this task is associated with.

Example:

"550e8400-e29b-41d4-a716-446655440000"

id
string<uuid>
required
modified_by
string
required
organization_id
string<uuid>
required

UUID of the organization this task belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

source_task_execution_idx
integer
required

Index of the source task execution that created this review.

Example:

0

source_task_name
string
required

Name of the source task that created this review.

Example:

"process_document"

status
string
required

Status of the task. Valid values: 'pending', 'in_progress', 'completed'.

Example:

"pending"

target_task_execution_idx
integer
required

Index of the target task execution.

Example:

0

target_task_name
string
required

Name of the target task being reviewed.

Example:

"receive_file"

updated_at
string<date-time>
required
completed_at
string<date-time> | null

Timestamp when the task was completed. Null for not completed tasks.

Example:

"2024-01-01T00:00:00Z"

completed_by
string<uuid> | null

UUID of the user who completed this task. Null for not completed tasks.

Example:

"550e8400-e29b-41d4-a716-446655440000"

instructions
string | null

Instructions for the human reviewer on how to complete this task.

Example:

"Please review the document and verify all dates are correct."

review_result
boolean | null

Review result: True for correct, False for incorrect, null for not yet finished.

Example:

true

reviewed_output
Reviewed Output · object | null

JSON output of the completed review. Null for not yet completed tasks.

Example:
task_metadata
Task Metadata · object | null

Additional metadata associated with the human review task.

Example: