Aglae.ai API (1.0)

Download OpenAPI specification:Download

The documentation of Aglae.ai API services.

Say hello 👋

Useful to verify your authentication is working

Responses

Response samples

default

Content type

application/json

[{"message": "string"
}
]

Job Seeker

Upsert Job Seeker in order to match with offers

Request Body schema: application/json
required

updatedAt required	string <date-time>
required	Array of objects (Experience)
id required	string
encryptedFirstName required	string
encryptedLastName required	string
encryptedPhoneNumber required	string
office required	string
officeCode required	string
profile required	string
consentToSmsReception required	boolean
consentToEmailReception required	boolean
required	Array of objects (DesiredJob)
required	Array of objects (Training)
required	Array of objects (LanguageLevel)
required	Array of objects (License)
skills required	Array of strings
availabilityScore required	number

Responses

Request samples

Payload

Content type

application/json

{"updatedAt": "2019-08-24T14:15:22Z",
"experiences": [{"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"duration": 0,
"jobTitle": "string",
"description": "string",
"companyName": "string",
"location": "string"
}
],
"id": "string",
"encryptedFirstName": "string",
"encryptedLastName": "string",
"encryptedPhoneNumber": "string",
"office": "string",
"officeCode": "string",
"profile": "string",
"consentToSmsReception": true,
"consentToEmailReception": true,
"desiredJobs": [{"romeId": "string",
"romeLabel": "string",
"romeDescriptionId": "string",
"romeDescriptionLabel": "string",
"minimumContractDuration": 0,
"maximumContractDuration": 0,
"desiredWage": 0,
"desiredWageUnit": "string",
"experienceDuration": 0,
"experienceDurationUnit": "string",
"mobilityDistance": 0,
"mobilityDistanceUnit": "string",
"jobTypology": "string",
"topore": true,
"topcreffranchise": true,
"topcrefcreation": true,
"topcrefreprise": true
}
],
"trainings": [{"title": "string",
"description": "string",
"graduationYear": 0
}
],
"languagesLevel": [{"language": "string",
"level": "FLUENT"
}
],
"licenses": [{"type": "string",
"label": "string"
}
],
"skills": ["string"
],
"availabilityScore": 0
}

CSV Upload

Upsert Job Seekers in CSV format

query Parameters

tarGz	boolean
fileName	string

Request Body schema: multipart/form-data
required

file	string <binary>

Responses

Upsert Offers in CSV format

query Parameters

tarGz	boolean
fileName	string

Request Body schema: multipart/form-data
required

file	string <binary>

Responses

Upsert Offers / Job Seeker connections in CSV format

Request Body schema: multipart/form-data
required

file	string <binary>

Responses

Offer

Upsert Offer in order to match with job seekers

Request Body schema: application/json
required

createdAt required	string <date-time>
updatedAt required	string <date-time>
validationDate required	string or null <date-time>
id required	string
state required	string
stateLabel required	string
topoffrepartenaireaom required	boolean
screeningMode required	string
screeningModeLabel required	string
unitesuivi required	number
romeId required	string
romeLabel required	string
romeDescriptionId required	string
romeDescriptionLabel required	string
title required	string
description required	string
initialOpenPositions required	number
remainingOpenPositions required	number
required	Array of objects or null (Language)
required	Array of objects or null (License)
duration required	number or null
durationUnit required	string or null
durationUnitLabel required	string or null
contractType required	string
contractTypeLabel required	string
contractSummary required	string
requiredExperience required	number or null
requiredExperienceUnit required	string or null
requiredExperienceComment required	string or null
requiredExperienceSummary required	string
minimumWage required	number or null
maximumWage required	number or null
durationMonth required	number or null
wageComment required	string or null
wageTypeLabel required	string
required	Array of objects or null (AdditionalPay)
wageSummary required	string or null
businessTripFrequencyLabel required	string or null
businessTripType required	string or null
workingConditionsSummary required	string or null
scheduleTypeLabel required	string or null
scheduleTypeDetail required	string or null
lblconditionexercice required	string
weeklyWorkedHours required	number
weeklyWorkedMinutes required	number or null
isPartTime required	boolean
scheduleSummary required	string
required	Array of objects or null (Skill)
required	Array of objects or null (Task)
required	Array of objects or null (SkillFreeText)
softSkills required	Array of strings or null
required	Array of objects or null (Training)
locationLabel required	string
zipCode required	string or null
cityZipCode required	string or null
cityLabel required	string or null
departmentCode required	string or null
departmentLabel required	string or null
regionCode required	string or null
regionLabel required	string or null
countryLabel required	string
topfrontalierlieutravail required	boolean
locationSummary required	string
latitude required	number or null
longitude required	number or null
siret required	string or null
companyDescription required	string or null
companyName required	string
subClassNAF required	string
subClassNAFLabel required	string
companySummary required	string or null

