Create Skill Gap Analysis
curl --request POST \
--url https://api.example.com/api/v1/job-seekers/me/skill-analysisimport requests
url = "https://api.example.com/api/v1/job-seekers/me/skill-analysis"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v1/job-seekers/me/skill-analysis', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/job-seekers/me/skill-analysis",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/job-seekers/me/skill-analysis"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/job-seekers/me/skill-analysis")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/job-seekers/me/skill-analysis")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "<string>",
"message": "<string>"
}Skill Gap Analysis
Create Skill Gap Analysis
Start a new skill gap analysis based on the job seeker profile
POST
/
api
/
v1
/
job-seekers
/
me
/
skill-analysis
Create Skill Gap Analysis
curl --request POST \
--url https://api.example.com/api/v1/job-seekers/me/skill-analysisimport requests
url = "https://api.example.com/api/v1/job-seekers/me/skill-analysis"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v1/job-seekers/me/skill-analysis', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/job-seekers/me/skill-analysis",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/job-seekers/me/skill-analysis"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/job-seekers/me/skill-analysis")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/job-seekers/me/skill-analysis")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "<string>",
"message": "<string>"
}Endpoint
POST /api/v1/job-seekers/me/skill-analysis
http://localhost:3000/api/v1
This endpoint requires authentication and Job Seeker role.
Authentication
Include the access token in the Authorization header:Authorization: Bearer YOUR_ACCESS_TOKEN
Request Body
This endpoint does not require a request body. It automatically uses the authenticated job seeker’s profile data.Response
Success Response (201 Created)
Endpoint returns HTTP
201 by default because there is no explicit @HttpCode(200) override.{
"success": true,
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "PROCESSING",
"message": "Analysis started. This may take 10-30 seconds."
},
"message": "Skill gap analysis started",
"meta": {
"timestamp": "2026-04-23T20:00:00.000Z",
"path": "/job-seekers/me/skill-analysis",
"method": "POST"
}
}
Response Fields
string
Unique identifier for the analysis (UUID).
string
Current status of the analysis. Value:
PROCESSINGstring
Informational message about the analysis progress.
Error Responses
400 Bad Request - Weekly Limit Reached
{
"success": false,
"error": {
"message": "You have reached your weekly limit of 10 analyses. Next analysis available on Mon Mar 02 2026",
"statusCode": 400,
"timestamp": "2026-04-23T20:00:00.000Z",
"path": "/job-seekers/me/skill-analysis",
"method": "POST",
"details": "Bad Request"
}
}
400 Bad Request - Profile Not Found
{
"success": false,
"error": {
"message": "Job seeker profile not found",
"statusCode": 400,
"timestamp": "2026-04-23T20:00:00.000Z",
"path": "/job-seekers/me/skill-analysis",
"method": "POST",
"details": "Bad Request"
}
}
401 Unauthorized - Not Authenticated
{
"success": false,
"error": {
"message": "Unauthorized",
"statusCode": 401,
"timestamp": "2026-04-23T20:00:00.000Z",
"path": "/job-seekers/me/skill-analysis",
"method": "POST",
"details": "Unauthorized"
}
}
403 Forbidden - Insufficient Permissions
{
"success": false,
"error": {
"message": "Forbidden resource",
"statusCode": 403,
"timestamp": "2026-04-23T20:00:00.000Z",
"path": "/job-seekers/me/skill-analysis",
"method": "POST",
"details": "Forbidden"
}
}
Notes
Async Processing: The analysis is processed asynchronously in the background. The status will
initially be
PROCESSING. Use the GET /job-seekers/me/skill-analysis/latest endpoint to check
the completed results after 10-30 seconds.Weekly Limit: Job seekers can create up to 10 skill gap analyses per week. The limit resets on
Monday.
Profile Required: Ensure your profile is complete with skills, work experience, and a target
job title before creating an analysis for the best results.