Welcome to the new Affinda Docs – explore the Academy, browse guides, or ask the AI assistant any questions you have!
curl --request POST \
--url https://{region}.affinda.com/v3/resume_search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"indices": [
"all-resumes"
],
"jobDescription": "<string>",
"resume": "<string>",
"jobTitles": [
"<string>"
],
"jobTitlesCurrentOnly": true,
"jobTitlesRequired": true,
"jobTitlesWeight": 0.5,
"yearsExperienceMin": 1,
"yearsExperienceMax": 1,
"yearsExperienceRequired": true,
"yearsExperienceWeight": 0.5,
"locations": [
{
"name": "",
"coordinates": {
"latitude": 123,
"longitude": 123
},
"distance": 100,
"unit": "km"
}
],
"locationsWeight": 0.5,
"locationsRequired": true,
"skills": [
{
"name": "<string>",
"required": true
}
],
"skillsWeight": 0.5,
"languages": [
{
"name": "<string>",
"required": true
}
],
"languagesWeight": 0.5,
"institutions": [
"<string>"
],
"institutionsRequired": true,
"degrees": [
"<string>"
],
"degreesRequired": true,
"highestDegreeTypes": [
"bachelors"
],
"highestDegreeTypesRequired": true,
"isCurrentStudent": true,
"isCurrentStudentRequired": true,
"isRecentGraduate": true,
"isRecentGraduateRequired": true,
"educationWeight": 0.5,
"searchExpression": "<string>",
"searchExpressionRequired": true,
"searchExpressionWeight": 0.5,
"socCodes": [
123
],
"socCodesWeight": 0.5,
"socCodesRequired": true,
"managementLevel": "Low",
"managementLevelRequired": true,
"managementLevelWeight": 0.5,
"customData": [
{
"filterType": "equals",
"dataPoint": "isAvailable",
"query": {
"value": true
},
"required": true,
"weight": 0.5
}
]
}'
{
"count": 130,
"next": "https://api.affinda.com/v3/documents?limit=300&offset=300",
"previous": "https://api.affinda.com/v3/documents?limit=300",
"parameters": {
"indices": [
"all-resumes"
],
"jobDescription": "<string>",
"resume": "<string>",
"jobTitles": [
"<string>"
],
"jobTitlesCurrentOnly": true,
"jobTitlesRequired": true,
"jobTitlesWeight": 0.5,
"yearsExperienceMin": 1,
"yearsExperienceMax": 1,
"yearsExperienceRequired": true,
"yearsExperienceWeight": 0.5,
"locations": [
{
"name": "",
"coordinates": {
"latitude": 123,
"longitude": 123
},
"distance": 100,
"unit": "km"
}
],
"locationsWeight": 0.5,
"locationsRequired": true,
"skills": [
{
"name": "<string>",
"required": true
}
],
"skillsWeight": 0.5,
"languages": [
{
"name": "<string>",
"required": true
}
],
"languagesWeight": 0.5,
"institutions": [
"<string>"
],
"institutionsRequired": true,
"degrees": [
"<string>"
],
"degreesRequired": true,
"highestDegreeTypes": [
"bachelors"
],
"highestDegreeTypesRequired": true,
"isCurrentStudent": true,
"isCurrentStudentRequired": true,
"isRecentGraduate": true,
"isRecentGraduateRequired": true,
"educationWeight": 0.5,
"searchExpression": "<string>",
"searchExpressionRequired": true,
"searchExpressionWeight": 0.5,
"socCodes": [
123
],
"socCodesWeight": 0.5,
"socCodesRequired": true,
"managementLevel": "Low",
"managementLevelRequired": true,
"managementLevelWeight": 0.5,
"customData": [
{
"filterType": "equals",
"dataPoint": "isAvailable",
"query": {
"value": true
},
"required": true,
"weight": 0.5
}
]
},
"results": [
{
"identifier": "<string>",
"score": 0.98,
"pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Example-Resume",
"name": "Mary Jane",
"jobTitle": {
"value": "Software Developer",
"label": "Job Title",
"score": 0.68
},
"managementLevel": {
"value": "Low",
"label": "Management level",
"score": 0.68
},
"experience": {
"value": "2.0 - 3.0 years",
"label": "Experience",
"score": 0.68
},
"skills": {
"value": "Python (Programming Language), Software Development",
"label": "Skills",
"score": 0.68
},
"languages": {
"value": "English",
"label": "Languages",
"score": 0.68
},
"location": {
"value": "Roxburgh Park, Australia",
"label": "Location",
"score": 0.68
},
"education": {
"value": "Architecture Interior Design",
"label": "Education",
"score": 0.68
},
"occupationGroup": {
"value": "Programmers and software development professionals",
"label": "Occupation group",
"score": 0.68
},
"searchExpression": {
"label": "Search expression",
"value": "<string>",
"score": 0.68
},
"customData": {}
}
]
}
Searches through parsed resumes. Users have 3 options to create a search:
1. Match to a job description - a parsed job description is used to find candidates that suit it
2. Match to a resume - a parsed resume is used to find other candidates that have similar attributes
3. Search using custom criteria
Users should only populate 1 of jobDescription, resume or the custom criteria.
curl --request POST \
--url https://{region}.affinda.com/v3/resume_search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"indices": [
"all-resumes"
],
"jobDescription": "<string>",
"resume": "<string>",
"jobTitles": [
"<string>"
],
"jobTitlesCurrentOnly": true,
"jobTitlesRequired": true,
"jobTitlesWeight": 0.5,
"yearsExperienceMin": 1,
"yearsExperienceMax": 1,
"yearsExperienceRequired": true,
"yearsExperienceWeight": 0.5,
"locations": [
{
"name": "",
"coordinates": {
"latitude": 123,
"longitude": 123
},
"distance": 100,
"unit": "km"
}
],
"locationsWeight": 0.5,
"locationsRequired": true,
"skills": [
{
"name": "<string>",
"required": true
}
],
"skillsWeight": 0.5,
"languages": [
{
"name": "<string>",
"required": true
}
],
"languagesWeight": 0.5,
"institutions": [
"<string>"
],
"institutionsRequired": true,
"degrees": [
"<string>"
],
"degreesRequired": true,
"highestDegreeTypes": [
"bachelors"
],
"highestDegreeTypesRequired": true,
"isCurrentStudent": true,
"isCurrentStudentRequired": true,
"isRecentGraduate": true,
"isRecentGraduateRequired": true,
"educationWeight": 0.5,
"searchExpression": "<string>",
"searchExpressionRequired": true,
"searchExpressionWeight": 0.5,
"socCodes": [
123
],
"socCodesWeight": 0.5,
"socCodesRequired": true,
"managementLevel": "Low",
"managementLevelRequired": true,
"managementLevelWeight": 0.5,
"customData": [
{
"filterType": "equals",
"dataPoint": "isAvailable",
"query": {
"value": true
},
"required": true,
"weight": 0.5
}
]
}'
{
"count": 130,
"next": "https://api.affinda.com/v3/documents?limit=300&offset=300",
"previous": "https://api.affinda.com/v3/documents?limit=300",
"parameters": {
"indices": [
"all-resumes"
],
"jobDescription": "<string>",
"resume": "<string>",
"jobTitles": [
"<string>"
],
"jobTitlesCurrentOnly": true,
"jobTitlesRequired": true,
"jobTitlesWeight": 0.5,
"yearsExperienceMin": 1,
"yearsExperienceMax": 1,
"yearsExperienceRequired": true,
"yearsExperienceWeight": 0.5,
"locations": [
{
"name": "",
"coordinates": {
"latitude": 123,
"longitude": 123
},
"distance": 100,
"unit": "km"
}
],
"locationsWeight": 0.5,
"locationsRequired": true,
"skills": [
{
"name": "<string>",
"required": true
}
],
"skillsWeight": 0.5,
"languages": [
{
"name": "<string>",
"required": true
}
],
"languagesWeight": 0.5,
"institutions": [
"<string>"
],
"institutionsRequired": true,
"degrees": [
"<string>"
],
"degreesRequired": true,
"highestDegreeTypes": [
"bachelors"
],
"highestDegreeTypesRequired": true,
"isCurrentStudent": true,
"isCurrentStudentRequired": true,
"isRecentGraduate": true,
"isRecentGraduateRequired": true,
"educationWeight": 0.5,
"searchExpression": "<string>",
"searchExpressionRequired": true,
"searchExpressionWeight": 0.5,
"socCodes": [
123
],
"socCodesWeight": 0.5,
"socCodesRequired": true,
"managementLevel": "Low",
"managementLevelRequired": true,
"managementLevelWeight": 0.5,
"customData": [
{
"filterType": "equals",
"dataPoint": "isAvailable",
"query": {
"value": true
},
"required": true,
"weight": 0.5
}
]
},
"results": [
{
"identifier": "<string>",
"score": 0.98,
"pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Example-Resume",
"name": "Mary Jane",
"jobTitle": {
"value": "Software Developer",
"label": "Job Title",
"score": 0.68
},
"managementLevel": {
"value": "Low",
"label": "Management level",
"score": 0.68
},
"experience": {
"value": "2.0 - 3.0 years",
"label": "Experience",
"score": 0.68
},
"skills": {
"value": "Python (Programming Language), Software Development",
"label": "Skills",
"score": 0.68
},
"languages": {
"value": "English",
"label": "Languages",
"score": 0.68
},
"location": {
"value": "Roxburgh Park, Australia",
"label": "Location",
"score": 0.68
},
"education": {
"value": "Architecture Interior Design",
"label": "Education",
"score": 0.68
},
"occupationGroup": {
"value": "Programmers and software development professionals",
"label": "Occupation group",
"score": 0.68
},
"searchExpression": {
"label": "Search expression",
"value": "<string>",
"score": 0.68
},
"customData": {}
}
]
}
Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}
.
You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.
The number of documents to skip before starting to collect the result set.
x >= 0
0
The numbers of results to return.
1 <= x <= 50
20
Search parameters
The body is of type object
.
Will return matching documents
The response is of type object
.