POST : /document/parsing

This endpoint allows you to generate text parsing from a full text input.

post
Post /document/parsing

https://api.hrflow.ai/v1/document/parsing
Request
Response
Request
Headers
X-API-KEY
required
string
Authentication token.
X-USER-EMAIL
required
string
User's email.
Body Parameters
text
required
string
Text to be parsed
Response
200: OK
Parsing is succuessfully generated
{
"code": 200,
"message": "Parsing results",
"data": {
"ents": [
{
"end": 11,
"label": "Person",
"start": 0
},
{
"end": 33,
"label": "Job_title",
"start": 17
}
],
"text": "Harry Potter is a Python Enginner"
}
}
400: Bad Request
Text can't be null.
{
"code": 400,
"message": "Bad request. Text cannot be null"
}
401: Unauthorized
Invalid secret key
{
"code": 401,
"message": "Unauthorized. Invalid secret key: xxxx for permission: write"
}

As output , this API sends you back all parsed entities.

There are 17 labels :

  • FirstName

  • LastName

  • Date

  • Duration

  • Location

  • Company

  • JobTitle

  • Task

  • School

  • EduTitle

  • Course

  • Skill

  • Certification

  • Language

  • Interest

  • Email

  • Phone

Python
Javascript
Python
from hrflow import Hrflow
client = Hrflow(api_secret="Your API Key", api_user="Your API user email")
response = client.document.parsing.post(text="Harry Potter is a Python Enginner")
Javascript
import Hrflow from 'hrflow';
const client = new Hrflow({
api_secret: 'Your API Key',
api_user: 'Your API user email'
});
client.document.parsing.post("Harry Potter is a Python Enginner")
.then(response => {
console.log(response);
// ...
});