CAcasemark
OCR

Get OCR job status

Changed on

Retrieve the status and results of an OCR job. Returns job progress and metadata; full extracted text is included only when include_text=true.

get/ocr/v1/{id}

Request

  • Base URL
    https://api.case.dev
  • URL
    https://api.case.dev/ocr/v1/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The OCR job ID returned from the create OCR endpoint

Query parameters

include_text'true' | 'false'

Include full OCR text in completed responses (default: false)

Response

OCR job status and results

idstring required

OCR job ID

status'pending' | 'processing' | 'completed' | 'failed' required

Current job status

errorstring nullable

Safe human-readable failure message; null when no failure is recorded.

error_codestring nullable

Stable failure identifier, such as source_access_denied, invalid_pdf, inference_failed, chunks_failed, or result_upload_failed. Historic failures may be unclassified.

error_stage'dispatch' | 'download' | 'document_validation' | 'chunking' | 'engine_init' | 'inference' | 'feature_processing' | 'result_write' | 'chunk_processing' | 'result_assembly' | 'result_upload' nullable

Operation that failed.

retryableboolean nullable

Whether retrying the same document may help. Unknown failures retain bounded retry behavior.

chunks_failedinteger

Exact number of failed OCR chunks.

chunk_countinteger

Total number of OCR chunks.

page_countinteger

Number of pages processed

textstring

Extracted text content when completed and include_text=true

metadataobject

Additional processing metadata

created_atstring date-time required

Job creation timestamp

completed_atstring date-time

Job completion timestamp

Changes

  • a21d188f4b21Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 8f8746486442Revision changes
    • info

      added the new optional query request parameter include_text