Complete a human review task
Complete a human review task.
Marks the task as completed and records the review results. This endpoint:
- Updates task status to ‘completed’
- Records the review result (correct/incorrect) and reviewed output
- Sets completed_by and completed_at fields
- Removes the in-progress record for the user
- Returns 404 if task not found
- Returns 400 if task status is not ‘in_progress’
Context:
- Only authenticated users can complete tasks
- Task must be in ‘in_progress’ status
- Records who completed the task and when
- Automatically removes in-progress tracking
Use Cases:
- User finishes reviewing a task and submits their results
- Record validation outcomes for data quality tracking
- Complete workflow steps requiring human judgment
Related Endpoints:
- POST /human-review-tasks//start - Start working on a task
- GET /human-review-tasks - List all assigned tasks
Authorizations
API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY
Example:
JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN
Example:
Path Parameters
Body
Response
Human review task completed successfully
Response model for human review task operations.
UUID of the flow execution this task is associated with.
"550e8400-e29b-41d4-a716-446655440000"
UUID of the organization this task belongs to.
"550e8400-e29b-41d4-a716-446655440000"
Index of the source task execution that created this review.
0
Name of the source task that created this review.
"process_document"
Status of the task. Valid values: 'pending', 'in_progress', 'completed'.
"pending"
Index of the target task execution.
0
Name of the target task being reviewed.
"receive_file"
Timestamp when the task was completed. Null for not completed tasks.
"2024-01-01T00:00:00Z"
UUID of the user who completed this task. Null for not completed tasks.
"550e8400-e29b-41d4-a716-446655440000"
Instructions for the human reviewer on how to complete this task.
"Please review the document and verify all dates are correct."
Review result: True for correct, False for incorrect, null for not yet finished.
true
JSON output of the completed review. Null for not yet completed tasks.
Additional metadata associated with the human review task.