GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints

🧠 Grade Profiles indexed in a Source for a Job

This endpoint allows grading a Profile for a Job.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request headers

FieldValue
X-API-KEYYour API Key.
X-USER-EMAILYour HrFlow.ai account's email.
🚧

Query Parameters

  • The key and the reference can not be null at the same time in the Query Parameters.
  • Single profile processing is deprecated. Please use batch mode with the profile_ids parameter.
📘

Response

This endpoint returns a data object containing four keys, with one entry per profile, in the order of the profiles:

  • Profiles: array of objects Profile.
  • Scores: array of arrays of floats [ 1-score, score ]. Example: [0.49184858798980713, 0.50815147161483765].
  • Errors: null for a graded profile, otherwise an object with code and message, and the profile's Scores entry is null. The code is item_not_found when the profile can't be read.
  • Axis: null unless return_axis is true with grader-hrflow-profiles-cosmic5 or grader-hrflow-profiles-titan5. Otherwise one object per profile with 8 keys (education, languages, skills, seniority, management, contract, role, domain), each true (met), false (not met) or null (the job doesn't ask).
Query Params
string
enum
required
Defaults to grader-hrflow-profiles-cosmic3
Allowed:
string
required

The key of the Board associated to the job.

string

The Job unique identifier.

string

The Job reference chosen by the customer.

profile_ids
array of objects

List of Profiles unique ids to grade (Maximum length: 32).

profile_ids
string

What makes a profile a better fit, added to the job description (e.g. Fintech experience is a plus.).

string

What makes a profile a worse fit, added to the job description (e.g. No hands-on Spark experience is a no-go.).

boolean
Defaults to false

Set to true to get data.axis: whether each profile meets the job on 8 axes. Only grader-hrflow-profiles-cosmic5 and grader-hrflow-profiles-titan5 return it.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json