API Documentation | Resume Parsing API

This section provides guidelines for structuring your Resume 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": "alex.smith@gmail.com",
            "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

• 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 by January.

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.

About Extracta.ai & Resume Parsing API

Who We Are

Extracta.ai, a pioneer in document data extraction, specializes in transforming a variety of documents into structured data. Serving multiple industries, we enable businesses to automate data processing, increase operational efficiency, and minimize manual intervention. Our expertise extends to extracting both structured and unstructured data from diverse document types.

What We Do

Our specialized product, the Resume Parsing API, is meticulously crafted to extract data from resumes and CVs. This powerful tool is designed to parse detailed information from various formats including PDF, Word, TXT, as well as scanned images in PNG and JPG formats, employing OCR technology where necessary.

Key Features:

• Tailored for Resumes: Specifically designed to handle the complexities and nuances of resume data.
• Custom Extraction Solutions: Allows users to set specific parameters for extracting the exact data they need from resumes.
• Exceptional Accuracy: Employs advanced LLMs to ensure precision and reliability, boasting up to 99% accuracy.
• Seamless Integration: Offered as a RESTful API, it easily integrates with existing HR systems and workflow applications.
• Commitment to Privacy: Adheres to stringent data privacy standards, ensuring the security of all processed data.

Our Mission

Our mission at Extracta.ai is to revolutionize resume data extraction, making it a swift, accurate, and hassle-free component of recruitment and HR processes. We’re dedicated to ongoing innovation, aligning our technology with the dynamic needs of our clients.

Our Vision

We envision Extracta.ai as a key enabler in HR and recruitment efficiency, transforming resume extraction from a challenging task into a driver of business growth and streamlined operations. Our focus is on developing technology that’s not just powerful but also intuitive and user-centric, positioning us as leaders in the resume data extraction field.

Connect With Us

Discover more about our Resume Parsing API or reach out to us directly at www.extracta.ai.

Thank you for choosing Extracta.ai for your resume parsing and data extraction requirements.