Skip to main content
POST
/
v1
/
cv
/
score
Score
curl --request POST \
  --url https://app.fastgen.ai/v1/cv/score \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'Fastgen-Project: <fastgen-project>' \
  --form cv_file='@example-file' \
  --form cv_file_url=https://myFileHost/myCv.pdf \
  --form async=true \
  --form 'scoring_template={ ... }' \
  --form scoring_template_id=f7c31bda-f918-4249-a3bc-9a1903fe9f6d \
  --form language=en
{
  "personal_information": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "address": "<string>",
    "sex": "<string>",
    "phone_number": "<string>",
    "date_of_birth": "2023-12-25"
  },
  "skills": [
    {
      "skill": "<string>",
      "proficiency_level": "<string>"
    }
  ],
  "professional_experience": [
    {
      "company": "<string>",
      "description": "<string>",
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "position": "<string>",
      "location": "<string>",
      "internship": true,
      "work_type": "<string>"
    }
  ],
  "education": [
    {
      "school": "<string>",
      "degree": "<string>",
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "grade_text": "<string>",
      "grade_value": 123
    }
  ],
  "certifications": [
    {
      "issuer": "<string>",
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "credential_id": "<string>",
      "credential_url": "<string>",
      "name": "<string>"
    }
  ],
  "languages": [
    {
      "language": "<string>",
      "proficiency_level": "<string>"
    }
  ],
  "ai_evaluation": {
    "candidate_info": {
      "name": "<string>",
      "position_applied": "<string>",
      "years_experience": 123
    },
    "professional_experience": {
      "score": 123,
      "weight": 123,
      "ai_reasoning": "<string>"
    },
    "education_qualifications": {
      "score": 123,
      "weight": 123,
      "ai_reasoning": "<string>"
    },
    "skills": {
      "score": 123,
      "weight": 123,
      "ai_reasoning": "<string>"
    },
    "additional_factors": {
      "score": 123,
      "weight": 123,
      "ai_reasoning": "<string>"
    },
    "total_score": 123,
    "summary_reasoning": "<string>",
    "recommended_interview_focus": "<string>"
  }
}

​
File Options

​
1. Direct File Upload

  • Submit the PDF file directly using multipart/form-data
  • Maximum file size: 30MB
  • Ideal for local files that need to be uploaded from a client application

​
2. URL Submission

  • Provide a publicly accessible URL where the PDF file is hosted
  • Maximum file size: 30MB
  • Useful for files that are already hosted online or stored in cloud storage
  • The API will download and process the file from the provided URL
Both methods expect PDF format files only and will return the same structured CV evaluation response.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Fastgen-Project
string
required

Body

multipart/form-data
​
cv_file
file

Uploaded PDF file using multipart/form-data. Provide either 'cv_file' or 'cv_file_url' but not both.

​
cv_file_url
string

publicly accessible URL where the PDF file is hosted. Provide either 'cv_file' or 'cv_file_url' but not both.

Example:

"https://myFileHost/myCv.pdf"

​
async
boolean

Controls whether the result is returned via the http response or delivered via the users webhook endpoints. If set to true, the server will respond with 202 and return the webhook message id under which the result will be deliverd. The same webhook message id, is then found in the webhook message payload later alongside the result. Defaults to false.

Example:

"true"

​
scoring_template
string

The scoring template provided directly to the request. See https://partner-docs.fastgen.ai/api-reference/endpoint/scoringTemplate/create regarding the format. Usually it is better to use 'scoring_template_id' instead. Provide either 'scoring_template' or 'scoring_template_id' but not both.

Example:

"{ ... }"

​
scoring_template_id
string

The scoring template provided via its id. See https://partner-docs.fastgen.ai/api-reference/endpoint/scoringTemplate/create. Provide either 'scoring_template' or 'scoring_template_id' but not both.

Example:

"f7c31bda-f918-4249-a3bc-9a1903fe9f6d"

​
language
enum<string>

Controls the language of the AI Evaluation text. Defaults to 'en'

Available options:
de,
en
Example:

"en"

Response

Successful response

​
personal_information
object
​
skills
object[]
​
professional_experience
object[]
​
education
object[]
​
certifications
object[]
​
languages
object[]
​
ai_evaluation
object