Other endpoints

Extract skills from file

POST

https://api.apicodex.io/parser

/v1/skills/upload

Extract skills from an uploaded file (PDF or DOCX)

Extract skills from file › Request Body

file

string · required

The file to analyze (PDF or DOCX)

type

string · enum

Type of text

Enum values:

general

job_description

resume

Default: general

Extract skills from file › Responses

Successful response with extracted skills

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

POST/v1/skills/upload

curl 'https://api.apicodex.io/parser/v1/skills/upload?apikey=<api-key>' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=file' \
  --form 'type=general'

Example Request Body

{
  "file": "file",
  "type": "general"
}

text

Example Responses

{
  "success": true,
  "parsed_at": "2025-03-10T09:45:12.021Z",
  "type": "job_description",
  "data": {
    "skills": {
      "technical": [
        {
          "name": "Python",
          "category": "Programming Languages",
          "level": "Advanced",
          "context": "Required for data analysis and backend development"
        }
      ],
      "soft": [
        {
          "name": "Communication",
          "category": "Interpersonal Skills",
          "context": "Mentioned in team collaboration responsibilities"
        }
      ],
      "domain": [
        {
          "name": "Financial Modeling",
          "industry": "Finance",
          "context": "Experience with financial forecasting models"
        }
      ]
    },
    "key_insights": [
      "Strong emphasis on programming and data analysis skills",
      "Leadership and project management are highlighted as important soft skills"
    ],
    "skill_count": {
      "total": 12,
      "technical": 7,
      "soft": 3,
      "domain": 2
    }
  }
}

json

application/json

Extract skills from text

POST

https://api.apicodex.io/parser

/v1/skills/text

Extract skills from raw text

Extract skills from text › Request Body

text

string · required

The text to analyze

type

string · enum

Type of text

Enum values:

general

job_description

resume

Default: general

Extract skills from text › Responses

Successful response with extracted skills

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

POST/v1/skills/text

curl 'https://api.apicodex.io/parser/v1/skills/text?apikey=<api-key>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "text": "text",
  "type": "general"
}'

Example Request Body

{
  "text": "text",
  "type": "general"
}

json

Example Responses

{
  "success": true,
  "parsed_at": "2025-03-10T09:45:12.021Z",
  "type": "job_description",
  "data": {
    "skills": {
      "technical": [
        {
          "name": "Python",
          "category": "Programming Languages",
          "level": "Advanced",
          "context": "Required for data analysis and backend development"
        }
      ],
      "soft": [
        {
          "name": "Communication",
          "category": "Interpersonal Skills",
          "context": "Mentioned in team collaboration responsibilities"
        }
      ],
      "domain": [
        {
          "name": "Financial Modeling",
          "industry": "Finance",
          "context": "Experience with financial forecasting models"
        }
      ]
    },
    "key_insights": [
      "Strong emphasis on programming and data analysis skills",
      "Leadership and project management are highlighted as important soft skills"
    ],
    "skill_count": {
      "total": 12,
      "technical": 7,
      "soft": 3,
      "domain": 2
    }
  }
}

json

application/json

Skills gap analysis

POST

https://api.apicodex.io/parser

/v1/skills/gap-analysis

Compare skills between two texts (e.g., resume vs. job description)

Skills gap analysis › Request Body

sourceText

string · required

Source text (typically a resume)

targetText

string · required

Target text (typically a job description)

sourceType

string · enum

Type of source text

Enum values:

resume

general

job_description

Default: resume

targetType

string · enum

Type of target text

Enum values:

job_description

general

resume

Default: job_description

Skills gap analysis › Responses

Successful response with skills gap analysis

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

POST/v1/skills/gap-analysis

curl 'https://api.apicodex.io/parser/v1/skills/gap-analysis?apikey=<api-key>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "sourceText": "sourceText",
  "targetText": "targetText",
  "sourceType": "resume",
  "targetType": "job_description"
}'

Example Request Body

{
  "sourceText": "sourceText",
  "targetText": "targetText",
  "sourceType": "resume",
  "targetType": "job_description"
}

json

Example Responses

{
  "success": true,
  "analyzed_at": "2025-03-10T09:48:23.341Z",
  "source_type": "resume",
  "target_type": "job_description",
  "source_skills": {
    "skills": {
      "technical": [
        {
          "name": "Python",
          "category": "Programming Languages",
          "level": "Advanced",
          "context": "Required for data analysis and backend development"
        }
      ],
      "soft": [
        {
          "name": "Communication",
          "category": "Interpersonal Skills",
          "context": "Mentioned in team collaboration responsibilities"
        }
      ],
      "domain": [
        {
          "name": "Financial Modeling",
          "industry": "Finance",
          "context": "Experience with financial forecasting models"
        }
      ]
    },
    "key_insights": [
      "Strong emphasis on programming and data analysis skills",
      "Leadership and project management are highlighted as important soft skills"
    ],
    "skill_count": {
      "total": 12,
      "technical": 7,
      "soft": 3,
      "domain": 2
    }
  },
  "target_skills": {
    "skills": {
      "technical": [
        {
          "name": "Python",
          "category": "Programming Languages",
          "level": "Advanced",
          "context": "Required for data analysis and backend development"
        }
      ],
      "soft": [
        {
          "name": "Communication",
          "category": "Interpersonal Skills",
          "context": "Mentioned in team collaboration responsibilities"
        }
      ],
      "domain": [
        {
          "name": "Financial Modeling",
          "industry": "Finance",
          "context": "Experience with financial forecasting models"
        }
      ]
    },
    "key_insights": [
      "Strong emphasis on programming and data analysis skills",
      "Leadership and project management are highlighted as important soft skills"
    ],
    "skill_count": {
      "total": 12,
      "technical": 7,
      "soft": 3,
      "domain": 2
    }
  },
  "gap_analysis": {
    "matched_skills": [
      {
        "name": "Python",
        "category": "Technical",
        "match_level": "Partial"
      }
    ],
    "missing_skills": [
      {
        "name": "Kubernetes",
        "category": "Technical",
        "importance": "High"
      }
    ],
    "recommendations": [
      "Focus on developing advanced Python skills",
      "Acquire basic knowledge of Kubernetes"
    ],
    "overall_match_percentage": 75
  }
}

json

application/json

Extract skills from file

POST

https://api.apicodex.io/parser

/v1/skills/upload

Extract skills from an uploaded file (PDF or DOCX)

Extract skills from file › Request Body

file

string · required

The file to analyze (PDF or DOCX)

type

string · enum

Type of text

Enum values:

general

job_description

resume

Default: general

Extract skills from file › Responses

Successful response with extracted skills

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

Extract skills from text

POST

https://api.apicodex.io/parser

/v1/skills/text

Extract skills from raw text

Extract skills from text › Request Body

text

string · required

The text to analyze

type

string · enum

Type of text

Enum values:

general

job_description

resume

Default: general

Extract skills from text › Responses

Successful response with extracted skills

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

Skills gap analysis

POST

https://api.apicodex.io/parser

/v1/skills/gap-analysis

Compare skills between two texts (e.g., resume vs. job description)

Skills gap analysis › Request Body

sourceText

string · required

Source text (typically a resume)

targetText

string · required

Target text (typically a job description)

sourceType

string · enum

Type of source text

Enum values:

resume

general

job_description

Default: resume

targetType

string · enum

Type of target text

Enum values:

job_description

general

resume

Default: job_description

Skills gap analysis › Responses

Successful response with skills gap analysis

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