API Reference

Extract

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Review

Create Extract Review

client.extract.review.create(stringjobID, ReviewCreateParams { organization_id, project_id, confidence_threshold, 2 more } params?, RequestOptionsoptions?): ExtractReview { id, confidence_threshold, created_at, 16 more }

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

Get Extract Review

client.extract.review.get(stringjobID, ReviewGetParams { organization_id, project_id } query?, RequestOptionsoptions?): ExtractReview { id, confidence_threshold, created_at, 16 more }

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

Change Extract Review Fields

client.extract.review.changeFields(stringjobID, ReviewChangeFieldsParams { changes, revision, organization_id, project_id } params, RequestOptionsoptions?): ExtractReview { id, confidence_threshold, created_at, 16 more }

POST/api/v2/extract/{job_id}/review/fields

Approve Extract Review

client.extract.review.approve(stringjobID, ReviewApproveParams { revision, organization_id, project_id, sign_off } params, RequestOptionsoptions?): ExtractReview { id, confidence_threshold, created_at, 16 more }

POST/api/v2/extract/{job_id}/review/approve

Reject Extract Review

client.extract.review.reject(stringjobID, ReviewRejectParams { reason, revision, organization_id, project_id } params, RequestOptionsoptions?): ExtractReview { id, confidence_threshold, created_at, 16 more }

POST/api/v2/extract/{job_id}/review/reject

Reopen Extract Review

client.extract.review.reopen(stringjobID, ReviewReopenParams { revision, organization_id, project_id } params, RequestOptionsoptions?): ExtractReview { id, confidence_threshold, created_at, 16 more }

POST/api/v2/extract/{job_id}/review/reopen

List Extract Review Events

client.extract.review.listEvents(stringjobID, ReviewListEventsParams { organization_id, page_size, page_token, project_id } query?, RequestOptionsoptions?): PaginatedCursor<ExtractReviewEvent { id, actor_id, created_at, 5 more } >

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

ModelsExpand Collapse

ExtractReview { 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 | null

When it was approved or rejected.

formatdate-time

decided_by: string | null

ID of the user who approved or rejected it.

decided_reason: string | null

Why it was rejected.

field_actions: Record<string, FieldActions>

The latest action per field, keyed by JSON Pointer.

action: "clear" | "confirm" | "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?: unknown

The corrected value, for correct.

fields_in_scope: Array<string>

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

flags: Array<Flag>

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" | "required_empty"

below_threshold, or required_empty for a required field left empty.

One of the following:

"below_threshold"

"required_empty"

cell?: Cell | null

Where in a list the least confident value is.

row: number

Index of the row, from 0.

column?: string | null

Property of the row, when rows are objects.

confidence?: number | null

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

job_id: string

The extract job reviewed.

open_flags: Array<string>

JSON Pointers of flagged fields nobody checked.

original_result: Record<string, unknown> | null

The result as the model read it.

required_fields: Array<string>

JSON Pointers of fields flagged when empty.

retain_until: string

When the job and its document may be deleted.

formatdate-time

reviewed_result: Record<string, unknown>

The result with the field actions.

revision: number

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

source_file_id: string | null

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

status: "approved" | "pending" | "rejected"

pending until approved or rejected.

One of the following:

"approved"

"pending"

"rejected"

updated_at: string

When the review last changed.

formatdate-time

ExtractReviewEvent { id, actor_id, created_at, 5 more }

One entry in a review’s history.

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" | "created" | "field_cleared" | 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?: ExtractReviewCreatedDetail { confidence_threshold, fields_in_scope, origin, required_fields } | ExtractReviewRejectedDetail { reason } | ExtractReviewSignedOffDetail { paths } | null

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

One of the following:

ExtractReviewCreatedDetail { 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<string>

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

origin: "api" | "edit" | "history" | "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<string>

JSON Pointers of fields flagged when empty.

ExtractReviewRejectedDetail { reason }

What a rejected entry records.

reason: string

Why the result was rejected.

ExtractReviewSignedOffDetail { paths }

What a flags_signed_off entry records.

paths: Array<string>

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

path?: string | null

JSON Pointer of the field it changed.

value_after?: unknown

The field’s value after the change.

value_before?: unknown

The field’s value before the change.