Optical Character Recognition API

With this API you can extract any text from any image you have. Just pass the URL image and receive the text within it!

About the API:

This API is an OCR (Optical Character Recognition) tool. Any picture you pass to it will be examined and extract every word within it.

What this API receives and what your API provides (input/output)?

You will need to pass the image URL of your choice. And you will be delivered the text content that it has. It's a very intuitive API and you will be amazed by the results. 

What are the most common uses cases of this API?

This API is ideal for those companies that have stored a lot of images and want to retrieve the text that they contain. This will help you to recognize if your brand is being used in images across the web without authorization. 

Also, this API will help to categorize those images with text. Thanks to character recognition, you will be delivered with the full words and you will be able to detect the category of the image just by reading its text. 

Are there any limitations with your plans?

Besides API call limitations per month, all the plans work the same!

API Documentation

Endpoints


With this endpoint, you will be receiving the text within the image you pass to it. 

Just with the image URL, you will be able to extract all the text in JSON format. 

 

The image must be a regular JPEG or PNG image (with or without transparency). Usually, such images have extensions: .jpg.jpeg.png. The service checks input files by MIME type and accepts the following types:

  • image/jpeg
  • image/png

The size of the image file must be less than 16Mb



                                                                            
POST https://zylalabs.com/api/37/optical+character+recognition+api/108/image+analysis
                                                                            
                                                                        

Image Analysis - Endpoint Features

Object Description
url [Required] The URL of the image you want to extract the text from. Remember that only JPG, JPEG and PNG are supported.
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            {"results":[{"status":{"code":"ok","message":"Success"},"name":"https://file.io/GiqYoEWsoy9i","md5":"d4438cf64b5544dc22854b6585d8c398","width":2160,"height":3840,"entities":[{"kind":"objects","name":"text","objects":[{"box":[0.11990740740740741,0.019010416666666665,0.8467592592592592,0.89453125],"entities":[{"kind":"text","name":"text","text":"تحديات تؤثر على خدمة الذكاء الاصطناعى للغة العربية - التشكيل\nC\n00\nه استخدام القرآن الكريم\nيعتبر القرآن الكريم أكبر\nمصدر للغة العربية ولكن\nيصعب في بعض الأحيان\nاستخدامه في تدريب نماذج\nالذكاء الاصطناعي لتجنب\nتحريف المعنى. هناك بعض\nالنماذج التي تم تدريبها\nعلى القرآن الكريم، ولكن لم\nتزل هناك حاجة للمزيد من\nالجهود في هذا المجال.\nقه الكتابة من اليمين إلى اليسار\nتكتب اللغة العربية من اليمين إلى اليسار، وهذا يشكل تحديا في تطوير\nنماذج الذكاء الاصطناعي القادرة على الفهم والتعامل مع هذا النوع\nمن اللغات، مع أن هناك بعض النماذج التى تم تدريبها على الكتابة\nمن اليمين إلى اليسار، ولكن لم تزل هناك تحسينات مطلوبة لجعلها\nأكثر قبولاً وفعالية.\nوم الأرقام العربية\n09\nولّدت الأرقام العربية على أنها أرقام إنجليزية، فالرقم . (صفر) من\nالصعب توليده في الذكاء الاصطناعي، إذ يعتقد أنه عبارة عن نقطة."}]}]}]}]}
                                                                                                                                                                                                                    
                                                                                                    

Image Analysis - CODE SNIPPETS


curl --location --request POST 'https://zylalabs.com/api/37/optical+character+recognition+api/108/image+analysis?url=https://storage.googleapis.com/api4ai-static/samples/ocr-1.png' --header 'Authorization: Bearer YOUR_API_KEY' 


    

To use this endpoint the image must be a normal JPEG or PNG image (with or without transparency). Normally these images have the extensions: .jpg, .jpeg, .png. The service checks the input file by MIME type and accepts the following types:

image/jpeg
image/png
The size of the image file must be less than 16 Mb.



                                                                            
POST https://zylalabs.com/api/37/optical+character+recognition+api/1679/image+analysis+with+file
                                                                            
                                                                        

Image Analysis with file - Endpoint Features

