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
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:
Body
Request payload for creating a new human review task.
List of user UUIDs to assign to this task.
UUID of the flow execution this task is associated with.
"550e8400-e29b-41d4-a716-446655440000"
Index of the source task execution.
0
Name of the source task that created this review.
"process_document"
Index of the target task execution.
0
Name of the target task being reviewed.
"receive_file"
Instructions for the human reviewer on how to complete this task.
"Please review the document and verify all dates are correct."
Response
Human review task created 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.