curl --request POST \
--url https://{region}.affinda.com/v3/resume_search/embed \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"configOverride": {
"allowPdfDownload": true,
"maxResults": 10,
"displayJobTitle": true,
"displayLocation": true,
"displayYearsExperience": true,
"displayOccupationGroup": true,
"displayEducation": true,
"displaySkills": true,
"displayLanguages": true,
"displayManagementLevel": true,
"displayKeywords": true,
"weightJobTitle": 123,
"weightLocation": 123,
"weightYearsExperience": 123,
"weightOccupationGroup": 123,
"weightEducation": 123,
"weightSkills": 123,
"weightLanguages": 123,
"weightManagementLevel": 123,
"weightKeywords": 123,
"indices": [
"all-resumes",
"my-index"
],
"showIndexDropdown": true,
"searchToolTheme": {
"palette": {
"mode": "light",
"background": "<string>",
"text": {
"primary": "<string>",
"secondary": "<string>",
"disabled": "<string>"
},
"divider": "<string>",
"primary": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"secondary": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"success": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"annotation": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"error": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"info": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"warning": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
}
},
"typography": {
"fontFamily": "<string>",
"fontSize": "<string>",
"fontWeightRegular": "<string>",
"fontWeightMedium": "<string>",
"fontWeightBold": "<string>"
},
"borderRadius": 123,
"fontUrl": "<string>"
},
"actions": [
{
"label": "Add to shortlist",
"eventName": "addToShortlist"
}
],
"hideToolbar": true,
"hideSidePanel": true,
"customFieldsConfig": [
{
"dataPoint": "RdNAniIH",
"weight": 0.5
}
],
"distanceUnit": "km"
}
}
'{
"url": "https://app.affinda.com/resume-search?signature=eyJhbGxvd19wZGZfZG"
}Create and return a signed URL of the resume search tool which then can be embedded on a web page. An optional parameter config_override can be passed to override the user-level configurations of the embeddable resume search tool.
curl --request POST \
--url https://{region}.affinda.com/v3/resume_search/embed \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"configOverride": {
"allowPdfDownload": true,
"maxResults": 10,
"displayJobTitle": true,
"displayLocation": true,
"displayYearsExperience": true,
"displayOccupationGroup": true,
"displayEducation": true,
"displaySkills": true,
"displayLanguages": true,
"displayManagementLevel": true,
"displayKeywords": true,
"weightJobTitle": 123,
"weightLocation": 123,
"weightYearsExperience": 123,
"weightOccupationGroup": 123,
"weightEducation": 123,
"weightSkills": 123,
"weightLanguages": 123,
"weightManagementLevel": 123,
"weightKeywords": 123,
"indices": [
"all-resumes",
"my-index"
],
"showIndexDropdown": true,
"searchToolTheme": {
"palette": {
"mode": "light",
"background": "<string>",
"text": {
"primary": "<string>",
"secondary": "<string>",
"disabled": "<string>"
},
"divider": "<string>",
"primary": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"secondary": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"success": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"annotation": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"error": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"info": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"warning": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
}
},
"typography": {
"fontFamily": "<string>",
"fontSize": "<string>",
"fontWeightRegular": "<string>",
"fontWeightMedium": "<string>",
"fontWeightBold": "<string>"
},
"borderRadius": 123,
"fontUrl": "<string>"
},
"actions": [
{
"label": "Add to shortlist",
"eventName": "addToShortlist"
}
],
"hideToolbar": true,
"hideSidePanel": true,
"customFieldsConfig": [
{
"dataPoint": "RdNAniIH",
"weight": 0.5
}
],
"distanceUnit": "km"
}
}
'{
"url": "https://app.affinda.com/resume-search?signature=eyJhbGxvd19wZGZfZG"
}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.
Show child attributes
Maximum number of results that can be returned. Setting to "null" means no limitation.
x >= 110
List of index names.
["all-resumes", "my-index"]Controls whether or not the index dropdown is displayed to the user
Customize the theme of the embeded search tool.
Show child attributes
Show child attributes
light, dark Show child attributes
A list of actions to show in the dropdown in the embedded search tool
Hide the reset/import toolbar.
Hide the entire side panel.
The unit of distance to use for location based searches
mi, km "km"
Successfully created a signed URL.
The signed URL for the embedable search tool.
"https://app.affinda.com/resume-search?signature=eyJhbGxvd19wZGZfZG"