OCCUPATION TAGGER
API DOCUMENTATION
ESCO Occupation Tagger - API Reference
Download OpenAPI specification:Download
The HR Software linking job and applicant without ifs, buts, or maybes.
API Support: support@nobl.ai | Website: www.nobl.ai.
The Nobl ESCO classification API follows the principles of REST, providing a straightforward and efficient way to interact with various resources. The API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
The API accepts JSON encoded job descriptions and returns ESCO code predictions. Suggested ESCO codes can also be added to job descriptions.
The Nobl API uses API Keys to authenticate requests. A client_id
and client_secret
will be provided by the Nobl support team allowing for
authentication at the /auth endpoint. Upon successful authentication, a time-limited Access Token will be received and can be used to authorize subsequent
requests by including the header Authorization: {access_token}
. The complete documentation of the authentication POST call is summarized below including
required parameters, data formats, possible responses, and examples.
API authentication.
Authenticates a client with the Nobl API using client_id
and client_secret
.
header Parameters
Content-Type required | string |
X-Amz-Target required | string |
Request Body schema: application/jsonrequired
client_id required | string The client ID. |
client_secret required | string The client secret. |
scope | string Default: "api/ALL" The authentication scope. |
type | string (TypeEnum) Default: "client" Enum: "client" "user" The type of user being authenticated. |
Responses
Request samples
- Payload
{- "client_id": "string",
- "client_secret": "string",
- "scope": "api/ALL",
- "type": "client"
}
The API exposes a number of calls that allow for the addition or updating of resources such as jobs and ESCO codes. Next, each of these API calls are described in detailed including their required parameters, data formats, possible responses and examples.
Add or update ESCO.
Adds or updates a job's suggested ESCO codes.
Authorizations:
Request Body schema: application/jsonrequired
job_id required | string The |
esco_codes required | Array of strings The array of suggested ESCO codes to add. |
functiontypes | Array of strings The array of (internal) functiontypes that apply to the job. |
Responses
Request samples
- Payload
{- "job_id": "string",
- "esco_codes": [
- "string"
], - "functiontypes": [
- "string"
]
}
Add or update job.
Adds or updates a job. If the job_id
exists, its informations is updated, otherwise a new job is created.
Authorizations:
Request Body schema: application/jsonrequired
job_id required | string The unique entity identifier or |
title required | string <= 500 characters The title of the job vacancy. |
description required | string <= 100000 characters The description of the job vacancy. |
required_qualifications | Array of strings Default: [] The array of descriptions of each qualification and skill required by the job vacancy. |
Responses
Request samples
- Payload
{- "job_id": "string",
- "title": "string",
- "description": "string",
- "required_qualifications": [ ]
}
Exposes functionalities for fetching the ESCO codes of jobs. More specifically, a GET method allows users to obtain the ESCO codes of a job with given job_id
.
The API calls are described in detail below including their required parameters, data formats, possible responses and examples.