API Endpoints
Live AI Demo

🧠 Match Profiles indexed in Sources to a Profile

get https://api.hrflow.ai/v1/profiles/matching

This endpoint allows you to find Profiles similar to a target Profile.

📘

Prerequisites

  1. ✨ Create a Workspace
  2. 🔑 Get your API Key
  3. 🧠 Activate Profiles Searching API
  4. 🧠 Activate Profiles Scoring API
  5. 🔌 Create a Source
  6. 💾 Index Profiles in the Source

📘

Postman Endpoint

Try out the live API demo of this endpoint with (Postman link #TODO)

Request headers

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

🚧

Query Parameters

The job_key and the job_reference can not 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].

Language
Authorization
Click Try It! to start a request and see the response here!