Document Extraction API

This API enables users to analyze images and PDFs through file uploads or by fetching documents from URLs. It provides a comprehensive analysis of the documents, returning back a structured JSON data that includes key-value pairs, tabular data, document classification, and extracted text.

docyFi README.md

Welcome to the docyFi API !

This API enables users to analyze images and PDFs through file uploads or by fetching documents from URLs. It provides a comprehensive analysis of the documents, returning structured JSON data that includes key-value pairs, tabular data, document classification, and extracted text.

Below are some quick examples.

Passport Scan

Invoice Scan

Receipt Scan

Text Scan

API Endpoints

The DocyFi API offers two primary methods for document analysis:

> upload_file: Upload a document directly from your local file system.

> upload_url: Fetch and analyze a document from a specified URL.

For detailed documentation on the API, including request formats and response structures, please visit our OpenAPI documentation: DocyFi API Documentation.

Features

The API provides the following capabilities:

Key-Value Pair Extraction: Automatically identifies and extracts important data points from the document.

Tabular Data Extraction: Detects and returns tables in a structured format, allowing for easy data manipulation.

Document Classification: Classifies documents into predefined categories such as Invoice, Receipt, Passport, Voucher, etc.

Text Extraction: Extracts text at various levels (paragraphs, lines, etc.) for further processing or analysis.

Use Cases

The DocyFi API can be leveraged across a variety of industries, including but not limited to:

#1. Finance and Accounting

  • Invoice Processing: Automate the extraction of key details from invoices to streamline accounts payable workflows.
  • Receipt Management: Capture and categorize expenses from receipts for efficient expense reporting.

#2. Legal and Compliance

  • Document Classification: Automatically classify legal documents for better organization and retrieval.
  • Contract Analysis: Extract critical clauses and terms from contracts for compliance checks.

#3. E-commerce

  • Product Documentation: Analyze product manuals or specifications to enhance customer support.
  • Order Confirmation Processing: Streamline the extraction of order details from confirmation documents.

#4. Healthcare

  • Patient Records Management: Extract and classify patient information from scanned documents or PDFs.
  • Insurance Claims Processing: Automate the extraction of data from insurance claim forms for quicker processing.

#5. Education

  • Transcript and Report Card Analysis: Extract grades and key information from student transcripts and report cards.
  • Research Document Review: Analyze academic papers to extract key findings and data points.

Getting Started

To start using the DocyFi API, you’ll need to sign up for a Rapid API key. Once you have your key, you can begin making requests to analyze your documents.

Example Request - Upload File

curl --request POST \

--url https://{API-PROVIDER}.com/upload_file/ \

--header 'accept: application/json; content-type: multipart/form-data' \

--form 'file=@receipt_sample.pdf;type=application/pdf'

 

Example Request - Upload URL

curl --request POST \

--url https://{API-PROVIDER}.com/upload_url/ \

--header 'Content-Type: application/json' \

--data '{ "url": "https://www.example.com/invoice-sample.jpg"}'



Conclusion

The DocyFi API is a powerful tool for extracting and analyzing data from various document types, enabling businesses to enhance productivity and streamline operations. For more information, visit our API Documentation or contact our support team.

API Documentation

Endpoints


Perform Basic Liveliness check



                                                                            
GET https://zylalabs.com/api/5351/document+extraction+api/6911/health+check
                                                                            
                                                                        

Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            {"status":"healthy","value":"200","uptime":"7 days, 5:27:10.668545","dependencies":{"database":"ok"}}
                                                                                                                                                                                                                    
                                                                                                    

Health Check - CODE SNIPPETS


curl --location --request GET 'https://zylalabs.com/api/5351/document+extraction+api/6911/health+check' --header 'Authorization: Bearer YOUR_API_KEY' 

    

Fetch and analyze a document from a specified URL.



                                                                            
POST https://zylalabs.com/api/5351/document+extraction+api/6912/upload+url
                                                                            
                                                                        

Upload URL - Endpoint Features

Object Description
Request Body [Required] Json
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            {"classification":{"documentType":"OTHERS"},"keyValuePairs":{"message":"no data found"},"lineItems":{"message":"no data found"},"tabularData":{"Table 1":{"header":[],"rows":[["Books are a","source","of informat"],["great to their readers.","and knowledge considered","Reading"],["books is it","a good","habit as"],["increases our","knowledge and","wisdom"]]}},"textData":{"words":"My Book Books are a great source of informat and knowledge to their readers. Reading books is considered a good habit as it increases our knowledge and wisdom Books give us the insight to expand our thinking capacity and enhance our"}}
                                                                                                                                                                                                                    
                                                                                                    

Upload URL - CODE SNIPPETS


curl --location --request POST 'https://zylalabs.com/api/5351/document+extraction+api/6912/upload+url' --header 'Authorization: Bearer YOUR_API_KEY' 
--data-raw '{ "url":"https://i.ytimg.com/vi/xl1vbqPqEvs/maxresdefault.jpg" }'

    

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 Document Extraction 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

Just mail to [email protected] and you will be provided instant support

Make sure the request matches all the parameter. There are size limitation of 5MB per file, also certain extensions can be problematic for image (ex HEIC, WEBP ). Make sure the file format is correct Below are some examples to make request Example Request - Upload File curl --request POST \ --url https://{API-PROVIDER}.com/upload_file/ \ --header 'accept: application/json; content-type: multipart/form-data' \ --form 'file=@receipt_sample.pdf;type=application/pdf' Example Request - Upload URL curl --request POST \ --url https://{API-PROVIDER}.com/upload_url/ \ --header 'Content-Type: application/json' \ --data '{ "url": "https://www.example.com/invoice-sample.jpg"}'

Depends on the compute resources and amount of subscriptions. Currently, the resources are limited and rate limit is set to 1000. The more support we get from this platform will help to scale our resources

Yes, for any business queries contact [email protected]

Depends on the learning algorithm, these program are trained on limited datasets. The more it learns, the perfect it gets. If you have customized document format, accuracy can be increased to 99.99% as personalized API

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, look at the β€˜X-Zyla-API-Calls-Monthly-Remaining’ header. For example, if your plan allows 1000 requests per month and you've used 100, this header will show 900.

To see the maximum number of API requests your plan allows, check the β€˜X-Zyla-RateLimit-Limit’ header. For instance, if your plan includes 1000 requests per month, this header will display 1000.

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 3600, it means 3600 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 let you experience our APIs without any commitment, we offer a 7-day free trial that allows you to make API calls at no cost during this period. Please note that you can only use this trial once, so make sure to use it with the API that interests you the most. Most of our APIs provide a free trial, but some may not support it.

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 trial, you can make only 25% of the calls allowed by that plan. For example, if the API plan offers 1000 calls, you can make only 250 during the trial. To access the full number of calls offered by the plan, you will need to subscribe to the full plan.

 Service Level
100%
 Response Time
1,577ms

Category:

OCR

Related APIs