# HrFlow.ai Documentation Documentation > Documentation for HrFlow.ai Documentation ## Guides - [πŸ€— Welcome](https://developers.hrflow.ai/docs/welcome.md): By leveraging AI superpowers, we help HR Tech, Staffing Agencies, and Large employers to thrive in a high-frequency labor market. - [πŸ”’ Create and manage your account](https://developers.hrflow.ai/docs/create-and-manage-your-account.md) - [πŸ”‘ API Authentication](https://developers.hrflow.ai/docs/api-authentication.md): Get your Secret Keys to authenticate your API Calls. Secure API Call with Domain whitelisting. - [⚑Quick start with Postman (for developers)](https://developers.hrflow.ai/docs/get-started-with-hrflow-postman.md): Test our APIs in minutes to explore our capabilities - [πŸ“– API endpoints overview](https://developers.hrflow.ai/docs/api-overview.md): The HrFlow.ai API helps you incorporate powerful AI Solutions into your HR Tech stack. - [πŸ”Œ Connectors overview](https://developers.hrflow.ai/docs/connectors-overview.md): Glossary of key terminology to know when working with the HrFlow.ai Platform - [Overview](https://developers.hrflow.ai/docs/ai-studio-overview.md): Artificial Intelligence Studio of HrFlow.ai to democratize data science in HR departments. - [Create, Configure a Scoring Algorithm](https://developers.hrflow.ai/docs/ai-studio-scoring-algorithm.md): Everything you need to know about how to create and set up a pre-trained AI Scoring Algorithm. - [Create Scoring Data](https://developers.hrflow.ai/docs/ai-studio-scoring-data.md): Scoring data needed to train a custom AI Scoring Algorithm. - [Recruiter : Create scoring data](https://developers.hrflow.ai/docs/recruiter-scoring-data.md): Everything you need to know about creating Scoring Data to train a Custom Recruiter Scoring Algorithm. - [Candidate : Create scoring data](https://developers.hrflow.ai/docs/candidate-scoring-data.md): Everything you need to know about creating Scoring Data to train a Custom Candidate Scoring Algorithm. - [Large Scale Scoring Data](https://developers.hrflow.ai/docs/large-scale-scoring-data.md): Everything you need to know about creating Scoring Data for large scale training - [Source](https://developers.hrflow.ai/docs/connectors-source.md): Source connector tutorial - [Board](https://developers.hrflow.ai/docs/connectors-board.md): Board connector tutorial - [Workflow](https://developers.hrflow.ai/docs/workflow.md) - [Webhook](https://developers.hrflow.ai/docs/connectors-webhook.md): Webhook Connectors Tutorial: from Webhook creation to start sending Events. - [Job Parsing](https://developers.hrflow.ai/docs/job-parsing.md): Parse job descriptions and vacancies with a few lines of code. - [Tagging API](https://developers.hrflow.ai/docs/tagging-api.md): Tag any text with only few lines of code. - [Profile Searching](https://developers.hrflow.ai/docs/profiles-searching.md): Index, retrieve, and display HrFlow.ai's Profile Searching results over 50 data points. - [Profile Scoring](https://developers.hrflow.ai/docs/profiles-scoring.md): Index, retrieve, and display HrFlow.ai's Profile Scoring results over 50 data points. - [Job Scoring](https://developers.hrflow.ai/docs/jobs-scoring.md): Index, retrieve, and display HrFlow.ai's Job Scoring results. - [Profiles Asking](https://developers.hrflow.ai/docs/profiles-asking.md): Unlock Profile Insights with Interactive Questions - [Jobs Asking](https://developers.hrflow.ai/docs/jobs-asking.md): Enhance Job Postings with Interactive Questions - [πŸ—£ Provide Feedback on Parsed Profiles to HrFlow.ai](https://developers.hrflow.ai/docs/errors-parsing-profile.md): This document guides users on how to provide feedback to HrFlow.ai regarding parsed profiles. - [πŸ€– HrFlow.ai Workflows](https://developers.hrflow.ai/docs/workflows.md): Build custom HR data processes with your own business logic. - [➑️ Send data from a Tool into HrFlow.ai](https://developers.hrflow.ai/docs/send-data-from-a-tool-into-hrflowai.md): Learn how to sync Talent data from a Source or a Board into HrFlow.ai . - [⬅️ Send data from HrFlow.ai into a Tool](https://developers.hrflow.ai/docs/send-data-from-hrflowai-into-a-tool.md): Learn how to sync Talent data from HrFlow.ai into a Destination. - [🎯 HrFlow.ai Scoring & Searching O.E.M integration](https://developers.hrflow.ai/docs/hrflowai-scoring-searching-oem-integration.md): How to enable Searching and Scoring experience within your ATS, CRM or ERP. - [πŸ”¨ Introduction to Make.com ETL](https://developers.hrflow.ai/docs/etl-make.md): Make is a leading visual platform that empowers users to design, build, and automate tasks and workflows without coding, fostering collaboration and innovation. - [⚑ Introduction to Zapier ETL](https://developers.hrflow.ai/docs/etl-zapier.md): Zapier is a leading no-code automation platform that connects over 6,000 apps, including Google, Salesforce, and Microsoft. It enables users to create custom workflows without coding, promoting collaboration across departments. With a secure and reliable environment, Zapier streamlines processes, making automation easy and scalable for diverse business needs. - [πŸ”„ Introduction to Microsoft Power Automate ETL](https://developers.hrflow.ai/docs/etl-microsoft-power-automate.md): Empower your organization with a low-code platform, seamlessly connecting applications, workflows, and AI-powered tools. Harness over 1000 Power Platform connectors for unified, efficient solutions. - [🚰 Manage Rate Limits in HrFlow.ai SDK](https://developers.hrflow.ai/docs/manage-rate-limits-with-hrflowai-sdk.md): Learn how to effectively manage API request limits and ensure smooth data processing. - [πŸ“ Parse a Folder of Resumes](https://developers.hrflow.ai/docs/parse-a-folder-of-resumes.md): Learn how to efficiently parse a folder of resumes in HrFlow.ai using the add_folder function. - [πŸ‘€ Validate Profile Data with HrFlow.ai SDK](https://developers.hrflow.ai/docs/validate-profile-data-with-hrflowai-sdk.md): Learn how to validate and manage profile data before sending it to the HrFlow.ai API, reducing errors and ensuring data integrity. - [πŸ’Ό Validate Job Data with HrFlow.ai SDK](https://developers.hrflow.ai/docs/validate-job-data-with-hrflowai-sdk.md): Learn how to validate and manage job data before sending it to the HrFlow.ai API, reducing errors and ensuring data integrity. - [πŸ“Š Evaluate a Source of Profiles](https://developers.hrflow.ai/docs/evaluate-a-source-of-profiles.md): Learn how to evaluate the quality of HrFlow.ai's parsing models on your resumes. - [πŸ“Š Evaluate a Board of Jobs](https://developers.hrflow.ai/docs/evaluate-a-board-of-jobs.md): Learn how to evaluate the quality of HrFlow.ai's job parsing on your job postings. - [πŸ” Assess Profile Eligibility for Searching](https://developers.hrflow.ai/docs/assess-profile-eligibility-for-searching.md): Validate profiles for HrFlow.ai Searching API to unlock accurate and efficient searches. - [🧠 Assess Profile Eligibility for Scoring](https://developers.hrflow.ai/docs/assess-profile-eligibility-for-scoring.md): Validate profiles for HrFlow.ai Scoring API to unlock accurate and efficient matches. ## API Reference - [πŸ”‘ Try your API Keys](https://developers.hrflow.ai/reference/authentication.md): This endpoint allows you to learn how to add the right information to your API calls, so you can make them. - [πŸ”Œ Find Workflows in a Workspace](https://developers.hrflow.ai/reference/find-workflows-in-a-workspace.md): Retrieve all workflows for given team account - [πŸ”Œ Find Sources in a Workspace](https://developers.hrflow.ai/reference/get-all-sources.md): Retrieve all sources for given team account - [πŸ”Œ Get a Source from a Workspace](https://developers.hrflow.ai/reference/source.md): Retrieve the Source information a with Source key. - [πŸ“– The Profile Object](https://developers.hrflow.ai/reference/the-profile-object.md): Fields' description and JSON of the Profile Object. - [πŸ’Ύ Index a Profile in a Source](https://developers.hrflow.ai/reference/index-a-profile.md): This endpoint allows you to Index a Profile object. - [πŸ’Ύ Edit a Profile indexed in a Source](https://developers.hrflow.ai/reference/edit-a-profile.md): This endpoint allows you to edit the of JSON of Profile. - [πŸ’Ύ Get a Profile indexed in a Source](https://developers.hrflow.ai/reference/get-a-profile.md): This endpoint allows retrieving the Profile object. - [πŸ’Ύ Find Profiles stored in Sources](https://developers.hrflow.ai/reference/get-all-profiles.md): This endpoint allows you to retrieve the list of profiles stored in Sources. - [πŸ’Ύ Archive a Profile in a Source](https://developers.hrflow.ai/reference/archive-a-profile.md): This endpoint allows archiving a Profile. - [🧠 Parse a Resume in a Source](https://developers.hrflow.ai/reference/parse-a-resume.md): This endpoint allows you to Parse a Resume and create a Profile from it. - [🧠 Get a Resume Parsing from a Source](https://developers.hrflow.ai/reference/get-a-resume-parsing.md): This endpoint allows you to retrieve the Resume Parsing object attached to the Profile. - [🧠 Ask questions to a Profile indexed in a Source](https://developers.hrflow.ai/reference/ask-a-question-to-a-profile-indexed-in-a-source.md): This endpoint allows asking a question based on a Profile object. - [🧠 Unfold the career path of a Profile](https://developers.hrflow.ai/reference/unfold-a-profile.md): This endpoint allows predicting the future experiences and educations of a profile. - [🧠 Vectorize a Profile](https://developers.hrflow.ai/reference/vectorize-a-profile.md): Generate HR-native, cross-lingual vectors for Profiles to power SoTA HR-grade ML. - [🧠 Search Profiles indexed in Sources](https://developers.hrflow.ai/reference/search-profiles.md): This endpoint allows you to Search Profiles. - [🧠 Score Profiles indexed in Sources for a Job](https://developers.hrflow.ai/reference/score-profiles-for-a-job.md): This endpoint allows you to Score Profiles for Job. - [🧠 Match Profiles indexed in Sources to a Profile](https://developers.hrflow.ai/reference/match-profiles-indexed-in-sources-to-a-profile.md): This endpoint allows you to find Profiles similar to a target Profile. - [🧠 Grade Profiles indexed in a Source for a Job](https://developers.hrflow.ai/reference/grade-profiles-indexed-in-a-source-for-a-job.md): This endpoint allows grading a Profile for a Job. - [🧠 Explain a Profile recommendation for a Job](https://developers.hrflow.ai/reference/explain-a-profile-for-a-job.md): This endpoint allows you to explain a Profile recommendation for a Job. - [πŸ”Œ Find Boards in a Workspace](https://developers.hrflow.ai/reference/get-all-boards.md): Retrieve all boards for given team account. - [πŸ”Œ Get a Board from a Workspace](https://developers.hrflow.ai/reference/get-a-board.md): Retrieve the Board information a with Board key. - [πŸ“– The Job Object](https://developers.hrflow.ai/reference/the-job-object.md): Fields' description and JSON of the Job Object. - [πŸ’Ύ Index a Job in a Board](https://developers.hrflow.ai/reference/index-a-job.md): This endpoint allows you to Index a Job object. - [πŸ’Ύ Edit a Job indexed in a Board](https://developers.hrflow.ai/reference/edit-a-job.md): This endpoint allows you to edit the of JSON of Job. - [πŸ’Ύ Get a Job indexed in a Board](https://developers.hrflow.ai/reference/get-a-job.md): This endpoint allows retrieving the Job object. - [πŸ’Ύ Archive a Job in a Board](https://developers.hrflow.ai/reference/archive-a-job.md): This endpoint allows archiving a Job. - [πŸ’Ύ Find Jobs stored in Boards](https://developers.hrflow.ai/reference/get-all-jobs.md): This endpoint allows you to retrieve the list of jobs stored in a Board. - [🧠 Ask questions to a Job indexed in a Board](https://developers.hrflow.ai/reference/ask-a-question-to-a-job-indexed-in-a-board.md): This endpoint allows asking a question based on a Job object. - [🧠 Vectorize a Job](https://developers.hrflow.ai/reference/vectorize-a-job.md): Generate HR-native, cross-lingual vectors for Jobs to power SoTA HR-grade ML. - [🧠 Search Jobs indexed in Boards](https://developers.hrflow.ai/reference/search-jobs.md): This endpoint allows you to Search Jobs. - [🧠 Score Jobs indexed in Boards for a Profile](https://developers.hrflow.ai/reference/score-jobs-for-a-profile.md): This endpoint allows you to Score Jobs for Profile. - [🧠 Match Jobs indexed in Boards to a Job](https://developers.hrflow.ai/reference/match-jobs-indexed-in-boards-to-a-job.md): This endpoint allows you to find Jobs similar to a target Job. - [🧠 Explain a Job recommendation for a Profile](https://developers.hrflow.ai/reference/explain-a-job-for-a-profile.md): This endpoint allows you to explain a job recommendation for a Profile. - [🧠 Parse a raw Text](https://developers.hrflow.ai/reference/parse-a-raw-text.md): Extract over 50 data point from any raw input text. - [🧠 Tag a Text](https://developers.hrflow.ai/reference/tag-a-text.md): Predict most likely tags for a text with our library of AI algorithms. - [🧠 Vectorize a Text](https://developers.hrflow.ai/reference/vectorize-a-text.md): Generate HR-native, cross-lingual vectors for texts to power SoTA HR-grade ML. - [🧠 Generate a job scene illustration](https://developers.hrflow.ai/reference/text-imaging.md): This endpoint allows you to generate an image that illustrates a job description. - [🧠 Find Synonyms for a Word](https://developers.hrflow.ai/reference/get-synonyms.md): Find synonyms or the top N most similar words to a word. - [🧠 Geocode a location text](https://developers.hrflow.ai/reference/geocode-a-text.md): Access our API endpoint to retrieve geojson data for any textual location input, enabling seamless integration of spatial data into your applications and systems. - [🧠 OCR a Text](https://developers.hrflow.ai/reference/ocr-a-text.md): This endpoint allows you to extract a text from a document across all formats (pdf, docx, png, and more) - [⭐ Rate a Profile or a Job](https://developers.hrflow.ai/reference/post-rating.md): This endpoint allows you to rate a Profile (resp. a Job) for Job (resp. a Profile) as a recruiter (resp. a candidate) with a score between 0 and 1. - [⭐ Get Ratings](https://developers.hrflow.ai/reference/get-ratings.md): This endpoint allows you to retrieve the list of ratings. - [⭐ Track a Profile or a Job](https://developers.hrflow.ai/reference/post-tracking.md): This endpoint allows you to track a Profile (resp. a Job) for Job (resp. a Profile) as a recruiter (resp. a candidate) with a specific action - [⭐ Get Trackings](https://developers.hrflow.ai/reference/get-trackings.md): This endpoint allows you to retrieve the list of trackings. - [⭐ [NEW] Get a taxonomy](https://developers.hrflow.ai/reference/gettaxonomy.md): Retrieve a single taxonomy and all its tags by key. - [⭐ [NEW] List taxonomies](https://developers.hrflow.ai/reference/listtaxonomies.md): Return all taxonomies for the authenticated team. Tags are not included. - [⭐ [NEW] Create a taxonomy](https://developers.hrflow.ai/reference/createtaxonomy.md): Create a new taxonomy. If `tags` is provided the array fully replaces the initial tag set (batch upsert semantics - exactly one tag must have `"default": true`). If `tags` is omitted, an *"others"* tag is created automatically as the default. - [⭐ [NEW] Update a taxonomy](https://developers.hrflow.ai/reference/updatetaxonomy.md): Update taxonomy fields and/or its tags. Only provided fields are changed. If `tags` is provided it **replaces** the entire tag set (batch upsert semantics): tags absent from the array are deleted, tags present are created or updated. Exactly one tag must have `"default": true`. Omit `tags` to leave tags unchanged. Pass `null` for `parent_key` or `classifier_key` to remove them. - [⭐ [NEW] Delete a taxonomy](https://developers.hrflow.ai/reference/deletetaxonomy.md): Permanently delete a taxonomy and all its tags. - [⭐ [NEW] Get a tag](https://developers.hrflow.ai/reference/gettag.md): Retrieve a single tag by its key. - [⭐ [NEW] Create a tag](https://developers.hrflow.ai/reference/createtag.md): Add a single tag to an existing taxonomy. **Validation:** - `value` must be unique within the taxonomy (`409` on collision). - `default: true` automatically demotes the previous default tag to `false`. - [⭐ [NEW] Update a tag](https://developers.hrflow.ai/reference/updatetag.md): Update one or more fields of an existing tag. Only provided fields are changed. **Validation:** - `value` must remain unique within the taxonomy (`409` on collision). - `default: true` automatically demotes the previous default tag to `false`. Pass `null` for `parent_key` to remove the parent relationship. - [⭐ [NEW] Delete a tag](https://developers.hrflow.ai/reference/deletetag.md): Permanently delete a tag. ## Changelog - [Scoring and Searching API: add new method POST](https://developers.hrflow.ai/changelog/scoring-and-searching-api-add-new-method-post.md) - [Grading API: Profiles and Jobs Added to Responses](https://developers.hrflow.ai/changelog/grading-api-profiles-and-jobs-added-to-responses.md) - [Grading API: One-to-One Profile-to-Job Matching](https://developers.hrflow.ai/changelog/grading-api-one-to-one-profile-to-job-matching-1.md) - [Asking API: Natural Language Q&A for Profiles & Jobs](https://developers.hrflow.ai/changelog/asking-api-natural-language-qa-for-profiles-jobs.md) - [Text Tagging API: Introducing 3 New Taggers](https://developers.hrflow.ai/changelog/text-tagging-api-introducing-3-new-taggers.md) - [Scoring API: raw_filters + score_threshold](https://developers.hrflow.ai/changelog/scoring-api-raw_filters-score_threshold-1.md) - [Searching API : Introduction of raw_filter Parameter](https://developers.hrflow.ai/changelog/searching-api-introduction-of-raw_filter-parameter.md) - [Text Tagging API: Introudcing New Taggers Based on ROME 4.0 Classification](https://developers.hrflow.ai/changelog/text-tagging-api-introudcing-new-taggers-based-on-the-lastest-rome-40-referential.md) - [Profile Parsing API: Mozart becomes Atlas, a 3.3x faster AI Model](https://developers.hrflow.ai/changelog/profile-parsing-api-mozart-becomes-atlas-a-33x-faster-ai-model.md) - [Text Parsing API: Handling HTML Text](https://developers.hrflow.ai/changelog/text-parsing-api-handling-html-text.md)