CAREER PLANNER
API DOCUMENTATION
Nobl Career Planner - 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 Career Planner 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 user profiles and returns career tranisition predicitons.
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 computation of skill gaps between profile and a job as well as between two jobs. The API calls are described in detail below including their required parameters, data formats, possible responses and examples.
Job skill gap.
Computes the skill gap between two jobs.
Authorizations:
Request Body schema: application/jsonrequired
source_occupation required | string The ESCO code of the source occupation/job. |
target_occupation required | string The ESCO code of the target occupation/job. |
Responses
Request samples
- Payload
{- "source_occupation": "string",
- "target_occupation": "string"
}
Response samples
- 200
{- "essential_skill_competence": [
- "string"
], - "essential_knowledge": [
- "string"
], - "optional_skill_competence": [
- "string"
], - "optional_knowledge": [
- "string"
]
}
Profile skill gap.
Computes the skill gap between a profile and a job.
Authorizations:
Request Body schema: application/jsonrequired
required | object (Profile) A user profile. |
target_occupation required | string The ESCO code of the target occupation/job. |
Responses
Request samples
- Payload
{- "profile": {
- "external_id": "string",
- "addresses": [
- "string"
], - "description": "string",
- "skills": [
- "string"
], - "degrees": [
- {
- "title": "string",
- "institution": "string",
- "description": "string",
- "level": "string",
- "attendance_start_datetime": "2019-08-24T14:15:22Z",
- "attendance_end_datetime": "2019-08-24T14:15:22Z"
}
], - "experiences": [
- {
- "title": "string",
- "organization_name": "string",
- "description": "string",
- "job_start_datetime": "2019-08-24T14:15:22Z",
- "job_end_datetime": "2019-08-24T14:15:22Z"
}
], - "last_updated_datetime": "2019-08-24T14:15:22Z",
- "publication_datetime": "2019-08-24T14:15:22Z"
}, - "target_occupation": "string"
}
Response samples
- 200
{- "essential_skill_competence": [
- "string"
], - "essential_knowledge": [
- "string"
], - "optional_skill_competence": [
- "string"
], - "optional_knowledge": [
- "string"
]
}
The API exposes a number of calls that allow computation of typical transitions between a profile and a job as well as between two jobs. The API calls are described in detail below including their required parameters, data formats, possible responses and examples.
Job typical transitions.
Computes the typical transitions between two jobs.
Authorizations:
Request Body schema: application/jsonrequired
source_occupation required | string The ESCO code of the source occupation/job. |
direction required | string Enum: "in" "out" The direction of the typical transitions calculation. Can be either 'in' or 'out'. |
limit | integer <= 10 Default: 10 The number of results to return. |
Responses
Request samples
- Payload
{- "source_occupation": "string",
- "direction": "in",
- "limit": 10
}
Response samples
- 200
{- "occupations": [
- "string"
], - "scores": [
- 0
]
}
Profile typical transitions.
Computes the typical transitions between a profile and a job.
Authorizations:
Request Body schema: application/jsonrequired
required | object (Profile) A user profile. |
direction required | string Enum: "in" "out" The direction of the typical transitions calculation. Can be either 'in' or 'out'. |
limit | integer <= 10 Default: 10 The number of results to return. |
Responses
Request samples
- Payload
{- "profile": {
- "external_id": "string",
- "addresses": [
- "string"
], - "description": "string",
- "skills": [
- "string"
], - "degrees": [
- {
- "title": "string",
- "institution": "string",
- "description": "string",
- "level": "string",
- "attendance_start_datetime": "2019-08-24T14:15:22Z",
- "attendance_end_datetime": "2019-08-24T14:15:22Z"
}
], - "experiences": [
- {
- "title": "string",
- "organization_name": "string",
- "description": "string",
- "job_start_datetime": "2019-08-24T14:15:22Z",
- "job_end_datetime": "2019-08-24T14:15:22Z"
}
], - "last_updated_datetime": "2019-08-24T14:15:22Z",
- "publication_datetime": "2019-08-24T14:15:22Z"
}, - "direction": "in",
- "limit": 10
}
Response samples
- 200
{- "occupations": [
- "string"
], - "scores": [
- 0
]
}
The API exposes a number of calls that allow computation of trajectories between two jobs. The API calls are described in detail below including their required parameters, data formats, possible responses and examples.
Job trajectory.
Computes the trajectory between two jobs.
Authorizations:
Request Body schema: application/jsonrequired
source_occupation required | string The ESCO code of the source occupation/job. |
target_occupation required | string The ESCO code of the target occupation/job. |
type | string Default: "data" Enum: "data" "skill" The type of job trajectory calculation. Can be either 'data' based or 'skill' based. |
Responses
Request samples
- Payload
{- "source_occupation": "string",
- "target_occupation": "string",
- "type": "data"
}
Response samples
- 200
{- "source_occupation": "string",
- "target_occupation": "string",
- "occupations": [
- "string"
], - "scores": [
- 0
]
}
The API exposes a number of calls that allow tagging of degrees with skills. The API calls are described in detail below including their required parameters, data formats, possible responses and examples.
Degree skills.
Tags a degree with skills.
Authorizations:
Request Body schema: application/jsonrequired
required | object (Degree) A study degree. |
Responses
Request samples
- Payload
{- "degree": {
- "title": "string",
- "institution": "string",
- "description": "string",
- "level": "string",
- "attendance_start_datetime": "2019-08-24T14:15:22Z",
- "attendance_end_datetime": "2019-08-24T14:15:22Z"
}
}
Response samples
- 200
{- "skill": [
- "string"
], - "score": [
- 0
]
}