API Reference

Extract

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Review

Create Extract Review

ExtractReview Extract.Review.Create(ReviewCreateParamsparameters, CancellationTokencancellationToken = default)

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

Get Extract Review

ExtractReview Extract.Review.Get(ReviewGetParamsparameters, CancellationTokencancellationToken = default)

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

Change Extract Review Fields

ExtractReview Extract.Review.ChangeFields(ReviewChangeFieldsParamsparameters, CancellationTokencancellationToken = default)

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

Approve Extract Review

ExtractReview Extract.Review.Approve(ReviewApproveParamsparameters, CancellationTokencancellationToken = default)

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

Reject Extract Review

ExtractReview Extract.Review.Reject(ReviewRejectParamsparameters, CancellationTokencancellationToken = default)

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

Reopen Extract Review

ExtractReview Extract.Review.Reopen(ReviewReopenParamsparameters, CancellationTokencancellationToken = default)

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

List Extract Review Events

ReviewListEventsPageResponse Extract.Review.ListEvents(ReviewListEventsParamsparameters, CancellationTokencancellationToken = default)

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

ModelsExpand Collapse

class ExtractReview:

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

required string ID

Unique identifier of the review.

required Double ConfidenceThreshold

Fields read below this confidence are flagged.

required DateTimeOffset CreatedAt

When review was turned on.

formatdate-time

required DateTimeOffset? DecidedAt

When it was approved or rejected.

formatdate-time

required string? DecidedBy

ID of the user who approved or rejected it.

required string? DecidedReason

Why it was rejected.

required IReadOnlyDictionary<string, FieldActionsItem> FieldActions

The latest action per field, keyed by JSON Pointer.

required Action Action

confirm, correct or clear.

One of the following:

"clear"Clear

"confirm"Confirm

"correct"Correct

required string ActorID

ID of the user who acted.

required DateTimeOffset At

When they acted.

formatdate-time

JsonElement Value

The corrected value, for correct.

required IReadOnlyList<string> FieldsInScope

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

required IReadOnlyList<Flag> Flags

Fields the review asks a person to check.

required Boolean Handled

Whether someone confirmed, corrected or cleared it.

required string Path

JSON Pointer of the field.

required Reason Reason

below_threshold, or required_empty for a required field left empty.

One of the following:

"below_threshold"BelowThreshold

"required_empty"RequiredEmpty

Cell? Cell

Where in a list the least confident value is.

required Long Row

Index of the row, from 0.

string? Column

Property of the row, when rows are objects.

Double? Confidence

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

required string JobID

The extract job reviewed.

required IReadOnlyList<string> OpenFlags

JSON Pointers of flagged fields nobody checked.

required IReadOnlyDictionary<string, JsonElement>? OriginalResult

The result as the model read it.

required IReadOnlyList<string> RequiredFields

JSON Pointers of fields flagged when empty.

required DateTimeOffset RetainUntil

When the job and its document may be deleted.

formatdate-time

required IReadOnlyDictionary<string, JsonElement> ReviewedResult

The result with the field actions.

required Long Revision

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

required string? SourceFileID

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

required Status Status

pending until approved or rejected.

One of the following:

"approved"Approved

"pending"Pending

"rejected"Rejected

required DateTimeOffset UpdatedAt

When the review last changed.

formatdate-time

class ExtractReviewEvent:

One entry in a review’s history.

required string ID

Unique identifier of the entry.

required string ActorID

ID of the user who acted.

required DateTimeOffset CreatedAt

When it happened.

formatdate-time

required Kind Kind

What happened.

One of the following:

"approved"Approved

"created"Created

"field_cleared"FieldCleared

"field_confirmed"FieldConfirmed

"field_corrected"FieldCorrected

"field_restored"FieldRestored

"field_undone"FieldUndone

"flags_signed_off"FlagsSignedOff

"rejected"Rejected

"reopened"Reopened

Detail? Detail

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

One of the following:

class ExtractReviewCreatedDetail:

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

required Double ConfidenceThreshold

Fields read below this confidence are flagged.

required IReadOnlyList<string> FieldsInScope

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

required Origin Origin

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

One of the following:

"api"Api

"edit"Edit

"history"History

"run"Run

required IReadOnlyList<string> RequiredFields

JSON Pointers of fields flagged when empty.

class ExtractReviewRejectedDetail:

What a rejected entry records.

required string Reason

Why the result was rejected.

class ExtractReviewSignedOffDetail:

What a flags_signed_off entry records.

required IReadOnlyList<string> Paths

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

string? Path

JSON Pointer of the field it changed.

JsonElement ValueAfter

The field’s value after the change.

JsonElement ValueBefore

The field’s value before the change.