GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints
Live AI Demo

🧠 Grade Profiles indexed in a Source for a Job

get
https://api.hrflow.ai/v1/profile/grading

This endpoint allows grading a Profile for a Job.

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

Prerequisites

  1. ✨ Create a Workspace
  2. 🔑 Get your API Key
  3. 🔌 Create a Source
  4. 💾 Index a Profile
  5. 🔌 Create a Board
  6. 💾 Index a Job

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 two objects:

  • Profiles: array of objects Profile.
  • Scores: array of arrays of floats [ 1-score, score ]. Example: [0.49184858798980713, 0.50815147161483765].
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
required

Deprecated: The key of the Source associated to the profile.

string

Deprecated: The Profile unique identifier.

string

Deprecated: The Profile reference chosen by the customer.

string

Positive instruction

string

Negative instruction

Responses

Updated 2 months ago

What’s Next

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

Updated 2 months ago

What’s Next

Did this page help you?