GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints

🧠 Parse a raw Text

Extract over 50 data point from any raw input text.

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. 🧠 Activate Text Parsing API
🚧

Batch Mode with 'texts' parameter

  • Batch size = lenght(texts) should be < 32 (and a multiple of 2 for an optimum speed).

Request headers

FieldValue
Content-Typeapplication/json
X-API-KEYYour API Key.
X-USER-EMAILYour HrFlow.ai account's email.

Response

The Response contains a list ents of detected entities with the following structure.

FieldTypeDescription
startintPosition of the first char of the entity.
endintPosition of the last char of the entity.
labelstringName of the detected category

Text output Labels

Below is a list of the different labels supported by the text parsing:

LabelDescriptionExample
first_nameFirst NameJohn
last_nameLast NameDoe
dateDate2022-01-01
durationDuration6 months
locationLocation55 de la rue du Faubourg-Saint-Honoré, 75008 Paris France
companyCompany NameHrFlow.ai
job_titleJob TitleR&D Engineer
taskTaskManage a product team of 10 people
schoolSchool / Educational Institution NameHarvard University
education_titleEducation TitleM.Sc. in Software Engineering
courseCourse NameStatistical Learning
skill_hardHard SkillC++, JavaScript, SAGE
skill_softSoft SkillLeadership, Team spirit
certificationCertificates NamesISO 27001
languageLanguageSpanish, German
interestInterestVolleyball
emailEmail Address[email protected]
phonePhone+33765432109

📘

Job output Labels

If output_object="job" then the API call will return a Job object


📘

Profile output Labels

If output_object="profile" then the API call will return a Profile object

Body Params
texts
array of strings
required
Defaults to A professional responsible for overseeing a team of salespeople and sales,Heading an enterprise data science division requires strong skills in NLP and ML

Parse a list of texts. Each text can be : the full text of a Job, a Resume , a Profile, an experience, a Job and more. Maximum length is 16.

texts*
string
enum
required
Defaults to atlas

You can choose between: quicksilver for speed and atlas for accuracy.

Allowed:
string
enum
Defaults to text

This parameter will define the format of the output object.

Allowed:
Responses

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