Field Detection

Get proposed fields from AI detection

get/api/v1/documents/{documentId}/field-detection/proposed

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/documents/{documentId}/field-detection/proposed
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Path parameters

documentIdstring required

Response

idstring required

Proposed field ID

documentIdstring

Document ID (if detecting for a document)

templateIdstring

Template ID (if detecting for a template)

jobIdstring required

Parent job ID

fieldType'signature' | 'initials' | 'date' | 'text' | 'checkbox' | 'dropdown' | 'radio' required
pageNumbernumber required

Page number where field was detected

xPositionnumber required

X position in PDF coordinates

yPositionnumber required

Y position in PDF coordinates

widthnumber required

Field width in PDF coordinates

heightnumber required

Field height in PDF coordinates

confidencenumber required

Confidence score 0-100

detectionReasonstring

Reason for detection

contextTextstring

Surrounding text context

acroFieldNamestring

Embedded AcroForm field this proposal came from (fillable PDFs). Accepted fields keep the link, so values fill the PDF form field at completion.

acroOptionValuestring

For radio-group AcroForm fields: the option this proposal selects.

optionsstring[]

Allowed values for dropdown fields

maxLengthnumber

Character limit read from the embedded form field (comb boxes)

groupKeystring

Semantic group key (radio options share the AcroForm field name); members are mutually exclusive when accepted

fontSizenumber

Point size the embedded form field draws its value at; absent when the form auto-sizes the text

textColorstring

Text color of the embedded form field, as #rrggbb

textAlign'left' | 'center' | 'right'

Horizontal alignment of the value inside the field box

fontFamilystring

Base font the embedded form field draws its value in

multilineboolean

Whether the embedded form field is multiline

status'pending' | 'accepted' | 'rejected' | 'modified' required

Review status of the proposed field

acceptedFieldIdstring

ID of the accepted field (if accepted)

reviewedAtstring date-time

When the field was reviewed

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Example response

[
  {
    "fontSize": 9,
    "textColor": "#000080",
    "fontFamily": "Helvetica-Bold"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.