Resume Parser API - ApyHub

Resume Parser API

Artificial IntelligenceData ExtractionHR#cv#hr#resume
job
SharpAPI
SharpAPI
verified icon
1000 atoms
AI tier

About

The Resume Parser API parses a resume (CV) file from multiple formats (PDF/DOC/DOCX/TXT/RTF) and returns an extensive object of data points. This endpoint is essential for extracting detailed information from resumes, supporting various HR and recruitment applications.
This API is ideal for developers building HR platforms, recruitment software, or applicant tracking systems. It automates the extraction of relevant data from resumes, ensuring accuracy and efficiency in candidate processing. Use cases include resume data extraction for applicant tracking systems, automated candidate profiling, and enhancing recruitment workflows.
Apy Jobs are long running calls which are split into two actions:
1. Submitting the job
2. Checking the status of the job and receiving the response on successful completion of the job.
Select API Endpoints
Input(s)

API Playground

API Documentation

Resume Parser Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/hr/parse_resume

Request example

1
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/hr/parse_resume' \
2
--header 'apy-token: {{token}}' \
3
--form 'file=@"resume.pdf"'
4
--form 'language="English"'
Method: POST
Content Type: multipart/form
Request Body
AttributeTypeMandatoryDescription
fileFileYesProvide the Resume/CV file in PDF, DOC, DOCX, TXT, or RTF formats.
languageStringNoSpecify the language of the Resume, defaults to English.
Sample Response
1
{
2
  "status_url": "https://api.apyhub.com/sharpapi/api/v1/hr/parse_resume/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
3
  "job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
4
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
202The job was submitted successfully.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - if the file is invalid or corrupted.
500If any unexpected error occurs while submitting the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles