📘
Prerequisites

✨ Create a Workspace

🔑 Get your API Key

🧠 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

Field	Value
`Content-Type`	`application/json`
`X-API-KEY`	Your API Key.
`X-USER-EMAIL`	Your HrFlow.ai account's email.

Response

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

Field	Type	Description
`start`	`int`	Position of the first char of the entity.
`end`	`int`	Position of the last char of the entity.
`label`	`string`	Name of the detected category

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

Label	Description	Example
`first_name`	First Name	John
`last_name`	Last Name	Doe
`date`	Date	2022-01-01
`duration`	Duration	6 months
`location`	Location	55 de la rue du Faubourg-Saint-Honoré, 75008 Paris France
`company`	Company Name	HrFlow.ai
`job_title`	Job Title	R&D Engineer
`task`	Task	Manage a product team of 10 people
`school`	School / Educational Institution Name	Harvard University
`education_title`	Education Title	M.Sc. in Software Engineering
`course`	Course Name	Statistical Learning
`skill_hard`	Hard Skill	C++, JavaScript, SAGE
`skill_soft`	Soft Skill	Leadership, Team spirit
`certification`	Certificates Names	ISO 27001
`language`	Language	Spanish, German
`interest`	Interest	Volleyball
`email`	Email Address	contact@hrflow.ai
`phone`	Phone	+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