Skip to Content
Resume tools

Write a cover letter

POST
/developer/cover-letter

Writes a first-person cover letter for a job posting from the resume. Spends the tokens it uses plus the request fee, recorded as cover_letter.

Authorization

DeveloperKey
headerAuthorizationBearer <gm_live_...>

A GetMattered developer API key, sent as Authorization: Bearer gm_live_....

Request Body

application/json
  1. body
candidateName?string

The name the letter is signed with. Omit it to use the name on the resume.

Length1 <= length <= 200
companyName*string

The hiring company.

Length1 <= length <= 200
jobDescription*string

The job posting text, 50 to 50,000 characters.

Length50 <= length <= 50000
jobTitle*string

The job title of the posting.

Length1 <= length <= 200
resumeText*string

The resume as plain text or Markdown, 50 to 50,000 characters.

Length50 <= length <= 50000

Response Body

The cover letter and the themes it leads with.

application/json
  1. response

Successful API response

data*
meta?
success*true
Value intrue
Example Request
curl -X POST 'https://api.getmattered.com/api/v1/developer/cover-letter' \
  -H 'Content-Type: application/json' \
  -d '{
  "companyName": "string",
  "jobDescription": "stringstringstringstringstringstringstringstringst",
  "jobTitle": "string",
  "resumeText": "stringstringstringstringstringstringstringstringst"
}'
Example Response
{
  "data": {
    "coverLetter": "string",
    "keyThemes": [
      "string"
    ],
    "usage": {
      "tokens": 0
    }
  },
  "meta": {
    "duration": 0,
    "performance": {
      "dbQueries": 0,
      "totalDbTime": 0
    },
    "requestId": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "version": "string"
  },
  "success": true
}