Resume / CV

Unlock the full potential of resume data with Extracta.ai’s advanced document parsing capabilities. Our API simplifies the process of extracting valuable information from resumes, making it easier for HR professionals, recruiters, and job portals to automate candidate data extraction, enhancing the recruitment process. This page provides you with a ready-to-use request body for creating resume extractions, streamlining your integration with our service.

Why Use Extracta.ai for Resume Parsing?

• Automated Data Extraction: Reduce manual data entry and speed up the candidate screening process.

• High Accuracy: Leverage Extracta.ai's advanced algorithms to ensure precise extraction of candidate information.

• Customizable Extraction: Tailor the data extraction to meet your specific recruitment needs.

Getting Started

To begin parsing resumes with Extracta.ai, you'll need to make a POST request to our /createExtraction endpoint. Below is a template for the request body specifically designed for resume parsing. This template includes predefined keys that correspond to common data points found in resumes, such as personal information, education, work experience, and skills.

Body Example for Resume / CV

JSON Body

{
    "extractionDetails": {
        "name": "Resume - Extraction",
        "language": "English",
        "fields": [
            {
                "key": "personal_info",
                "description": "personal information of the person",
                "type": "object",
                "properties": [
                    {
                        "key": "name",
                        "description": "name of the person",
                        "example": "Alex Smith",
                        "type": "string"
                    },
                    {
                        "key": "email",
                        "description": "email of the person",
                        "example": "[e-mail]",
                        "type": "string"
                    },
                    {
                        "key": "phone",
                        "description": "phone of the person",
                        "example": "0712 123 123",
                        "type": "string"
                    },
                    {
                        "key": "address",
                        "description": "address of the person",
                        "example": "Bucharest, Romania",
                        "type": "string"
                    }
                ]
            },
            {
                "key": "work_experience",
                "description": "work experience of the person",
                "type": "array",
                "items": {
                    "type": "object",
                    "properties": [
                        {
                            "key": "title",
                            "description": "title of the job",
                            "example": "Software Engineer",
                            "type": "string"
                        },
                        {
                            "key": "start_date",
                            "description": "start date of the job",
                            "example": "2022",
                            "type": "string"
                        },
                        {
                            "key": "end_date",
                            "description": "end date of the job",
                            "example": "2023",
                            "type": "string"
                        },
                        {
                            "key": "company",
                            "description": "company of the job",
                            "example": "Fastapp Development",
                            "type": "string"
                        },
                        {
                            "key": "location",
                            "description": "location of the job",
                            "example": "Bucharest, Romania",
                            "type": "string"
                        },
                        {
                            "key": "description",
                            "description": "description of the job",
                            "example": "Designing and implementing server-side logic to ensure high performance and responsiveness of applications.",
                            "type": "string"
                        }
                    ]
                }
            },
            {
                "key": "education",
                "description": "school education of the person",
                "type": "array",
                "items": {
                    "type": "object",
                    "properties": [
                        {
                            "key": "title",
                            "description": "title of the education",
                            "example": "Master of Science in Computer Science",
                            "type": "string"
                        },
                        {
                            "key": "start_date",
                            "description": "start date of the education",
                            "example": "2022",
                            "type": "string"
                        },
                        {
                            "key": "end_date",
                            "description": "end date of the education",
                            "example": "2023",
                            "type": "string"
                        },
                        {
                            "key": "institute",
                            "description": "institute of the education",
                            "example": "Bucharest Academy of Economic Studies",
                            "type": "string"
                        },
                        {
                            "key": "location",
                            "description": "location of the education",
                            "example": "Bucharest, Romania",
                            "type": "string"
                        },
                        {
                            "key": "description",
                            "description": "description of the education",
                            "example": "Advanced academic degree focusing on developing a deep understanding of theoretical foundations and practical applications of computer technology.",
                            "type": "string"
                        }
                    ]
                }
            },
            {
                "key": "languages",
                "description": "languages spoken by the person",
                "type": "array",
                "items": {
                    "type": "string",
                    "example": "English"
                }
            },
            {
                "key": "skills",
                "description": "skills of the person",
                "type": "array",
                "items": {
                    "type": "string",
                    "example": "NodeJS"
                }
            },
            {
                "key": "certificates",
                "description": "certificates of the person",
                "type": "array",
                "items": {
                    "type": "string",
                    "example": "AWS Certified Developer - Associate"
                }
            }
        ]
    }
}

How to Use This Template

1. Create an API Key: Ensure you have an API key by signing up at https://app.extracta.ai and navigating to the /api page to generate your key.

2. Make the API Call: Use the provided JSON template in your POST request to /createExtraction. Don’t forget to include your API key in the request header as a Bearer token for authentication.

3. Receive and Process Data: After submitting your request, the API will return structured data extracted from the resume, which you can then integrate into your application or workflow.

Code Example

JavaScript

const axios = require('axios');

/**
 * Initiates a new document extraction process with the provided details.
 * 
 * @param {string} token - The authorization token for API access.
 * @param {Object} extractionDetails - The details of the extraction to be created.
 * @returns {Promise<Object>} The promise that resolves to the API response with the new extraction ID.
 */
async function createExtraction(token, extractionDetails) {
    const url = "https://api.extracta.ai/api/v1/createExtraction";

    try {
        const response = await axios.post(url, {
            extractionDetails
        }, {
            headers: {
                'Content-Type': 'application/json',
                'Authorization': `Bearer ${token}`
            }
        });

        // Handling response
        return response.data; // Directly return the parsed JSON response
    } catch (error) {
        // Handling errors
        throw error.response ? error.response.data : new Error('An unknown error occurred');
    }
}

async function main() {
    const token = 'apiKey';
    const extractionDetails = {}; // the json body from the example

    try {
        const response = await createExtraction(token, extractionDetails);
        console.log("New Extraction Created:", response);
    } catch (error) {
        console.error("Failed to create new extraction:", error);
    }
}

main();

Python

import requests


def create_extraction(token, extraction_details):
    url = "https://api.extracta.ai/api/v1/createExtraction"
    headers = {"Content-Type": "application/json", "Authorization": f"Bearer {token}"}

    try:
        response = requests.post(url, json=extraction_details, headers=headers)
        response.raise_for_status()  # Raises an HTTPError if the response status code is 4XX/5XX
        return response.json()  # Returns the parsed JSON response
    except requests.RequestException as e:
        # Handles any requests-related errors
        print(e)
        return None


# Example usage
if __name__ == "__main__":
    token = "apiKey"
    extraction_details = {} # the json body from the example

    response = create_extraction(token, extraction_details)
    print("New Extraction Created:", response)

Conclusion

Extracta.ai streamlines the extraction of critical information from resumes, offering a powerful tool for anyone looking to automate and improve the efficiency of their recruitment process. By utilizing our API, you can focus on what truly matters - finding the right candidates.

For further details on integrating our API and making the most out of its capabilities, please refer to our API Endpoints and 1. Create extraction pages.