Skip to Content
Quickstart

Quickstart

Five minutes from zero to a scored match.

1. Get an API key

Sign in to the dashboard and mint a key. It looks like rz_live_… and is shown exactly once — Rezmatch.ai stores only a SHA-256 hash, so copy it immediately.

export REZMATCH_API_KEY="rz_live_..."
export BASE="https://api.rezmatch.ai"

2. Make a free call

The normalize endpoints cost 0 credits — perfect for verifying your key works:

curl "$BASE/normalize/title?title=Sr.%20SWE" \
  -H "x-access-key: $REZMATCH_API_KEY"
{
  "success": true,
  "data": { "canonical": "Software Engineer", "seniority": "senior" },
  "credits_used": 0,
  "request_id": "req_..."
}

Every response uses this envelope: success, data, credits_used, request_id.

3. Parse a job description

Point at any job posting URL — Greenhouse, Lever, and company career pages work directly:

curl -X POST "$BASE/parse/jd" \
  -H "x-access-key: $REZMATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://job-boards.greenhouse.io/acme/jobs/123456"}'

You get back a normalized Role: canonical title, seniority, must-have skills with min-years, nice-to-haves, and qualifications. 1 credit.

4. Parse a résumé

Same three input forms everywhere — text, url, or file (base64):

curl -X POST "$BASE/parse/resume" \
  -H "x-access-key: $REZMATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"file\": \"$(base64 -i resume.pdf)\"}"

PDFs are processed natively. The response is a full Candidate: E.164 phone, canonical location, work history with computed tenures, taxonomy-normalized skills, education — plus a bias-redacted scoring_view. 1 credit. The document itself is deleted the moment processing ends.

5. Score the match

Pass raw documents and Rezmatch.ai parses them inline, or pass the parsed JSON from steps 3-4 to skip re-parsing:

curl -X POST "$BASE/match" \
  -H "x-access-key: $REZMATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"resume_file\": \"$(base64 -i resume.pdf)\", \"jd_url\": \"https://job-boards.greenhouse.io/acme/jobs/123456\"}"

The result is a 0-100 score with a band (weak → excellent), met/missed requirements with evidence, and grounded notes. Scoring always runs on the redacted feature view. 2 credits + 1 per inline parse.

Next steps

Last updated on
IntroductionAuthentication