Overview

The HrFlow.ai API helps you incorporate powerful AI Solutions into your HR Tech stack.

The API allows you to go beyond the features we provide out of the box and build something better suited for your needs.

📘

Prerequisites

  1. ✨ Create a Workspace
  2. 🔑 Get your API Key
  3. 🔑 Try your API Keys

Profile API

Endpoint

Method

Description

🔌 Get all Sources

GET

Retrieve all sources for given team account.

🔌 Get a Source

GET

Retrieve the Source information a with Source key.

💾 Index a Profile

POST

This endpoint allows you to Index a Profile object.

💾 Edit a Profile

PUT

This endpoint allows you to edit the of JSON of Profile.

💾 Get a Profile

GET

This endpoint allows retrieving the Profile object.

💾 Archive a Profile

PATCH

This endpoint allows archiving and unarchiving a Profile.

🧠 Parse a Resume

POST

This endpoint allows you to Parse a Resume and create a Profile from it.

🧠 Get a Resume Parsing

GET

This endpoint allows you to retrieve the Resume Parsing object attached to the Profile.

🧠 Vectorize a Profile

POST

This endpoint allows you to vectorize a Profile.

🧠 Search Profiles

GET

This endpoint allows you to Search Profiles.

🧠 Score Profiles for a Job

GET

This endpoint allows you to Score Profiles for Job.

Job API

Endpoint

Method

Description

🔌 Get all Boards

GET

Retrieve all boards for given team account.

🔌 Get a Board

GET

Retrieve the Board information a with Board key.

💾 Index a Job

POST

This endpoint allows you to Index a Job object.

💾 Edit a Job

PUT

This endpoint allows you to edit the of JSON of Job.

💾 Get a Job

GET

This endpoint allows retrieving the Job object.

💾 Archive/Unarchive a Job

PATCH

This endpoint allows archiving and unarchiving a Job.

🧠 Vectorize a Job

POST

This endpoint allows you to vectorize a Job.

🧠 Search Jobs

GET

This endpoint allows you to Search Jobs.

🧠 Score Jobs

GET

This endpoint allows you to Score Jobs for Profile.

Text API

Endpoint

Method

Description

🧠 Find Synonyms for a Word

POST

Find synonyms or the top N most similar words to a word.

🧠 Parse a raw Text

POST

Extract over 50 data point from any raw input text.

🧠 Reveal Skills missing in a Text

POST

Predict missing & likely hard-skills and soft-skills.

🧠 Vectorize a Text

POST

This endpoint allows you to vectorize a Text.


Did this page help you?