# Quickstart (/docs/quickstart)

Create an API key, send your first application, and score a resume.

## 1. Create a key [#1-create-a-key]

Sign in to GetMattered and open [Developers](https://getmattered.com/dashboard/developers) in the dashboard.
Choose **Create key** and name it after where it runs, for example `Production`.
The key starts with `gm_live_`.

We show the key once and store only a hash of it, so copy it now.
We also email you that the key was created.
An account can have up to 5 active keys.
Your first key brings 100,000 free API tokens. API calls spend API tokens, never your GetMattered app plan.
`GET /developer/balance` shows how many are left. See [Pricing](/docs/pricing).

Create and manage your keys at https://getmattered.com/dashboard/developers.

Store the key in an environment variable on your server:

```bash
export GETMATTERED_API_KEY="gm_live_..."
```

Call the API from your server only.
A key in browser or mobile app code can be read by anyone who uses that app.

## 2. Apply to a job [#2-apply-to-a-job]

`POST /developer/apply` applies to one posting from your account, with the resume and answers you keep in GetMattered.
Upload a resume in GetMattered first.
`"mode": "review"` holds the application so you approve it in GetMattered before it goes out.

```bash title="curl"
curl https://api.getmattered.com/api/v1/developer/apply \
  -H "Authorization: Bearer $GETMATTERED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "postingUrl": "https://job-boards.greenhouse.io/acme/jobs/4012345",
    "mode": "review"
  }'
```

The call answers `202` at once, with the application's id and status:

```json
{
  "success": true,
  "data": {
    "id": 2481,
    "status": "in_progress",
    "trackingUrl": "https://getmattered.com/dashboard/applications/2481"
  },
  "meta": { "requestId": "...", "timestamp": "2026-11-18T12:00:00.000Z", "version": "v1" }
}
```

Read where it stands with `GET /developer/applications/2481`.
It reads `landed` only when the employer confirmed the application, by their own email or their confirmation page.
[Apply to a job by API](/docs/guides/apply-to-a-job) walks through every state and refusal.

## 3. Score a resume [#3-score-a-resume]

`POST /developer/ats-score` scores resume text against a job posting.
Both texts must be 50 to 50,000 characters long.
Leave out `jobDescription` to get a general ATS score.

```bash title="curl"
curl https://api.getmattered.com/api/v1/developer/ats-score \
  -H "Authorization: Bearer $GETMATTERED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resumeText": "Jane Doe\nSenior Software Engineer\n6 years building React and TypeScript apps at Acme. Led the move to Next.js.",
    "jobDescription": "We are hiring a Senior Frontend Engineer with React, TypeScript and GraphQL experience to own our design system."
  }'
```

```ts title="TypeScript (fetch)"
const response = await fetch('https://api.getmattered.com/api/v1/developer/ats-score', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.GETMATTERED_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    resumeText: 'Jane Doe\nSenior Software Engineer\n6 years building React and TypeScript apps at Acme. Led the move to Next.js.',
    jobDescription: 'We are hiring a Senior Frontend Engineer with React, TypeScript and GraphQL experience to own our design system.',
  }),
});

const body = await response.json();
if (!body.success) {
  throw new Error(`${body.error.code}: ${body.error.message}`);
}
console.log(body.data.overallScore, body.data.missingKeywords, body.data.usage.tokens);
```

A successful call answers `200` with the result in `data`:

```json
{
  "success": true,
  "data": {
    "overallScore": 72,
    "keywordMatches": ["React", "TypeScript"],
    "missingKeywords": ["GraphQL"],
    "sectionScores": { "skills": 70, "experience": 80, "education": 60, "formatting": 75, "keywords": 65 },
    "suggestions": ["Add \"GraphQL\" to your skills section."],
    "usage": { "tokens": 390 }
  },
  "meta": { "requestId": "...", "timestamp": "2026-11-18T12:00:00.000Z", "version": "v1" }
}
```

The numbers above show the shape only. Your scores depend on the texts you send.
`data.usage.tokens` says exactly how many tokens the call spent. See [Pricing](/docs/pricing).

## Next [#next]

- Check your usage in the dashboard, or with `GET /developer/usage`.
- Read [Errors](/docs/errors) before you go live, so your code handles `401`, `402`, `422` and `429`.
- Browse every endpoint in the [API reference](/docs/reference/apply).