# Score a resume for ATS compatibility (/docs/reference/ats-score)

`POST https://api.getmattered.com/api/v1/developer/ats-score`

Scores resume text for ATS compatibility, against a job posting when one is sent. Spends the tokens it uses plus the request fee, recorded as `ats_score`.

Authentication: `Authorization: Bearer gm_live_...` (see /authentication.md).

## Request body (application/json)

```json
{
  "type": "object",
  "properties": {
    "jobDescription": {
      "type": "string",
      "minLength": 50,
      "maxLength": 50000,
      "description": "The job posting to score against. Omit it for general ATS compatibility.",
      "example": "We are hiring a Senior Frontend Engineer with React, TypeScript and GraphQL experience to own our design system..."
    },
    "resumeText": {
      "type": "string",
      "minLength": 50,
      "maxLength": 50000,
      "description": "The resume as plain text or Markdown, 50 to 50,000 characters.",
      "example": "Jane Doe\nSenior Software Engineer\n6 years building React and TypeScript apps at Acme. Led the move to Next.js..."
    }
  },
  "required": [
    "resumeText"
  ],
  "additionalProperties": false
}
```

## Responses

### 200: The ATS score, matched and missing keywords, section scores and suggestions.

```json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "overallScore": {
          "type": "number",
          "minimum": 0,
          "maximum": 100,
          "description": "Overall ATS compatibility score (0-100).",
          "example": 72
        },
        "keywordMatches": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Keywords found in the resume that match the job description.",
          "example": [
            "JavaScript",
            "React",
            "Node.js"
          ]
        },
        "missingKeywords": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Important keywords from the job description missing from the resume.",
          "example": [
            "TypeScript",
            "GraphQL"
          ]
        },
        "sectionScores": {
          "type": "object",
          "properties": {
            "skills": {
              "type": "number",
              "minimum": 0,
              "maximum": 100
            },
            "experience": {
              "type": "number",
              "minimum": 0,
              "maximum": 100
            },
            "education": {
              "type": "number",
              "minimum": 0,
              "maximum": 100
            },
            "formatting": {
              "type": "number",
              "minimum": 0,
              "maximum": 100
            },
            "keywords": {
              "type": "number",
              "minimum": 0,
              "maximum": 100
            }
          },
          "required": [
            "skills",
            "experience",
            "education",
            "formatting",
            "keywords"
          ],
          "additionalProperties": false,
          "description": "Per-section ATS sub-scores derived from the analysis."
        },
        "suggestions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Actionable improvement suggestions.",
          "example": [
            "Add \"TypeScript\" to your skills section."
          ]
        },
        "usage": {
          "type": "object",
          "properties": {
            "tokens": {
              "type": "integer",
              "description": "The tokens this call spent from the key owner's account: the work it ran plus the request fee.",
              "example": 450
            }
          },
          "required": [
            "tokens"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "overallScore",
        "keywordMatches",
        "missingKeywords",
        "sectionScores",
        "suggestions",
        "usage"
      ],
      "additionalProperties": false
    },
    "meta": {
      "type": "object",
      "properties": {
        "duration": {
          "type": "number",
          "minimum": 0,
          "description": "Request duration in milliseconds",
          "example": 150
        },
        "performance": {
          "type": "object",
          "properties": {
            "dbQueries": {
              "type": "integer",
              "minimum": 0
            },
            "totalDbTime": {
              "type": "number",
              "minimum": 0
            }
          },
          "description": "Performance metrics (preview/local only)"
        },
        "requestId": {
          "type": "string",
          "description": "Unique request identifier",
          "example": "req_abc123"
        },
        "timestamp": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 timestamp",
          "example": "2026-11-17T12:00:00.000Z"
        },
        "version": {
          "type": "string",
          "description": "API version",
          "example": "v1"
        }
      }
    },
    "success": {
      "type": "boolean",
      "enum": [
        true
      ]
    }
  },
  "required": [
    "data",
    "success"
  ],
  "additionalProperties": false,
  "description": "Successful API response"
}
```

### 400: Bad Request

### 401: Unauthorized

### 402: The key owner's API balance has no tokens for this call. Nothing was spent.

### 404: Not Found

### 429: Too Many Requests

### 500: Internal Server Error

Error responses use the envelope in /errors.md.