📘
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.

📘
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].