Getting Started

Integrating Aphelia into your project is as easy as it can be. The below snippet will help you get started on sending and receiving API calls to Aphelia. After a resume is sent successfully to the Aphelia's servers, the extraction algorithms extract information from the resume and return the extracted data as JSON objects.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
var form = new FormData();
form.append("file", fileInput.files[0], "file_location");
var settings = {
 "url": "http://127.0.0.1:5000/file-upload",
 "method": "POST",
 "timeout": 0,
 "processData": false,
 "mimeType": "multipart/form-data",
 "contentType": false,
 "data": form
};
$.ajax(settings).done(function (response) {
  console.log(response);
});



Endpoints


HTTPS
staging-api.aphelia.ai/multiple-files-upload
POST

Authentication

OAuth API authentication is used to handle API key verification. Once you login your API access key along with your other header credentials will be mailed to you

Data protection

As we are GDPR compliant, every effort was made to make sure that the resume files upload are secure and in your control. Parsed resumes are stored for model training and improvement purposes only with the consent of the user. You can always contact us to ask to remove your data. In addition, data collected is cleared from storage every 3 months if it isn't used for training and is idle. As resumes are considered as sensitive personal data, Aphelia was developed with much focus on security. Aphelia uses an HTTP2, end-to-end TLS encryption to make sure that when clients upload resumes Individually or as bulk to Aphelia's API, the data transfer occurs safe and secure, the same end-to-end TLS encryption is provided when extracted information from the uploaded resumes are returned as JSON responses from the client.

HTTP status code

404 - The file sent to parse was either corrupted or in an unknown format other than pdf or docx.
201 - Successfully received and parsed resume sent
200 - Bad Request (problems with header parameters)
401 - Unauthorized request
429 - Too many requests