Field Detection

Get field detection job status

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

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/documents/{documentId}/field-detection/status
  • 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

Job ID

documentIdstring

Document ID (if detecting for a document)

templateIdstring

Template ID (if detecting for a template)

status'queued' | 'ocr_processing' | 'ai_processing' | 'completed' | 'failed' required

Current status of the field detection job

ocrProcessingMsnumber

OCR processing time in milliseconds

aiProcessingMsnumber

AI processing time in milliseconds

proposedFieldCountnumber

Number of proposed fields detected

errorMessagestring

Error message if job failed

createdAtstring date-time required

Job creation timestamp

updatedAtstring date-time required

Job last update timestamp

Changes

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