# Parse a resume into structured fields (/docs/reference/parse)

`POST https://api.getmattered.com/api/v1/developer/parse`

Parses resume text into structured fields: contact, work history, education, skills and suggested titles. Spends the tokens it uses plus the request fee, recorded as `parse`.

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

## Request body (application/json)

```json
{
  "type": "object",
  "properties": {
    "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 structured resume.

```json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "addressLine1": {
          "type": [
            "string",
            "null"
          ],
          "description": "Street + number exactly as printed, or null",
          "example": "Hauptstrasse 12"
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "City from resume",
          "example": "San Francisco"
        },
        "companySize": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "AI-inferred company size preferences: startup, small, medium, large, enterprise",
          "example": [
            "startup",
            "medium"
          ]
        },
        "country": {
          "type": [
            "string",
            "null"
          ],
          "description": "Country from resume",
          "example": "United States"
        },
        "currentJobTitle": {
          "type": [
            "string",
            "null"
          ],
          "description": "Current or most recent job title",
          "example": "Senior Software Engineer"
        },
        "education": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "degree": {
                "type": "string",
                "description": "Degree or certification name",
                "example": "B.S. Computer Science"
              },
              "institution": {
                "type": "string",
                "description": "School or institution name",
                "example": "MIT"
              },
              "year": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Graduation year or date range",
                "example": "2018"
              }
            },
            "required": [
              "degree",
              "institution",
              "year"
            ],
            "additionalProperties": false
          },
          "description": "Education history extracted from resume"
        },
        "educationLevel": {
          "type": [
            "string",
            "null"
          ],
          "description": "AI-inferred education level: high_school, associate, bachelor, master, doctorate",
          "example": "bachelor"
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "Email address from resume",
          "example": "john.doe@example.com"
        },
        "experienceLevel": {
          "type": [
            "string",
            "null"
          ],
          "description": "AI-inferred experience level: entry, mid, senior, lead, executive",
          "example": "senior"
        },
        "fieldEvidence": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "confidence": {
                "type": "string",
                "enum": [
                  "high",
                  "medium",
                  "low"
                ],
                "description": "How the value was read: high/medium when printed in the resume, low when inferred",
                "example": "high"
              },
              "field": {
                "type": "string",
                "enum": [
                  "addressLine1",
                  "city",
                  "state",
                  "country",
                  "zipCode",
                  "phone",
                  "email",
                  "linkedinUrl",
                  "githubUrl",
                  "portfolioUrl",
                  "currentEmployer",
                  "educationLevel"
                ],
                "description": "A parsed resume fact backed by a verbatim quote from the resume",
                "example": "city"
              },
              "quote": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The exact contiguous resume text that contains the value (<=160 chars), or null",
                "example": "Berlin, Germany | +49 176 1234 5678"
              }
            },
            "required": [
              "confidence",
              "field",
              "quote"
            ],
            "additionalProperties": false
          },
          "description": "Verbatim quotes from the resume that back the contact and level facts"
        },
        "firstName": {
          "type": [
            "string",
            "null"
          ],
          "description": "First name parsed from full name",
          "example": "John"
        },
        "fullName": {
          "type": [
            "string",
            "null"
          ],
          "description": "Full name from resume",
          "example": "John Doe"
        },
        "githubUrl": {
          "type": [
            "string",
            "null"
          ],
          "description": "GitHub profile URL exactly as printed, or null",
          "example": "https://github.com/johndoe"
        },
        "industries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "AI-inferred industries from work history",
          "example": [
            "Software & SaaS",
            "AI & Machine Learning"
          ]
        },
        "jobTypes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "AI-inferred job types: full_time, part_time, contract, freelance, internship, temporary",
          "example": [
            "full_time"
          ]
        },
        "lastName": {
          "type": [
            "string",
            "null"
          ],
          "description": "Last name parsed from full name",
          "example": "Doe"
        },
        "linkedinUrl": {
          "type": [
            "string",
            "null"
          ],
          "description": "LinkedIn profile URL exactly as printed, or null",
          "example": "https://www.linkedin.com/in/johndoe"
        },
        "phone": {
          "type": [
            "string",
            "null"
          ],
          "description": "Phone number from resume",
          "example": "+1-555-123-4567"
        },
        "portfolioUrl": {
          "type": [
            "string",
            "null"
          ],
          "description": "Personal website / portfolio URL exactly as printed, or null",
          "example": "https://johndoe.dev"
        },
        "prefill": {
          "type": "object",
          "properties": {
            "addressLine1": {
              "type": [
                "string",
                "null"
              ]
            },
            "city": {
              "type": [
                "string",
                "null"
              ]
            },
            "country": {
              "type": [
                "string",
                "null"
              ]
            },
            "currentEmployer": {
              "type": [
                "string",
                "null"
              ]
            },
            "githubUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "highestEducation": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "high_school",
                "associate",
                "bachelor",
                "master",
                "doctorate",
                "any",
                null
              ],
              "description": "Education level requirement",
              "example": "any"
            },
            "homeLocation": {
              "type": [
                "string",
                "null"
              ]
            },
            "linkedinUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "ownTitles": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "phone": {
              "type": [
                "string",
                "null"
              ]
            },
            "portfolioUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "seeded": {
              "type": "object",
              "properties": {
                "jobPreferences": {
                  "type": "object",
                  "properties": {
                    "locations": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "experienceLevels": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "skills": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "targetRoles": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    }
                  }
                },
                "profile": {
                  "type": "object",
                  "properties": {
                    "addressLine1": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "city": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "state": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "country": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "zipCode": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "phone": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "linkedinUrl": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "githubUrl": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "portfolioUrl": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "currentEmployer": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "highestEducation": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "yearsOfExperience": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    }
                  }
                }
              },
              "additionalProperties": false
            },
            "state": {
              "type": [
                "string",
                "null"
              ]
            },
            "workHistoryLocations": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "yearsOfExperience": {
              "type": [
                "integer",
                "null"
              ]
            },
            "zipCode": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "addressLine1",
            "city",
            "country",
            "currentEmployer",
            "githubUrl",
            "highestEducation",
            "homeLocation",
            "linkedinUrl",
            "ownTitles",
            "phone",
            "portfolioUrl",
            "state",
            "workHistoryLocations",
            "yearsOfExperience",
            "zipCode"
          ],
          "additionalProperties": false
        },
        "professionalSummary": {
          "type": [
            "string",
            "null"
          ],
          "description": "Professional summary or objective",
          "example": "Experienced full-stack engineer with 8 years building scalable web applications."
        },
        "skills": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Skills extracted from resume",
          "example": [
            "TypeScript",
            "React",
            "Node.js",
            "PostgreSQL"
          ]
        },
        "state": {
          "type": [
            "string",
            "null"
          ],
          "description": "State/province from resume",
          "example": "California"
        },
        "suggestedJobTitles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Suggested job titles based on experience",
          "example": [
            "Senior Software Engineer",
            "Full Stack Developer",
            "Tech Lead"
          ]
        },
        "suggestedLocations": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Suggested job search locations based on resume",
          "example": [
            "San Francisco, CA",
            "Remote"
          ]
        },
        "workExperience": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "company": {
                "type": "string",
                "description": "Company name",
                "example": "Acme Corp"
              },
              "current": {
                "type": "boolean",
                "description": "Whether this is the current position",
                "example": false
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Role description or achievements",
                "example": "Led a team of 5 engineers building microservices"
              },
              "endDate": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "End date (free-form from resume)",
                "example": "Dec 2023"
              },
              "location": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "City of this role exactly as printed on the resume",
                "example": "Berlin"
              },
              "startDate": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Start date (free-form from resume)",
                "example": "Jan 2020"
              },
              "title": {
                "type": "string",
                "description": "Job title",
                "example": "Senior Software Engineer"
              }
            },
            "required": [
              "company",
              "current",
              "description",
              "endDate",
              "startDate",
              "title"
            ],
            "additionalProperties": false
          },
          "description": "Work experience history extracted from resume"
        },
        "yearsOfExperience": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Estimated total years of experience (whole number)",
          "example": 8
        },
        "zipCode": {
          "type": [
            "string",
            "null"
          ],
          "description": "ZIP/postal code from resume",
          "example": "94105"
        },
        "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": [
        "city",
        "companySize",
        "country",
        "currentJobTitle",
        "education",
        "educationLevel",
        "email",
        "experienceLevel",
        "firstName",
        "fullName",
        "industries",
        "jobTypes",
        "lastName",
        "phone",
        "professionalSummary",
        "skills",
        "state",
        "suggestedJobTitles",
        "suggestedLocations",
        "workExperience",
        "yearsOfExperience",
        "zipCode",
        "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.