🧠 Score Profiles indexed in Sources for a Job

get

https://api.hrflow.ai/v1/profiles/scoring

This endpoint allows you to Score Profiles for Job.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Prerequisites

✨ Create a Workspace

🔑 Get your API Key

🧠 Activate Profiles Searching API

🧠 Activate Profiles Scoring API

🔌 Create a Source

💾 Index Profiles in the Source

🔌 Create a Board

💾 Index a Job

❗
Scoring activation
Scoring must be activated for the source used. Please activate scoring from our developer platform:

On your HrFlow developer account, navigate to Connections > My Sources

Click on the source you are willing to use for scoring

In AI Modules tab, scroll down and turn the "Profile Scoring API" switch on

Request headers

Field	Value
`X-API-KEY`	Your API Key.
`X-USER-EMAIL`	Your HrFlow.ai account's email.

🚧
Query Parameters
The job_key and the job_reference cannot be null at the same time in the Query Parameters.

🚧
Request Method Selection
This endpoint supports both GET and POST. When query parameters exceed the maximum allowed URL length, clients should use the POST variant and send the same parameters in the request body (see the changelog).

📘
Response
This endpoint returns a data object containing two objects:

Profiles: array of objects Profile.

Predictions: array of arrays of floats [ 1-score, score ]. Example: [0.49184858798980713, 0.50815147161483765].

Query Params

algorithm_key

string

required

The key of the Scoring Algorithm.

use_algorithm

string

Defaults to 1

Turn 0 to switch the Scoring to the Searching only mode.

board_key

string

required

The key of Board attached to the given Job.

job_key

string

The Job's unique identifier.

job_reference

string

The Job reference chosen by the customer.

source_keys

string

required

The list of the keys of the Sources containing the targeted Profiles. Example : ["xxx", "yyy", "zzz"]

include_profile_keys

string

Include only Profiles matching the given list of Profile keys. When provided, the results are restricted to this subset. Example : ["xxx", "yyy", "zzz"]

exclude_profile_keys

string

Exclude Profiles according to the list of Profile keys. Example : ["xxx", "yyy", "zzz"]

stage

string

enum

Filter Profiles by their stage: new, yes , later, no. If not provided the results will includes all stage values.

Allowed:

page

string

Defaults to 1

The number of the current results' page.

limit

string

Defaults to 30

The number of results per page

order_by

string

enum

Defaults to desc

Order results by asc, or desc.

Allowed:

sort_by

string

enum

Defaults to created_at

Sort results by searching, scoring, created_at, updated_at, location, location_experience, location_education.

Allowed:

created_at_min

string

Set a minimum creation date.

created_at_max

string

Set a maximum creation date.

name

string

Filter Profiles by their name.

string

Filter Profiles by their email.

location_geopoint

object

Filter Profiles by their location address. {"lat":47.21812, "lng":-1.55306}

location_distance

int32

Set a radius around the Profiles' location address (in Km).

summary_keywords

string

Filter Profiles by keywords in their summary section. Example : ["xxx", "yyy", "zzz"]

text_keywords

string

Filter Profiles by keywords in the full text. Example : ["xxx", "yyy", "zzz"]

enrich_text_keywords

boolean

Defaults to false

If enabled, this feature enriches the search by including synonyms of the keywords specified in text_keywords, broadening the search results.

experience_keywords

string

Filter Profiles by keywords in their experiences' titles and descriptions. Example : ["xxx", "yyy", "zzz"]

experience_location_geopoint

string

Filter Profiles by their experiences' locations. Example : {"lat":47.21812, "lon":-1.55306}

experience_location_distance

int32

Set a radius around the educations' locations (in Km)

experiences_duration_min

int32

Set a minimum number of years of experience.

experiences_duration_max

int32

Set a maximum number of years of experience.

education_keywords

string

Filter Profiles by keywords in their educations' titles and descriptions. Example : ["xxx", "yyy", "zzz"]

education_location_geopoint

string

Filter Profiles by their educations locations. Example : {"lat":47.21812, "lon":-1.55306}

education_location_distance

int32

Set a radius around the educations' locations (in Km).

educations_duration_min

int32

Set a minimum number of years of education.

educations_duration_max

int32

Set a maximum number of years of education.

skills

string

Filter results by a list of skills names and their values. Example : [{"name":"python", "value":null}]

languages

string

Filter results by a list of languages names and their values. Example : [{"name":"english", "value":null}]

interests

string

Filter results by a list of interest names and their values. Example : [{"name":"sport", "value":null}]

tags_included

string

Filter results containing certain tag names and their values. Shape of this field [ [... OR ...] AND [... OR ...] ]. Example : [[{"name":"sync","value":"1"}]]

tags_excluded

string

Exclude results containing certain tag names and their values. Shape of this field [ [... OR ...] AND [... OR ...] ]. Example : [[{"name":"sync","value":"0"}]]

raw_filters

string

Filter results based on custom raw query.
Example: {"query":{"bool":{"should":[{"match_phrase":{"text":"Python"}},{"match_phrase":{"text":"Java"}}]}}}

score_threshold

float

Defaults to 0

Filter Profiles scored lower than the given threshold.

memory_context

string

enum

Defaults to organization_live_actions

Enables real-time retraining capabilities powered by data from either individual user interactions or aggregated organization actions.

Allowed:

memory_context_warmup

string

enum

Defaults to organization_past_actions

Initializes the memory_context by loading relevant historical data from either previous individual user interactionsactions or aggregated organization activities.

Allowed:

Responses

🧠 Score Profiles indexed in Sources for a Job

Prerequisites

Scoring activation

Request headers

Query Parameters

Request Method Selection

Response

What’s Next

What’s Next

Prerequisites

Scoring activation

Request headers

Query Parameters

Request Method Selection

Response

200200

400400

What’s Next

What’s Next