OCR

OCR

from aibrary import AiBrary
aibrary = AiBrary()
# 1
aibrary.ocr(
    providers="google",
    file=open("tests/assets/ocr-test.jpg", "rb").read(),
    file_name="test.jpg",
)
# 2
aibrary.ocr(
    providers="google",
    file_url="https://builtin.com/sites/www.builtin.com/files/styles/ckeditor_optimize/public/inline-images/5_python-ocr.jpg",
)
# 3
aibrary.ocr(
    providers="google", file="tests/assets/ocr-test.jpg"
)

Receive Ocr Request

post

Authorizations

Body

providersstringrequired

settingsany ofoptional

response_as_dictbooleanoptionalDefault: true

attributes_as_listbooleanoptionalDefault: false

show_base_64booleanoptionalDefault: true

show_original_responsebooleanoptionalDefault: false

filestring · binaryoptional

file_urlany ofoptional

file_passwordany ofoptional

languageany ofoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.aibrary.dev/v0/ocr/ocr' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: multipart/form-data' \
  --form 'providers=text' \
  --form 'settings=text' \
  --form 'response_as_dict=true' \
  --form 'attributes_as_list=true' \
  --form 'show_base_64=true' \
  --form 'show_original_response=true' \
  --form 'file=binary' \
  --form 'file_url=text' \
  --form 'file_password=text' \
  --form 'language=text'

200

422

200

{
  "text": "text",
  "bounding_boxes": [
    {
      "text": "text",
      "left": 1,
      "top": 1,
      "width": 1,
      "height": 1
    }
  ],
  "status": "text"
}

Successful Response