Reference

REST API

Integrate directly without the widget — full control over the request and response lifecycle.

Overview

The Resume Mapper REST API accepts a CV file in PDF, DOCX, or TXT format and returns a structured ParsedCV object. All requests must be authenticated with an API key obtained from your dashboard.

Authentication

Pass your API key in the X-API-Key request header on every call. Generate or rotate your key from the dashboard.

terminal

curl -X POST https://resume-mapper.dev/api/parse \
  -H "X-API-Key: rm_your_api_key" \
  -F "file=@resume.pdf"

POST/api/parse

Parses a CV file and returns structured data synchronously. The request must use multipart/form-data encoding.

Parameter	Type	Description
file	File required	The CV file. Accepted: PDF, DOCX, TXT. Max 10 MB.

Response schema

On success, the response includes rawData (raw parsed output) and mappedData (remapped via your field rules — Pro only).

response.json

{
  "success": true,
  "rawData": {
    "personal": {
      "name": "Jane Doe",
      "email": "jane@example.com",
      "phone": "+1 555 000 0000",
      "location": "San Francisco, CA",
      "linkedin": "linkedin.com/in/janedoe"
    },
    "experience": [
      {
        "title": "Senior Engineer",
        "company": "Acme Corp",
        "from": "2021-01",
        "to": null,
        "description": "Led backend platform team..."
      }
    ],
    "education": [],
    "skills": ["TypeScript", "React", "Node.js"],
    "languages": [{ "language": "English", "level": "Native" }],
    "certifications": [],
    "projects": []
  },
  "mappedData": {}
}

Rate limits

Plan	Monthly parses	Rate limit
Free	10	10 req/min
Starter	200	60 req/min
Pro	Unlimited	1 000 req/min

Error codes

On failure the API returns success: false and a human-readable error string.

error-response.json

{
  "success": false,
  "error": "File type not supported. Accepted: PDF, DOCX, TXT."
}

HTTP	Cause
400	Missing file, unsupported type, or file too large
401	Missing or invalid `X-API-Key`
402	Monthly parse quota exceeded
429	Rate limit exceeded
500	AI parsing failed — retry or contact support

Quick Start