CV Scoring API

POST

https://api.figolabs.ai/api/v1/cv/scoring

Apis

Maintainer:Figo AI Labs

The CV Scoring API provides a RESTful interface for seamlessly integrating resume evaluation into your applications.
It compares a candidate’s CV against a given job description and returns a relevance score along with a concise explanation for the score.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.figolabs.ai/api/v1/cv/scoring' \
--header 'Authorization: Bearer {Your-API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cvs": [
        "https://figolabs.ai/candidate_cv.pdf"
    ],
    "jobDescription": "frontend developer. Required skills:......."
}'

Response Example

200 - Success

{
    "responseCode": "00",
    "responseMessage": "Successful",
    "responseData": [
        {
            "name": "John Fred",
            "score": 90,
            "jobRole": "frontend developer",
            "reason": "The candidate has strong skills in Javascript, HTML, and React, which align well with the frontend developer role. However, the CV lacks specific mention of CSS or experience with frontend frameworks beyond React."
        }
    ]
}

Request

Header Params

Content-Type

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {Your-API-Key}

Body Params application/json

cvs

array[string]

required

Array of CVs

jobDescription

string

required

Detailed job description

Examples

Responses

🟢200OK

application/json

Success

Body

responseCode

string

required

responseMessage

string

required

responseData

array [object {4}]

required

name

string

optional

score

integer

optional

jobRole

string

optional

reason

string

optional

🟠401Unauthorized

Modified at 2025-04-22 18:48:04

Guardrails API

Web Search API