📖 API endpoints 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
Profile API
| Endpoint | Method | Description | Pricing Unit | Default Rate-limit/minute |
|---|---|---|---|---|
| 🔌 Get all Sources | GET | Retrieve all sources for given team account. | Free | 100 |
| 🔌 Get a Source | GET | Retrieve the Source information a with Source key. | Free | 100 |
| 💾 Index a Profile | POST | This endpoint allows you to Index a Profile object. | Free | 100 |
| 💾 Edit a Profile | PUT | This endpoint allows you to edit the of JSON of Profile. | Free | 100 |
| 💾 Get a Profile | GET | This endpoint allows retrieving the Profile object. | Free | 100 |
| 💾 Archive a Profile | PATCH | This endpoint allows archiving a Profile. | Free | 100 |
| 🧠 Parse a Resume | POST | This endpoint allows you to Parse a Resume and create a Profile from it. | Request | Custom |
| 🧠 Get a Resume Parsing | GET | This endpoint allows you to retrieve the Resume Parsing object attached to the Profile. | Free | 100 |
| 🧠 Vectorize a Profile | POST | This endpoint allows you to vectorize a Profile. | Request | Custom |
| 🧠 Search Profiles | GET | This endpoint allows you to Search Profiles. | Record | Custom |
| 🧠 Score Profiles for a Job | GET | This endpoint allows you to Score Profiles for Job. | Record | Custom |
Job API
| Endpoint | Method | Description | Pricing Unit | Default Rate-limit/minute |
|---|---|---|---|---|
| 🔌 Get all Boards | GET | Retrieve all boards for given team account. | Free | 100 |
| 🔌 Get a Board | GET | Retrieve the Board information a with Board key. | Free | 100 |
| 💾 Index a Job | POST | This endpoint allows you to Index a Job object. | Free | 100 |
| 💾 Edit a Job | PUT | This endpoint allows you to edit the of JSON of Job. | Free | 100 |
| 💾 Get a Job | GET | This endpoint allows retrieving the Job object. | Free | 100 |
| 💾 Archive a Job | PATCH | This endpoint allows archiving a Job. | Free | 100 |
| 🧠 Vectorize a Job | POST | This endpoint allows you to vectorize a Job. | Request | Custom |
| 🧠 Search Jobs | GET | This endpoint allows you to Search Jobs. | Record | Custom |
| 🧠 Score Jobs | GET | This endpoint allows you to Score Jobs for Profile. | Record | Custom |
Text API
| Endpoint | Method | Description | Pricing Unit | Default Rate Limit (requests per minute) |
|---|---|---|---|---|
| 🧠 Find Synonyms for a Word | POST | Find synonyms or the top N most similar words to a word. | Request | Custom |
| 🧠 Parse a raw Text | POST | Extract over 50 data point from any raw input text. | Request | Custom |
| 🧠 Reveal Skills missing in a Text | POST | Predict most likely tags for a text with our library of AI algorithms. | Request | Custom |
| 🧠 Vectorize a Text | POST | This endpoint allows you to vectorize a Text. | Request | Custom |