Skill Parser API

Schemas

Error

errorstring
Error message
Example: Unauthorized

TechnicalSkill

namestring · required
Name of the skill
Example: Python
categorystring · required
Category of the skill
Example: Programming Languages
levelstring · required
Skill proficiency level
Example: Advanced
contextstring · required
Context where the skill was mentioned or inferred
Example: Required for data analysis and backend development

SoftSkill

namestring · required
Name of the skill
Example: Communication
categorystring · required
Category of the skill
Example: Interpersonal Skills
contextstring · required
Context where the skill was mentioned or inferred
Example: Mentioned in team collaboration responsibilities

DomainSkill

namestring · required
Name of the skill
Example: Financial Modeling
industrystring · required
Related industry
Example: Finance
contextstring · required
Context where the skill was mentioned or inferred
Example: Experience with financial forecasting models

SkillCount

totalinteger · required
Total number of skills
Example: 12
technicalinteger · required
Number of technical skills
Example: 7
softinteger · required
Number of soft skills
Example: 3
domaininteger · required
Number of domain skills
Example: 2

SkillsData

skillsobject · required
key_insightsstring[] · required
Example: ["Strong emphasis on programming and data analysis skills","Leadership and project management are highlighted as important soft skills"]
skill_countobject · required

SkillsResponse

successboolean · required
Whether the request was successful
Example: true
parsed_atstring · date-time · required
Timestamp when the skills were parsed
Example: 2025-03-10T09:45:12.021Z
typestring · required
Type of text that was analyzed
Example: job_description
dataobject · required

MatchedSkill

namestring · required
Name of the skill
Example: Python
categorystring · required
Category of the skill
Example: Technical
match_levelstring · required
Level of match between source and target
Example: Partial

MissingSkill

namestring · required
Name of the skill
Example: Kubernetes
categorystring · required
Category of the skill
Example: Technical
importancestring · required
Importance of the missing skill
Example: High

GapAnalysis

matched_skillsobject[] · required
missing_skillsobject[] · required
recommendationsstring[] · required
Example: ["Focus on developing advanced Python skills","Acquire basic knowledge of Kubernetes"]
overall_match_percentagenumber · required
Percentage match between source and target
Example: 75

GapAnalysisResponse

successboolean · required
Whether the request was successful
Example: true
analyzed_atstring · date-time · required
Timestamp when the analysis was performed
Example: 2025-03-10T09:48:23.341Z
source_typestring · required
Type of source text
Example: resume
target_typestring · required
Type of target text
Example: job_description
source_skillsobject · required
target_skillsobject · required
gap_analysisobject · required