Skip to main content

List Review Items

List review queue items with GET /v1/review. Filter by status and paginate through validation records awaiting human approval or rejection before delivery.

The /v1/review queue is Record Review: record-level human decisions on extracted records flagged during inline validation, before delivery — not ground-truth benchmark results, and distinct from Field Review (/v1/field-reviews), which handles field-level decisions. GET /v1/review lists these items with status filtering and cursor pagination. Items appear when extraction confidence is below the auto-approval threshold or when anomalies are detected.

Each review item points back to its context: run_id identifies the run that produced the record (a Job or a Pipeline run), document_id the source document, and schema_id the schema the record was extracted against. The overall_confidence score shows how certain the extraction was, which is what most reviewers sort or triage by.

Filter with status=pending for the active backlog. Approved and rejected records stay queryable through the same endpoint, so you can also use it for audit trails of past decisions.
  • Filter by status to see only pending, approved, or rejected records
  • Use cursor-based pagination to iterate through large queues
  • Sort by created_at in ascending or descending order
GET/v1/review

Query parameters

limitintegerMaximum number of results to return (1–100). Default: 20
cursorstringPagination cursor from a previous response.
orderstringSort direction by created_at. Default: desc
statusstringFilter by record status (e.g. pending, approved, rejected).

Response

Response fields

dataarrayArray of review record objects.
data[].idstringReview record UUID.
data[].run_idstringUUID of the run (Job or Pipeline run) this record belongs to.
data[].document_idstringUUID of the associated document.
data[].schema_idstring | nullUUID of the schema used for this record.
data[].statusstringRecord status: pending, approved, or rejected.
data[].overall_confidencenumber | nullAggregate confidence score (0–1).
data[].assigned_tostring | nullUUID of the team member assigned to review this record.
data[].reviewed_bystring | nullUUID of the team member who last reviewed.
data[].reviewed_atstring | nullISO 8601 timestamp of the last review action.
data[].created_atstringISO 8601 creation timestamp.
data[].linksobjectRelated resource URLs (self, action).
pagination.totalintegerTotal number of records matching the query.
pagination.limitintegerMaximum results per page.
pagination.has_morebooleanWhether more results exist beyond this page.
pagination.next_cursorstring | nullCursor to fetch the next page. Null if no more results.

Response

{
  "data": [
    {
      "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": "pending",
      "overall_confidence": 0.72,
      "assigned_to": null,
      "reviewed_by": null,
      "reviewed_at": null,
      "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"
      }
    }
  ],
  "pagination": {
    "total": 15,
    "limit": 20,
    "has_more": false,
    "next_cursor": null
  }
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Most integrations poll this endpoint on a schedule to detect new items, then call GET /v1/review/:id to fetch full detail before rendering a review UI. Pair with GET /v1/review/stats to monitor queue depth and set alerting thresholds on the pending count.