Sign in
Assets

Retrieve asset OCR data

Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.

get/assets/{id}/ocr

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/assets/{id}/ocr
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Path parameters

idstring uuid required

Response

assetIdstring uuid required
boxScorenumber double required

Confidence score for text detection box

idstring uuid required
textstring required

Recognized text

textScorenumber double required

Confidence score for text recognition

x1number double required

Normalized x coordinate of box corner 1 (0-1)

x2number double required

Normalized x coordinate of box corner 2 (0-1)

x3number double required

Normalized x coordinate of box corner 3 (0-1)

x4number double required

Normalized x coordinate of box corner 4 (0-1)

y1number double required

Normalized y coordinate of box corner 1 (0-1)

y2number double required

Normalized y coordinate of box corner 2 (0-1)

y3number double required

Normalized y coordinate of box corner 3 (0-1)

y4number double required

Normalized y coordinate of box corner 4 (0-1)

Changes

No recorded changes to this operation across all 50 revisions of this API.