Elevate your data handling capabilities with Extracta.ai's Document Data Extraction API. Our cutting-edge solution empowers your systems to automatically extract structured data from a myriad of documents - whether they are scanned images, PDFs, emails, invoices, contracts, or any digital file format you can think of. Tailored to meet the needs of various industries, our API facilitates the seamless automation of workflows, significantly reducing manual efforts and enhancing overall efficiency.
Features:
Whether you're a software developer, a business analyst, or a data scientist, our Document Data Extraction API is designed to streamline your data processing tasks, allowing you to focus on what truly matters - driving your business forward. Start with Extracta.ai today and transform the way you handle documents forever.
Structure your request with mandatory parameters: 'name', 'language', 'fields' and 'file'. Each field requires a 'key', with 'description' and 'example' being optional. The document must be provided as either 'base64String' or a 'fileUrl'.
## API Documentation
This section provides guidelines for structuring your Document Parsing API requests to Extracta.ai. Ensure to follow the format below for successful data extraction:
## Request Format
```
{
"extractionDetails": {
"name": "Extraction Name", // required - Name your extraction process
"language": "Supported Language", // required - Choose from the supported languages
"fields": [
{
"key": "Field Key", // required - Define the key for data extraction
"description": "Field Description", // optional - Describe the field
"example": "Field Example" // optional - Provide an example value
},
...
]
},
"file": "base64String or file URL" // required - Provide the document in base64String format or as a URL
}
```
## Advanced Format
In addition to the basic format outlined in the previous sections, Extracta.ai also supports more complex data structures for specialized extraction needs. This advanced format allows the definition of **nested objects and arrays**, catering to a broader range of data representation.
### Type `object`
The **object** type represents a structured object with multiple **properties**. Each property is defined as an object within an array, and can include its own **key**, **description**, **type**, and **example**.
```
{
"key": "personal_info",
"description": "Personal information of the person", // optional
"type": "object",
"properties": [
{
"key": "name",
"description": "Name of the person", // optional
"example": "Alex Smith", // optional
"type": "string" // optional
},
{
"key": "email",
"description": "Email of the person",
"example": "[email protected]",
"type": "string"
},
.....
]
}
```
### Type `array`
The **array** type is used for lists of **items**, such as a collection of work experiences. The items key contains an object defining the structure of each item in the array.
```
{
"key": "work_experience",
"description": "Work experience of the person", // optional
"type": "array",
"items": {
"type": "object",
"properties": [
{
"key": "title",
"description": "Title of the job", // optional
"example": "Software Engineer", // optional
"type": "string" // optional
},
{
"key": "start_date",
"description": "Start date of the job",
"example": "2022",
"type": "string"
},
...
]
}
}
```
### Notes on Usage | Document Parsing API
- For both `object` and `array` types, the `example` parameter is applicable only for their inner properties/items.
- When defining fields, if no `type` is specified, it defaults to `string`.
- For `object` and `array` types, the inner fields can only be of type `string`. This means that each property within an object or each item within an array should be a string type, ensuring consistency and simplicity in data representation.
- These advanced field types enable more detailed and structured data representation, enhancing the capabilities of Extracta.ai's data extraction process.
## Supported File Types
Extracta.ai is capable of processing documents in **image (JPG, PNG), PDF, and DOCX formats**. This enhancement allows for a wider range of document types to be submitted for extraction.
## Supported Languages
Extracta.ai currently supports document extraction in the following languages: **Romanian, English, French, Spanish, Arabic, Portuguese, German, Italian**. Additional support for 20 more languages is planned.
**Note**: If an unsupported language is specified, the API will return an error message indicating an invalid language choice. Keep updated with our API documentation for new language additions.
Process Document - Endpoint Features
Object | Description |
---|---|
Request Body |
[Required] Json |
{
"name": "Darren Charles",
"email": "[email protected]",
"phone": "+1-709-680-9033",
"address": "9 Corpus Christi, Texas",
"soft_skills": "highly motivated, ability to translate business strategies, learn new things",
"hard_skills": "Matlab, MeVisLab, Keras, CUDA, Git, DataStage, MQTT",
"last_job": "Trainee With English Communications",
"years_of_experience": "Ongoing"
}
curl --location --request POST 'https://zylalabs.com/api/3606/document+data+extraction+api/4000/process+document' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"extractionDetails": {
"name": "CV - Extraction",
"language": "English",
"fields": [
{
"key": "name",
"description": "the name of the person in the CV",
"example": "Johan Smith"
},
{
"key": "email",
"description": "the email of the person in the CV",
"example": "[email protected]"
},
{
"key": "phone",
"description": "the phone number of the person",
"example": "123 333 4445"
},
{
"key": "address",
"description": "the compelte address of the person",
"example": "1234 Main St, New York, NY 10001"
},
{
"key": "soft_skills",
"description": "the soft skills of the person",
"example": ""
},
{
"key": "hard_skills",
"description": "the hard skills of the person",
"example": ""
},
{
"key": "last_job",
"description": "the last job of the person",
"example": "Software Engineer"
},
{
"key": "years_of_experience",
"description": "the years of experience of last job",
"example": "5"
}
]
},
"file": "https://deveatery.com/extracta/cv.png"
}'
Header | Description |
---|---|
Authorization
|
[Required] Should be Bearer access_key . See "Your API Access Key" above when you are subscribed. |
No long term commitments. One click upgrade/downgrade or cancellation. No questions asked.
Extracta.ai represents an advanced technological platform dedicated to the extraction of structured data from diverse documents, such as resumes and invoices. This service aims to streamline workflows, eliminate the need for manual data entry, and boost productivity in numerous sectors.
We are capable of handling a broad spectrum of documents, encompassing both structured and unstructured formats, such as PDFs, Word documents, text files, and scanned images (in PNG, JPG formats), employing OCR technology as required.
Indeed, Extracta.ai is built for effortless integration. Our service can be easily connected to your current software and workflows via our API. Furthermore, we intend to provide options for local system deployment in the future to increase data privacy.
Diverging from the approach of competitors who depend on fixed templates and models, Extracta.ai employs meticulously adjusted Large Language Models (LLMs) for extracting data from any document without the need for previous training, achieving an accuracy rate of up to 99%. This method ensures enhanced flexibility, quicker deployment, reduced costs
Our dedicated support team is available to assist you with any technical queries or further information. For support or any inquiries, please email us at: [email protected]
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 1000 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 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:
97%
Response Time:
558ms
Service Level:
100%
Response Time:
18,858ms
Service Level:
100%
Response Time:
0ms
Service Level:
100%
Response Time:
10,779ms
Service Level:
100%
Response Time:
1,069ms
Service Level:
100%
Response Time:
7,060ms
Service Level:
100%
Response Time:
755ms
Service Level:
100%
Response Time:
5,969ms
Service Level:
100%
Response Time:
1,187ms
Service Level:
100%
Response Time:
4,978ms
Service Level:
100%
Response Time:
1,500ms
Service Level:
100%
Response Time:
1,255ms
Service Level:
100%
Response Time:
8,098ms
Service Level:
100%
Response Time:
471ms
Service Level:
100%
Response Time:
17,264ms
Service Level:
100%
Response Time:
7,565ms
Service Level:
100%
Response Time:
7,846ms