API Reference

Extract

Review

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Extract Review Events

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

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

List a review’s history, newest first.

Path ParametersExpand Collapse

job_id: string

Query ParametersExpand Collapse

organization_id: optional string

page_size: optional number

Events per page.

maximum200

minimum1

page_token: optional string

Token from the previous page.

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

items: array of ExtractReviewEvent { id, actor_id, created_at, 5 more }

The list of items.

id: string

Unique identifier of the entry.

actor_id: string

ID of the user who acted.

created_at: string

When it happened.

formatdate-time

kind: "approved" or "created" or "field_cleared" or 7 more

What happened.

One of the following:

"approved"

"created"

"field_cleared"

"field_confirmed"

"field_corrected"

"field_restored"

"field_undone"

"flags_signed_off"

"rejected"

"reopened"

detail: optional object { confidence_threshold, fields_in_scope, origin, required_fields } or object { reason } or object { paths }

The settings for created, the reason for rejected, and the fields for flags_signed_off; null for the rest.

One of the following:

ExtractReviewCreatedDetail object { confidence_threshold, fields_in_scope, origin, required_fields }

What a created entry records: where review was turned on, and its settings.

confidence_threshold: number

Fields read below this confidence are flagged.

fields_in_scope: array of string

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

origin: "api" or "edit" or "history" or "run"

Turned on as the job ran, from History, by a first edit, or by the API.

One of the following:

"api"

"edit"

"history"

"run"

required_fields: array of string

JSON Pointers of fields flagged when empty.

ExtractReviewRejectedDetail object { reason }

What a rejected entry records.

reason: string

Why the result was rejected.

ExtractReviewSignedOffDetail object { paths }

What a flags_signed_off entry records.

paths: array of string

JSON Pointers of the flagged fields confirmed as part of approving.

path: optional string

JSON Pointer of the field it changed.

value_after: optional unknown

The field’s value after the change.

value_before: optional unknown

The field’s value before the change.

next_page_token: optional string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_size: optional number

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

List Extract Review Events

HTTP

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

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

200 example

{
  "items": [
    {
      "id": "id",
      "actor_id": "actor_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "kind": "approved",
      "detail": {
        "confidence_threshold": 0,
        "fields_in_scope": [
          "string"
        ],
        "origin": "api",
        "required_fields": [
          "string"
        ]
      },
      "path": "path",
      "value_after": {},
      "value_before": {}
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

200 example

{
  "items": [
    {
      "id": "id",
      "actor_id": "actor_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "kind": "approved",
      "detail": {
        "confidence_threshold": 0,
        "fields_in_scope": [
          "string"
        ],
        "origin": "api",
        "required_fields": [
          "string"
        ]
      },
      "path": "path",
      "value_after": {},
      "value_before": {}
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}