Review Action
Take an action on a review item: approve, reject, or flag. Optionally include a comment explaining the decision for audit purposes.
POST
/v1/review/:id/actionResponse
Response fields
idstringReview record UUID.
run_idstringUUID of the structuring run.
document_idstringUUID of the associated document.
schema_idstring | nullUUID of the schema used.
statusstringUpdated record status: approved or rejected.
overall_confidencenumber | nullAggregate confidence score (0–1).
assigned_tostring | nullUUID of the assigned reviewer.
reviewed_bystring | nullUUID of the team member who actioned the record.
reviewed_atstring | nullISO 8601 timestamp of the review action.
created_atstringISO 8601 creation timestamp.
linksobjectRelated resource URLs (self, action).
Response
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"document_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"schema_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"status": "approved",
"overall_confidence": 0.72,
"assigned_to": null,
"reviewed_by": null,
"reviewed_at": "2024-10-12T10:30:00.000Z",
"created_at": "2024-10-12T09:00:00.000Z",
"links": {
"self": "/v1/review/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"action": "/v1/review/a1b2c3d4-e5f6-7890-abcd-ef1234567890/action"
}
}Errors
Error responses
401unauthorizedMissing or invalid API key.
404not_foundReview record not found or does not belong to your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.