Object Description
Request Body [Required] File Binary
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            {"results":[{"status":{"code":"ok","message":"Success"},"name":"https://gopostr.s3.amazonaws.com/binary_file_test_1679/tEMRXL7fQiIgoCXMcQ7UUWHcyqtYa4IeTb1NoAyt.jpg","md5":"f556d7e2b92037ea8b6af4d731597f1d","width":464,"height":479,"entities":[{"kind":"objects","name":"text","objects":[{"box":[0.4547413793103448,0.6868475991649269,0.44396551724137934,0.16075156576200417],"entities":[{"kind":"text","name":"text","text":"10\nAFA\nSAVE THE\nPLONET"}]}]}]}]}
                                                                                                                                                                                                                    
                                                                                                    

Image Analysis with file - CODE SNIPPETS


    curl --location 'https://zylalabs.com/api/37/optical+character+recognition+api/1679/image+analysis+with+file' \
    --header 'Content-Type: application/x-www-form-urlencoded' \ 
    --form 'image=@"FILE_PATH"'


API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Optical Character Recognition API REST API, simply include your bearer token in the Authorization header.
Headers
Header Description
Authorization [Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

Simple Transparent Pricing

No long term commitments. One click upgrade/downgrade or cancellation. No questions asked.

🚀 Enterprise

Starts at
$ 10,000/Year


  • Custom Volume
  • Specialized Customer Support
  • Real-Time API Monitoring

Customer favorite features

  • ✔︎ Only Pay for Successful Requests
  • ✔︎ Free 7-Day Trial
  • ✔︎ Multi-Language Support
  • ✔︎ One API Key, All APIs.
  • ✔︎ Intuitive Dashboard
  • ✔︎ Comprehensive Error Handling
  • ✔︎ Developer-Friendly Docs
  • ✔︎ Postman Integration
  • ✔︎ Secure HTTPS Connections
  • ✔︎ Reliable Uptime

Each endpoint returns extracted text from the provided image in JSON format. The response includes details such as the status of the request, the image URL, dimensions, and the recognized text along with its bounding box coordinates.

Key fields in the response include "status" (indicating success or failure), "name" (image URL), "width" and "height" (dimensions), and "entities" (which contains the recognized text and its position in the image).

The response data is structured as a JSON object containing a "results" array. Each result includes metadata about the image and an "entities" array that details the recognized text and its bounding box coordinates.

Each endpoint provides information about the text extracted from images, including the recognized words, their positions, and the overall dimensions of the image. This can be useful for text analysis and categorization.

Typical use cases include digitizing printed documents, monitoring brand usage in images, and categorizing images based on the text they contain. Businesses can leverage this data for content management and compliance.

Users can utilize the returned data by parsing the JSON response to extract the recognized text and its coordinates. This information can be used for further analysis, indexing, or integrating into applications for enhanced functionality.

The endpoints accept a single parameter: the image URL or the image file itself. The image must be in JPEG or PNG format and less than 16 MB in size. Ensure the MIME type matches the accepted formats for successful processing.

Data accuracy is maintained through the use of advanced OCR algorithms that analyze the image content. The API is designed to handle various text styles and layouts, ensuring reliable text extraction from diverse image sources.

Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world’s most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.

The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.

Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]

Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.

API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.

Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.

To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.

To check how many API calls you have left for the current month, refer to the ‘X-Zyla-API-Calls-Monthly-Remaining’ field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

To see the maximum number of API requests your plan allows, check the ‘X-Zyla-RateLimit-Limit’ response header. For instance, if your plan includes 1,000 requests per month, this header will display 1,000.

The ‘X-Zyla-RateLimit-Reset’ header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.

Yes, you can cancel your plan anytime by going to your account and selecting the cancellation option on the Billing page. Please note that upgrades, downgrades, and cancellations take effect immediately. Additionally, upon cancellation, you will no longer have access to the service, even if you have remaining calls left in your quota.

You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

To give you the opportunity to experience our APIs without any commitment, we offer a 7-day free trial that allows you to make up to 50 API calls at no cost. This trial can be used only once, so we recommend applying it to the API that interests you the most. While most of our APIs offer a free trial, some may not. The trial concludes after 7 days or once you've made 50 requests, whichever occurs first. If you reach the 50 request limit during the trial, you will need to "Start Your Paid Plan" to continue making requests. You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab. Alternatively, if you don't cancel your subscription before the 7th day, your free trial will end, and your plan will automatically be billed, granting you access to all the API calls specified in your plan. Please keep this in mind to avoid unwanted charges.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it’s important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.

When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.


Related APIs