Access MeVitae’s API to integrate shortlisting into your hiring process
To generate the access token, please follow these steps
As soon as you login to the system, you will be welcomed with this message in the centre of the screen. Please click Generate
You will now have a new access code generated
Please note: The generated token gives access to all the following features and data mentioned below
Based on the type of account held by the user the requests are limited to the following for every 10 seconds
Account type | Interval | Requests |
---|---|---|
Normal Tokens | 10 seconds | 5 |
Premium Tokens | 10 seconds | 20 |
Enterprise Tokens | 10 seconds | 50 |
Users exceeding the limits will receive the following message in their HTTP headers for efficient throttling
Header | Description |
---|---|
X-RateLimit-Limit | The maximum number of requests that the user is allowed to make |
X-RateLimit-Remaining | The number of requests remaining |
X-RateLimit-Reset | The time at which the rate limit resets in seconds. |
Json result
{
"error": "limit reached, please try back in 4 seconds"
}
If you are exceeding the rate limit with these features, please contact us
/upload/jobspec
For MeVitae to perform candidate shortlisting the user is expected to first upload the job description for us to perform preliminary analysis. We will then generate an output andUnique Id for the uploaded job.
Path Parameters
user_id:
required |
string
The account member uploading the job specification |
Query Parameters
Key | Type | Description |
---|---|---|
job_name | string | The job description's name |
job_data | string | The job description encoded in base64 |
Json return
Uploading the the job description to the /upload/jobspec api returns with the following keysKey | Type | Description |
---|---|---|
job_id | long | Unique id for the uploaded job description |
upload_date | string | Returns the uploaded time stamp |
/upload/cvs
Following the job description being uploaded, the user will require the generated job_id to batch upload the cvs for scoring and tagging. We will then return with an estimated wait time to complete the analysis.
Path Parameters
job_id:
required |
string
The unique id of the uploaded job |
Query Parameters
Key | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
scoring | string |
Following are the different types of scoring MeVitae provides.
|
|||||||||
tagging | string |
Following are the different types of tagging MeVitae provides.
|
|||||||||
bias_correction | string |
Following are the different types of bias correction MeVitae provides.
|
|||||||||
cvs | arrays | Collection of CVs in the following model | |||||||||
|
Json return
Uploading the cvs to the /upload/cvs api returns with the following keysKey | Type | Description |
---|---|---|
wait_time | long | Estimated wait time for the analysis to complete in seconds |
upload_date | string | Returns the uploaded time stamp |
/shortlists
The user can retrieve all the shortlists after the wait_time for analysis completes.
Path Parameters
job_id:
required |
string
The unique id of the uploaded job |
Json return
Retrieve the collection of all the uploaded CVs scored and tagged based on options set during upload. Each CV will have the following keys.Key | Type | Description |
---|---|---|
cv_name | string | Name of the CV along with the score e.g cv-82.docx |
cv_data | string | Base64 of the CV in Docx format |
Please contact [email protected] with any questions.