Schemas

Error

error

string

Error message

Example: Unauthorized

TechnicalSkill

name

string · required

Name of the skill

Example: Python

category

string · required

Category of the skill

Example: Programming Languages

level

string · required

Skill proficiency level

Example: Advanced

context

string · required

Context where the skill was mentioned or inferred

Example: Required for data analysis and backend development

SoftSkill

name

string · required

Name of the skill

Example: Communication

category

string · required

Category of the skill

Example: Interpersonal Skills

context

string · required

Context where the skill was mentioned or inferred

Example: Mentioned in team collaboration responsibilities

DomainSkill

name

string · required

Name of the skill

Example: Financial Modeling

industry

string · required

Related industry

Example: Finance

context

string · required

Context where the skill was mentioned or inferred

Example: Experience with financial forecasting models

SkillCount

total

integer · required

Total number of skills

Example: 12

technical

integer · required

Number of technical skills

Example: 7

soft

integer · required

Number of soft skills

Example: 3

domain

integer · required

Number of domain skills

Example: 2

SkillsData

object · required

key_insights

string[] · required

SkillCount · required

SkillsResponse

success

boolean · required

Whether the request was successful

Example: true

parsed_at

string · date-time · required

Timestamp when the skills were parsed

Example: 2025-03-10T09:45:12.021Z

type

string · required

Type of text that was analyzed

Example: job_description

SkillsData · required

MatchedSkill

name

string · required

Name of the skill

Example: Python

category

string · required

Category of the skill

Example: Technical

match_level

string · required

Level of match between source and target

Example: Partial

MissingSkill

name

string · required

Name of the skill

Example: Kubernetes

category

string · required

Category of the skill

Example: Technical

importance

string · required

Importance of the missing skill

Example: High

GapAnalysis

MatchedSkill[] · required

MissingSkill[] · required

recommendations

string[] · required

overall_match_percentage

number · required

Percentage match between source and target

Example: 75

GapAnalysisResponse

success

boolean · required

Whether the request was successful

Example: true

analyzed_at

string · date-time · required

Timestamp when the analysis was performed

Example: 2025-03-10T09:48:23.341Z

source_type

string · required

Type of source text

Example: resume

target_type

string · required

Type of target text

Example: job_description

SkillsData · required

GapAnalysis · required

TechnicalSkill

name

string · required

Name of the skill

Example: Python

category

string · required

Category of the skill

Example: Programming Languages

level

string · required

Skill proficiency level

Example: Advanced

context

string · required

Context where the skill was mentioned or inferred

Example: Required for data analysis and backend development

SkillsResponse

success

boolean · required

Whether the request was successful

Example: true

parsed_at

string · date-time · required

Timestamp when the skills were parsed

Example: 2025-03-10T09:45:12.021Z

type

string · required

Type of text that was analyzed

Example: job_description

SkillsData · required

GapAnalysisResponse

success

boolean · required

Whether the request was successful

Example: true

analyzed_at

string · date-time · required

Timestamp when the analysis was performed

Example: 2025-03-10T09:48:23.341Z

source_type

string · required

Type of source text

Example: resume

target_type

string · required

Type of target text

Example: job_description

SkillsData · required

GapAnalysis · required