API Reference

Extract

Review

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Extract Review

GET/api/v2/extract/{job_id}/review

Beta: answers 403 until extract review is enabled for the caller and their organization.

Get an extract job’s review: its flags, field actions and decision, with the result as the model read it and as reviewed. A job without a review answers 404.

Path ParametersExpand Collapse

job_id: string

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

ExtractReview object { id, confidence_threshold, created_at, 16 more }

An extract job’s review: its settings, flags, field actions and decision, with the result as read and as reviewed.

id: string

Unique identifier of the review.

confidence_threshold: number

Fields read below this confidence are flagged.

created_at: string

When review was turned on.

formatdate-time

decided_at: string

When it was approved or rejected.

formatdate-time

decided_by: string

ID of the user who approved or rejected it.

decided_reason: string

Why it was rejected.

field_actions: map[object { action, actor_id, at, value } ]

The latest action per field, keyed by JSON Pointer.

action: "clear" or "confirm" or "correct"

confirm, correct or clear.

One of the following:

"clear"

"confirm"

"correct"

actor_id: string

ID of the user who acted.

at: string

When they acted.

formatdate-time

value: optional unknown

The corrected value, for correct.

fields_in_scope: array of string

JSON Pointers of the fields the threshold applies to; empty means all.

flags: array of object { handled, path, reason, 2 more }

Fields the review asks a person to check.

handled: boolean

Whether someone confirmed, corrected or cleared it.

path: string

JSON Pointer of the field.

reason: "below_threshold" or "required_empty"

below_threshold, or required_empty for a required field left empty.

One of the following:

"below_threshold"

"required_empty"

cell: optional object { row, column }

Where in a list the least confident value is.

row: number

Index of the row, from 0.

column: optional string

Property of the row, when rows are objects.

confidence: optional number

The field’s confidence; for a list, its least confident value.

job_id: string

The extract job reviewed.

open_flags: array of string

JSON Pointers of flagged fields nobody checked.

original_result: map[unknown]

The result as the model read it.

required_fields: array of string

JSON Pointers of fields flagged when empty.

retain_until: string

When the job and its document may be deleted.

formatdate-time

reviewed_result: map[unknown]

The result with the field actions.

revision: number

Bumped by every change; actions name the one they saw.

source_file_id: string

The file the job read, or the file behind the parse job it read; null for a URL.

status: "approved" or "pending" or "rejected"

pending until approved or rejected.

One of the following:

"approved"

"pending"

"rejected"

updated_at: string

When the review last changed.

formatdate-time

Get Extract Review

HTTP

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

curl https://api.cloud.llamaindex.ai/api/v2/extract/$JOB_ID/review \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

200 example

{
  "id": "id",
  "confidence_threshold": 0,
  "created_at": "2019-12-27T18:11:19.117Z",
  "decided_at": "2019-12-27T18:11:19.117Z",
  "decided_by": "decided_by",
  "decided_reason": "decided_reason",
  "field_actions": {
    "foo": {
      "action": "clear",
      "actor_id": "actor_id",
      "at": "2019-12-27T18:11:19.117Z",
      "value": {}
    }
  },
  "fields_in_scope": [
    "string"
  ],
  "flags": [
    {
      "handled": true,
      "path": "path",
      "reason": "below_threshold",
      "cell": {
        "row": 0,
        "column": "column"
      },
      "confidence": 0
    }
  ],
  "job_id": "job_id",
  "open_flags": [
    "string"
  ],
  "original_result": {
    "foo": "bar"
  },
  "required_fields": [
    "string"
  ],
  "retain_until": "2019-12-27T18:11:19.117Z",
  "reviewed_result": {
    "foo": "bar"
  },
  "revision": 0,
  "source_file_id": "source_file_id",
  "status": "approved",
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

200 example

{
  "id": "id",
  "confidence_threshold": 0,
  "created_at": "2019-12-27T18:11:19.117Z",
  "decided_at": "2019-12-27T18:11:19.117Z",
  "decided_by": "decided_by",
  "decided_reason": "decided_reason",
  "field_actions": {
    "foo": {
      "action": "clear",
      "actor_id": "actor_id",
      "at": "2019-12-27T18:11:19.117Z",
      "value": {}
    }
  },
  "fields_in_scope": [
    "string"
  ],
  "flags": [
    {
      "handled": true,
      "path": "path",
      "reason": "below_threshold",
      "cell": {
        "row": 0,
        "column": "column"
      },
      "confidence": 0
    }
  ],
  "job_id": "job_id",
  "open_flags": [
    "string"
  ],
  "original_result": {
    "foo": "bar"
  },
  "required_fields": [
    "string"
  ],
  "retain_until": "2019-12-27T18:11:19.117Z",
  "reviewed_result": {
    "foo": "bar"
  },
  "revision": 0,
  "source_file_id": "source_file_id",
  "status": "approved",
  "updated_at": "2019-12-27T18:11:19.117Z"
}