Responses

Request samples

Payload

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"validationDate": "2019-08-24T14:15:22Z",
"id": "string",
"state": "string",
"stateLabel": "string",
"topoffrepartenaireaom": true,
"screeningMode": "string",
"screeningModeLabel": "string",
"unitesuivi": 0,
"romeId": "string",
"romeLabel": "string",
"romeDescriptionId": "string",
"romeDescriptionLabel": "string",
"title": "string",
"description": "string",
"initialOpenPositions": 0,
"remainingOpenPositions": 0,
"languages": [{"code": "string",
"label": "string",
"proficiencyLevel": 0,
"proficiencyLevelLabel": "string",
"exigibilitelangue": "string"
}
],
"licenses": [{"type": "string",
"label": "string"
}
],
"duration": 0,
"durationUnit": "string",
"durationUnitLabel": "string",
"contractType": "string",
"contractTypeLabel": "string",
"contractSummary": "string",
"requiredExperience": 0,
"requiredExperienceUnit": "string",
"requiredExperienceComment": "string",
"requiredExperienceSummary": "string",
"minimumWage": 0,
"maximumWage": 0,
"durationMonth": 0,
"wageComment": "string",
"wageTypeLabel": "string",
"additionalPays": [{"code": "string",
"label": "string"
}
],
"wageSummary": "string",
"businessTripFrequencyLabel": "string",
"businessTripType": "string",
"workingConditionsSummary": "string",
"scheduleTypeLabel": "string",
"scheduleTypeDetail": "string",
"lblconditionexercice": "string",
"weeklyWorkedHours": 0,
"weeklyWorkedMinutes": 0,
"isPartTime": true,
"scheduleSummary": "string",
"skills": [{"code": 0,
"label": "string",
"exigibility": "string"
}
],
"tasks": [{"code": 0,
"label": "string",
"exigibility": "string"
}
],
"skillsFreeText": [{"description": "string",
"exigibility": "string"
}
],
"softSkills": ["string"
],
"trainings": [{"title": "string",
"description": "string",
"graduationYear": 0
}
],
"locationLabel": "string",
"zipCode": "string",
"cityZipCode": "string",
"cityLabel": "string",
"departmentCode": "string",
"departmentLabel": "string",
"regionCode": "string",
"regionLabel": "string",
"countryLabel": "string",
"topfrontalierlieutravail": true,
"locationSummary": "string",
"latitude": 0,
"longitude": 0,
"siret": "string",
"companyDescription": "string",
"companyName": "string",
"subClassNAF": "string",
"subClassNAFLabel": "string",
"companySummary": "string"
}

Expose offer computed criteria with suggested values

path Parameters

offerId

required

string

Responses

Response samples

200

Content type

application/json

{"criteria": [{"code": "string",
"label": "string",
"question": "string",
"isSuggested": true
}
],
"firstMessage": "string"
}

Matching qualification

Starts a session to qualify job seekers following the given criteria with Aglae matching

path Parameters

offerId

required

string

Request Body schema: application/json
required

required	Array of objects (MatchingJobSeeker)
criterionCodes required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"jobSeekers": [{"id": "string",
"phoneNumber": "string",
"firstName": "string"
}
],
"criterionCodes": ["string"
]
}

Response samples

201
400

Content type

application/json

{"failures": [{"reason": "INVALID_PHONE_NUMBER",
"jobSeekerId": "string"
}
]
}

Expose offer qualification details about job seekers

path Parameters

offerId

required

string

Request Body schema: application/json
required

profileType required	string (ProfileTypeFilterEnum) Enum: "ALL" "REGISTERED" "POOL" "AGENCY"
qualificationStatus required	string (MatchingQualificationStatusFilterEnum) Enum: "ALL" "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED" "PREQUALIFIABLE"
agencyCode	string
required	object (OfferQualificationDetailsPagination)

Responses

Request samples

Payload

Content type

application/json

{"profileType": "ALL",
"qualificationStatus": "ALL",
"agencyCode": "string",
"pagination": {"limit": 1,
"offset": 0
}
}

Response samples

200

Content type

application/json

