Analyze resume and persist latest analysis
curl --request POST \
--url http://localhost:3000/api/openapi/ai/analyze-resume \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"resumeId": "<string>",
"aiProviderId": "<string>"
}
'import requests
url = "http://localhost:3000/api/openapi/ai/analyze-resume"
payload = {
"resumeId": "<string>",
"aiProviderId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({resumeId: '<string>', aiProviderId: '<string>'})
};
fetch('http://localhost:3000/api/openapi/ai/analyze-resume', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/openapi/ai/analyze-resume",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'resumeId' => '<string>',
'aiProviderId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/openapi/ai/analyze-resume"
payload := strings.NewReader("{\n \"resumeId\": \"<string>\",\n \"aiProviderId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/openapi/ai/analyze-resume")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"resumeId\": \"<string>\",\n \"aiProviderId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/openapi/ai/analyze-resume")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"resumeId\": \"<string>\",\n \"aiProviderId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"overallScore": 50,
"scorecard": [
{
"dimension": "<string>",
"score": 50,
"rationale": "<string>"
}
],
"suggestions": [
{
"title": "<string>",
"why": "<string>",
"exampleRewrite": "<string>",
"copyPrompt": "<string>"
}
],
"strengths": [
"<string>"
],
"updatedAt": "2023-11-07T05:31:56Z",
"modelMeta": {
"provider": "<string>",
"model": "<string>"
}
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "The AI returned an improperly formatted structure.",
"data": "<unknown>"
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "The AI provider returned an error or is unreachable.",
"data": "<unknown>"
}AI
Analyze resume and persist latest analysis
Uses AI to analyze the current resume and returns a structured analysis with scorecard, strengths, and improvement suggestions. The latest analysis is persisted and can be fetched later. Requires authentication and AI credentials.
POST
/
ai
/
analyze-resume
Analyze resume and persist latest analysis
curl --request POST \
--url http://localhost:3000/api/openapi/ai/analyze-resume \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"resumeId": "<string>",
"aiProviderId": "<string>"
}
'import requests
url = "http://localhost:3000/api/openapi/ai/analyze-resume"
payload = {
"resumeId": "<string>",
"aiProviderId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({resumeId: '<string>', aiProviderId: '<string>'})
};
fetch('http://localhost:3000/api/openapi/ai/analyze-resume', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/openapi/ai/analyze-resume",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'resumeId' => '<string>',
'aiProviderId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/openapi/ai/analyze-resume"
payload := strings.NewReader("{\n \"resumeId\": \"<string>\",\n \"aiProviderId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/openapi/ai/analyze-resume")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"resumeId\": \"<string>\",\n \"aiProviderId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/openapi/ai/analyze-resume")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"resumeId\": \"<string>\",\n \"aiProviderId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"overallScore": 50,
"scorecard": [
{
"dimension": "<string>",
"score": 50,
"rationale": "<string>"
}
],
"suggestions": [
{
"title": "<string>",
"why": "<string>",
"exampleRewrite": "<string>",
"copyPrompt": "<string>"
}
],
"strengths": [
"<string>"
],
"updatedAt": "2023-11-07T05:31:56Z",
"modelMeta": {
"provider": "<string>",
"model": "<string>"
}
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "The AI returned an improperly formatted structure.",
"data": "<unknown>"
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "The AI provider returned an error or is unreachable.",
"data": "<unknown>"
}Authorizations
The API key to authenticate requests.
Response
Structured resume analysis returned and persisted successfully.
Required range:
0 <= x <= 100Minimum array length:
1Show child attributes
Show child attributes
Maximum array length:
10Show child attributes
Show child attributes
Maximum array length:
10Minimum string length:
1Show child attributes
Show child attributes
⌘I