---
title: "Analyze a resume against a job description"
method: POST
path: "/api/analyze"
---

# Analyze a resume against a job description

`POST /api/analyze`

## Request body

- union
  - object
    - `jobTitle` string
    - `jobDescription` string, required
    - `jobDescriptionUrl` string, uri
    - `resumeText` string, required
    - `resumeUrl` string, uri
    - `candidateName` string
    - `fileName` string
  - object
    - `jobTitle` string
    - `jobDescription` string
    - `jobDescriptionUrl` string, uri, required
    - `resumeText` string
    - `resumeUrl` string, uri, required
    - `candidateName` string
    - `fileName` string

## Response `200`

Analysis result

- object
  - `requestId` string
  - `matchScore` integer
  - `strengths` string[]
  - `risks` string[]
  - `summary` string
  - `recommendation` string
  - `scoreExplanation` string

## Other responses

- `401` — Invalid token
- `402` — Insufficient credits
- `4XX` — Validation error

---

[API](https://skmtc.dev/swiftlynx/apis/swiftlynx-api.md) · [All operations](https://skmtc.dev/swiftlynx/apis/swiftlynx-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/swiftlynx/swiftlynx-api/revisions/26e847abe572/schema)