{"jobSeekers": [{"id": "string",
"encryptedFirstName": "string",
"encryptedLastName": "string",
"encryptedPhoneNumber": "string",
"bestSearchedJob": "string",
"matching": {"score": 0,
"dimensionalScores": [{"type": "AVAILABILITY",
"score": 0,
"explainability": "string",
"weight": 0
}
]
},
"qualification": {"status": "ONGOING",
"conversation": {"id": "string",
"evaluation": {"isPositive": true,
"comment": "string"
}
},
"personalInformation": {"firstName": "string",
"phoneNumber": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"messages": [{"id": "string",
"content": "string",
"createdAt": "2019-08-24T14:15:22Z",
"originator": "JOB_SEEKER"
}
],
"criteria": [{"code": "string",
"label": "string",
"question": "string",
"status": "PENDING",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"previousCriteria": [{"code": "string",
"label": "string",
"question": "string",
"status": "PENDING",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"isSelectable": true,
"notSelectableReason": "string"
}
],
"totalJobSeekers": 0,
"ready": true
}

Expose IDs of job seeker matching an offer

path Parameters

offerId

required

string

Request Body schema: application/json
required

profileType required	string (ProfileTypeFilterEnum) Enum: "ALL" "REGISTERED" "POOL" "AGENCY"
qualificationStatus required	string (MatchingQualificationStatusFilterEnum) Enum: "ALL" "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED" "PREQUALIFIABLE"
agencyCode	string
required	object (OfferQualificationDetailsPagination)

Responses

Request samples

Payload

Content type

application/json

{"profileType": "ALL",
"qualificationStatus": "ALL",
"agencyCode": "string",
"pagination": {"limit": 1,
"offset": 0
}
}

Response samples

200

Content type

application/json

{"jobSeekerIds": ["string"
]
}

Expose offer job seekers counters and qualified job seekers counters

path Parameters

offerId

required

string

Request Body schema: application/json
required

profileType required	string (ProfileTypeFilterEnum) Enum: "ALL" "REGISTERED" "POOL" "AGENCY"
qualificationStatus required	string (MatchingQualificationStatusFilterEnum) Enum: "ALL" "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED" "PREQUALIFIABLE"

Responses

Request samples

Payload

Content type

application/json

{"profileType": "ALL",
"qualificationStatus": "ALL"
}

Response samples

200

Content type

application/json

{"jobSeekerCounters": [{"code": "string",
"total": 0
}
],
"qualificationCounters": [{"code": "string",
"total": 0
}
]
}

Qualification

Expose offer IDs with completed qualification within a given time range

Request Body schema: application/json
required

startDate required	string <date-time>
endDate required	string <date-time>
statuses required	Array of strings Items Enum: "VALIDATED" "PARTIALLY_VALIDATED" "NOT_VALIDATED" "NO_ANSWER"

Responses

Request samples

Payload

Content type

application/json

{"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"statuses": ["VALIDATED"
]
}

Response samples

200

Content type

application/json

{"offerIds": ["string"
]
}

Expose job seekers qualification details

path Parameters

offerId

required

string

Request Body schema: application/json
required

qualificationStatus required	string (QualificationStatusForDetailsFilterEnum) Enum: "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED" "PREQUALIFIABLE"
jobSeekerIds required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"qualificationStatus": "ALL_QUALIFICATIONS",
"jobSeekerIds": ["string"
]
}

Response samples

200

Content type

application/json

{"jobSeekers": [{"id": "string",
"qualification": {"status": "ONGOING",
"matchingSource": "SDR",
"createdAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"messages": [{"id": "string",
"content": "string",
"createdAt": "2019-08-24T14:15:22Z",
"originator": "JOB_SEEKER"
}
],
"criteria": [{"code": "string",
"label": "string",
"question": "string",
"status": "PENDING",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"previousCriteria": [{"code": "string",
"label": "string",
"question": "string",
"status": "PENDING",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"matchingAglae": {"score": 0,
"dimensionalScores": [{"type": "AVAILABILITY",
"score": 0,
"explainability": "string",
"weight": 0
}
]
},
"isSelectable": true,
"notSelectableReason": "string"
}
]
}

Expose offer qualification counters

path Parameters

offerId

required

string

Request Body schema: application/json
required

profileType required	string (ProfileTypeFilterEnum) Enum: "ALL" "REGISTERED" "POOL" "AGENCY"
qualificationStatus required	string (QualificationStatusFilterEnum) Enum: "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED"

Responses

Request samples

Payload

Content type

application/json

{"profileType": "ALL",
"qualificationStatus": "ALL_QUALIFICATIONS"
}

Response samples

200

Content type

application/json

{"jobSeekerCounters": [{"code": "string",
"total": 0
}
],
"qualificationCounters": [{"code": "string",
"total": 0
}
]
}

Expose job seekers IDs matching the given qualification status

path Parameters

offerId

required

string

Request Body schema: application/json
required

qualificationStatus required	string (QualificationStatusFilterEnum) Enum: "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED"
profileType required	string (ProfileTypeFilterEnum) Enum: "ALL" "REGISTERED" "POOL" "AGENCY"

Responses

Request samples

Payload

Content type

application/json

{"qualificationStatus": "ALL_QUALIFICATIONS",
"profileType": "ALL"
}

Response samples

200

Content type

application/json

{"jobSeekerIds": ["string"
]
}

Starts a session to qualify job seekers following the given criteria without Aglae matching

path Parameters

offerId

required

string

Request Body schema: application/json
required

matchingSource required	string (InputQualificationMatchingSourceEnum) Enum: "SDR" "SDR_FEEDBACK_LOOP"
required	Array of objects (JobSeeker)
criterionCodes required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"matchingSource": "SDR",
"jobSeekers": [{"officeCode": "string",
"profile": "string",
"id": "string",
"phoneNumber": "string",
"firstName": "string",
"score": {"globalScore": 0,
"dimensionalScores": [{"type": "string",
"score": 0,
"explainability": "string",
"weight": 0
}
]
}
}
],
"criterionCodes": ["string"
]
}

Response samples

201
400

Content type

application/json

{"failures": [{"reason": "INVALID_PHONE_NUMBER",
"jobSeekerId": "string"
}
]
}

Finds the offer IDs with qualification sessions, among the given offer IDs

Request Body schema: application/json
required

offerIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"offerIds": ["string"
]
}

Response samples

200

Content type

application/json

{"offerIds": ["string"
]
}

Expose offers qualifications summary for the given offer IDs

Request Body schema: application/json
required

offerIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"offerIds": ["string"
]
}

Response samples

200

Content type

application/json

{"offers": [{"offerId": "string",
"qualifications": [{"createdAt": "2019-08-24T14:15:22Z",
"summaries": [{"status": "ONGOING",
"jobSeekerId": "string"
}
]
}
]
}
]
}

Matching feedback loop

Expose offer matching feedback loop and qualification details about job seekers

path Parameters

offerId

required

string

Request Body schema: application/json
required

matchingSource required	string (MatchingFeedbackLoopSourceEnum) Value: "SDR"
required	Array of objects (OfferMatchingFeedbackLoopJobSeekerInput)

Responses

Request samples

Payload

Content type

application/json

{"matchingSource": "SDR",
"jobSeekers": [{"id": "string",
"score": 0
}
]
}

Response samples

200

Content type

application/json

{"jobSeekers": [{"id": "string",
"initialScore": 0,
"computedScore": 0,
"dimensionalScores": [{"type": "string",
"score": 0,
"explainability": "string",
"weight": 0
}
]
}
]
}

Experimental

Expose knowledge extracted from conversations with job seekers

path Parameters

offerId

required

string

Responses

Response samples

200

Content type

application/json

[{"conversationId": "string",
"qualificationSessionId": "string",
"jobSeekerId": "string",
"offerId": "string",
"conversationCreationDatetime": "2019-08-24T14:15:22Z",
"conversationEndDatetime": "2019-08-24T14:15:22Z",
"conversationDurationMinutes": 0,
"criteria": [{"code": "string",
"label": "string",
"question": "string"
}
],
"messages": [{"messageId": "string",
"conversationId": "string",
"qualificationSessionId": "string",
"jobSeekerId": "string",
"offerId": "string",
"messageOriginator": "string",
"messageCreationDatetime": "2019-08-24T14:15:22Z",
"messageContent": "string",
"conversationStatus": "string",
"conversationFeeling": "string",
"askOptOut": true,
"isEthic": true,
"ethicReason": "string",
"isHumanNeeded": true,
"humanNeededReason": "string",
"isOtherSubject": true,
"otherSubject": "string"
}
],
"matchingScore": 0,
"matchingDetail": "string",
"category": "string",
"synthesis": "string",
"refusalReason": "string",
"satisfactionLevel": "string",
"askOptOut": true,
"hasAngryMessage": true,
"hasEthicMessage": true,
"isHumanNeeded": true,
"jobSeekerConversationEvaluationScore": 0
}
]

Aglae.ai API (1.0)

Say hello 👋

Responses

Response samples

Job Seeker

Upsert Job Seeker in order to match with offers

Request Body schema: application/jsonrequired

Responses

Request samples

CSV Upload

Upsert Job Seekers in CSV format

query Parameters

Request Body schema: multipart/form-datarequired

Responses

Upsert Offers in CSV format

query Parameters

Request Body schema: multipart/form-datarequired

Responses

Upsert Offers / Job Seeker connections in CSV format

Request Body schema: multipart/form-datarequired

Responses

Offer

Upsert Offer in order to match with job seekers

Request Body schema: application/jsonrequired

Responses

Request samples

Expose offer computed criteria with suggested values

path Parameters

Responses

Response samples

Matching qualification

Starts a session to qualify job seekers following the given criteria with Aglae matching

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Expose offer qualification details about job seekers

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Expose IDs of job seeker matching an offer

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Expose offer job seekers counters and qualified job seekers counters

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Qualification

Expose offer IDs with completed qualification within a given time range

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Expose job seekers qualification details

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Expose offer qualification counters

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Expose job seekers IDs matching the given qualification status

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Starts a session to qualify job seekers following the given criteria without Aglae matching

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required