POST: /job/indexing

This endpoint allows you to add new Job to a given board.

Please find below an example of json job that you can upload.

{
"name": "Data Engineer",
"agent_key": null,
"reference": "Job's reference abc",
"url": "https://www.pole-emploi.ai/jobs/data_engineer",
"summary": "As an engineer for the Data Engineering Infrastructure team,
you will design, build, scale, and evolve our data engineering
platform, services and tooling. Your work will have a critical
impact on all areas of business: powering core data pipelines,
supporting detailed internal analytics, calculating customer
usage, securing our platform, and much more.",
"location": {
"text": "Dampierre en Burly (45)",
"geopoint": {
"lat": 47.7667,
"lon": 2.5167
}
},
"sections": [{
"name": "profile",
"title": "Searched Profile",
"description": "Bac+5"
},
.
.
.
],
"skills": [{
"name": "python",
"value": null
},
{
"name": "spark",
"value": 0.9
},
.
.
.
],
"languages": [{
"name": "english",
"value": 1
},
{
"name": "french",
"value": 1
},
.
.
.
],
"tags": [{
"name": "archive",
"value": true
},
{
"name": "tag example",
"value": "tag"
},
.
.
.
],
"ranges_date": [{
"name": "Dates",
"value_min": "2020-05-18T21:59",
"value_max": "2020-09-15T21:59"
},
.
.
.
],
"ranges_float": [{
"name": "salary",
"value_min": 30,
"value_max": 40,
"unit": "eur"
},
.
.
.
],
"metadatas": [{
"name": "metadata example",
"value": "metadata"
},
.
.
.
],
}

You can include complementary information such as :

  • job's tags,

  • job's metadata.

post
Post /job/indexing

