GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints

🧠 Grade Jobs indexed in a Board for a Profile

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 job processing is deprecated. Please use batch mode with the job_ids parameter.
📘

Response

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

  • Jobs: array of objects Job.
  • Scores: array of arrays of floats [ 1-score, score ]. Example: [0.49184858798980713, 0.50815147161483765].
  • Errors: null for a graded job, otherwise an object with code and message, and the job's Scores entry is null. The code is item_not_found when the job can't be read.
  • Axis: null unless return_axis is true with grader-hrflow-jobs-cosmic5 or grader-hrflow-jobs-titan5. Otherwise one object per job 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-jobs-cosmic5

The key of the Grading Algorithm.

Allowed:
string
required

The key of the Source associated to the Profile.

string

The Profile unique identifier.

string

The Profile reference chosen by the customer.

job_ids
array of objects

List of Jobs unique ids to grade (Maximum length: 128).

job_ids
string

What makes a job a better fit for the profile, added to the profile description (e.g. Remote work is a plus.).

string

What makes a job a worse fit for the profile, added to the profile description (e.g. Relocation is a no-go.).

boolean
Defaults to false

Set to true to get data.axis: whether the profile meets each job on 8 axes.

Responses

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