🧠 Score Jobs indexed in Boards for a Profile

get

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

This endpoint allows you to Score Jobs for Profile.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Prerequisites

✨ Create a Workspace

🔑 Get your API Key

🧠 Activate Jobs Searching API

🧠 Activate Jobs Scoring API

🔌 Create a Board

💾 Index Jobs in the Source

🔌 Create a Source

💾 Index a Profile

Request headers

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

🚧
Query Parameters
The profile_key and the profile_reference can not 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:

Jobs: array of objects Job.

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.

source_key

string

required

The key of Source attached to the Profile.

profile_key

string

The Profile's unique identifier.

profile_reference

string

The Profile reference chosen by the customer.

board_keys

string

required

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

include_job_keys

string

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

exclude_job_keys

string

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

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.

names

string

Filter Jobs by their names. Example : ["xxx", "yyy", "zzz"]

location_geopoint

string

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

location_distance

int32

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

summary_keywords

string

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

text_keywords

string

Filter Jobs 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.

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}]

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"}]]

ranges_float

string

Filter results by a range of floats. Example : [{"name":"salary", "value_min":30, "value_max":40}]

ranges_date

string

Filter results by a range of dates. Example : [{"name":"Dates", "value_min":"2020-05-18T21:59", "value_max":"2020-09-15T21:59"}]

raw_filters

string

Filter results based on custom raw query.
Example: {"query":{"bool":{"should":[{"match":{"summary":"python"}},{"match":{"summary":"machine learning"}}]}}}

score_threshold

float

Defaults to 0

Filter Jobs 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 Jobs indexed in Boards for a Profile

Prerequisites

Request headers

Query Parameters

Request Method Selection

Response

What’s Next

What’s Next

Prerequisites

Request headers

Query Parameters

Request Method Selection

Response

200200

400400

401401

What’s Next

What’s Next