https://api.hrflow.ai/v1/job/indexing
This endpoint allows you to post job json.
Request
Response
Request
Headers
X-API-KEY
required
string
Authentication token
X-USER-EMAIL
required
string
User's email.
Body Parameters
board_key
required
string
The key of the board in which the Job will be added
name
required
string
The Job's title
agent_key
optional
string
The Agent unique identifier to attach to this Job
reference
required
string
The Job's reference, it is unique for a given board
created_at
required
string
The creation date in iso Format
url
required
string
The Job's url
summary
required
string
A brief summary to describe missions and context of the Job
sections
required
array
The Job's sections (ie. [{ "name": "section_name", "title": "section_title", "description": "section_description"}...])
location
required
object
Job's location (ie. { "text": "xx rue XXXX" , "geopoint": { "lat":38.299637 , "lng": -122.657535 } })
skills
required
array
The Job's required skills (ie. [{"name": "skill", "type":"hard or soft", "value":0.8}, ...])
languages
required
array
The Job's required languages (ie. [{"name": "language", "value": 0.7}, ...])
tags
required
array
The Job's tags to include with the Job (ie. [{"name": "tag", "value":"tag_value"}, ...])
metadatas
required
array
The Job's metadata (ie. [{"name": "meta", "value":"meta_value"}, ...])
ranges_float
required
array
The Job's ranges float (ie. [{ 'name': 'salary', 'unit': 'eur', 'value_max': 50, 'calue_min': 30} ...])
ranges_date
required
array
The Job's ranges date (ie. [{ 'name': 'dates', 'value_max': '2020-09-15T21:59', 'value_min': '2020-05-18T21:59'}...])
Response
200: OK
Job successfully created.
{
"code": 201,
"message": "Job created",
"data": {
"id": id,
"key": "job_key",
"reference": "Job's reference 12",
"name": "Data Engineer",
"url": "https://www.pole-emploi.ai/jobs/data_engineer",
"summary": "As an engineer for the Data Engineering Infrastructure team, you will design, build, scale, and evolve our data engineering platform, services and tooling. Your work will have a critical impact on all areas of business: powering core data pipelines, supporting detailed internal analytics, calculating customer usage, securing our platform, and much more.",
"sections": [
{
"name": "profile",
"title": "Searched Profile",
"description": "Bac+5"
}
],
"location": {
"text": "Dampierre en Burly (45)",
"lat": null,
"lng": null,
"gmaps": null,
"fields": null
},
"skills": [
{
"name": "python",
"value": null
},
{
"name": "spark",
"value": 0.90000000000000002
}
],
"languages": [
{
"name": "english",
"value": 1
},
{
"name": "french",
"value": 1
}
],
"tags": [
{
"name": "archive",
"value": true
},
{
"name": "tag example",
"value": "tag"
}
],
"ranges_float": [
{
"name": "salary",
"value_min": 30,
"value_max": 40,
"unit": "eur"
}
],
"ranges_date": [
{
"name": "Dates",
"value_min": "2020-05-18T21:59",
"value_max": "2020-09-15T21:59"
}
],
"updated_at": "2020-06-11T14:43:29+0000",
"created_at": "2020-06-11T14:43:29+0000"
}
}
401: Unauthorized
Invalid secret key.
{
"code": 401,
"message": "Unauthorized. Invalid secret key: xxxxx "
}
Python
Javascript
Python
from hrflow import Hrflow
client = Hrflow(api_secret="Your API Key", api_user="Your API user email")
job_json = {
"name": "Data Engineer",
"agent_key": None,
"reference": "123",
"url": "https://www.pole-emploi.ai/jobs/data_engineer",
"summary": """As an engineer for the Data Engineering Infrastructure team,
you will design, build, scale, and evolve our data engineering
platform, services and tooling. Your work will have a critical
impact on all areas of business: powering core data pipelines,
supporting detailed internal analytics, calculating customer
usage, securing our platform, and much more.""",
"location": {
"text": "Dampierre en Burly (45)",
"geopoint": {
"lat": 47.7667,
"lon": 2.5167
}
},
"sections": [{
"name": "profile",
"title": "Searched Profile",
"description": "Bac+5"
}],
"skills": [{
"name": "python",
"value": None},
{
"name": "spark",
"value": 0.9
}],
"languages": [{
"name": "english",
"value": 1
},
{
"name": "french",
"value": 1
}],
"tags": [{
"name": "archive",
"value": True
},
{
"name": "tag example",
"value": "tag"
}],
"ranges_date": [{
"name": "Dates",
"value_min": "2020-05-18T21:59",
"value_max": "2020-09-15T21:59"
}],
"ranges_float": [{
"name": "salary",
"value_min": 30,
"value_max": 40,
"unit": "eur"
}],
"metadatas": [{
"name": "metadata example",
"value": "metadata"
}],
}
client.job.indexing.add_json(board_key="board_key", job_json=job_json)
Javascript
import Hrflow from 'hrflow';
const client = new Hrflow({
api_secret: "Your API Key",
api_user: "Your API user email"
});
client.job.indexing.addJosn("board_key", {
"name": "Data Engineer",
"agent_key": None, #Scoring engine
"reference": "123",
"url": "https://www.pole-emploi.ai/jobs/data_engineer",
"summary": "As an engineer for the Data Engineering Infrastructure team,
you will design, build, scale, and evolve our data engineering
platform, services and tooling. Your work will have a critical
impact on all areas of business: powering core data pipelines,
supporting detailed internal analytics, calculating customer
usage, securing our platform, and much more.",
"location": {
"text": "Dampierre en Burly (45)",
"geopoint": {
"lat": 47.7667,
"lon": 2.5167
}
},
"sections": [{
"name": "profile",
"title": "Searched Profile",
"description": "Bac+5"
}],
"skills": [{
"name": "python",
"value": null
},
{
"name": "spark",
"value": 0.9
}],
"languages": [{
"name": "english",
"value": 1
},
{
"name": "french",
"value": 1
}],
"tags": [{
"name": "archive",
"value": true
},
{
"name": "tag example",
"value": "tag"
}],
"ranges_date": [{
"name": "Dates",
"value_min": "2020-05-18T21:59",
"value_max": "2020-09-15T21:59"
}],
"ranges_float": [{
"name": "salary",
"value_min": 30,
"value_max": 40,
"unit": "eur"
}],
"metadatas": [{
"name": "metadata example",
"value": "metadata"
}],
});