Base URL
https://miraresume.com/api/v1The OpenAPI 3.1 description is public: https://miraresume.com/api/v1/openapi.json. Import it into Postman, Insomnia, a code generator or a custom GPT.
Authentication
Create a key in Dashboard > API & MCP (shown once; keys start with mira_sk_) and send it as a Bearer token. Keep it in an environment variable, not in your code.
curl "https://miraresume.com/api/v1/me" \
-H "Authorization: Bearer $MIRA_API_KEY"curl "https://miraresume.com/api/v1/me" \
-H "x-api-key: $MIRA_API_KEY"The API does not use cookies, and it does not support OAuth yet. Revoke a key in the dashboard and it stops working on the next request.
Response envelope
Successful responses wrap the result in data. Errors return an error object with a stable code and a readable message.
{
"data": {
"...": "the result"
}
}{
"error": {
"code": "not_found",
"message": "No resume with that id on your account."
}
}Rate limits
Limits apply per account across all keys, and REST and MCP requests count together. The daily count resets at 00:00 UTC.
| Header | Meaning |
|---|---|
X-RateLimit-Limit | Your daily request allowance. |
X-RateLimit-Remaining | Requests left today. |
Retry-After | Sent with 429 responses: seconds to wait before trying again. |
| Feature | Free | Pro | Elite |
|---|---|---|---|
| API and MCP access | No | Yes | Yes |
| Active API keys | - | 2 | 10 |
| Requests per day | - | 300 | 3,000 |
| Requests per minute | - | 30 | 90 |
| Resume, tracker and Mira Scout tools | - | Yes | Yes |
| Resume vs job match check | - | Free, unlimited within limits | Free, unlimited within limits |
| AI tools that use credits | - | No | Yes |
Errors
| Code | Status | Meaning |
|---|---|---|
unauthorized | 401 | Missing, malformed, unknown or revoked API key. |
plan_required | 403 | Your plan does not include the API, or this tool needs Elite. |
scout_unavailable | 403 | Mira Scout is not available on your account yet. |
not_found | 404 | No resume or application with that id on your account. |
invalid_input | 400 | The body or a parameter failed validation; the message says which. |
rate_limited | 429 | Too many requests this minute. Retry after the Retry-After header. |
daily_limit | 429 | Today's request allowance is used up. Resets at 00:00 UTC. |
insufficient_credits | 402 | Not enough AI credits for this tool. |
ai_failed | 502 | The AI model did not return a usable answer. You were not charged. |
internal | 500 | Something went wrong on our side. |
Endpoints
Paths are relative to the base URL. Examples read the key from the MIRA_API_KEY environment variable and use placeholder ids.
GET/me
Your plan, credits and API usage. Your plan, AI credits left this month, and today's API usage and limits.
MCP tool: get_account
No parameters.
Example
curl "https://miraresume.com/api/v1/me" \
-H "Authorization: Bearer $MIRA_API_KEY"const res = await fetch("https://miraresume.com/api/v1/me", {
headers: { Authorization: `Bearer ${process.env.MIRA_API_KEY}` },
});
const { data, error } = await res.json();
if (!res.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://miraresume.com/api/v1/me",
headers={"Authorization": f"Bearer {os.environ['MIRA_API_KEY']}"},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["message"])
print(payload["data"])GET/resumes
List resumes. Lists your resumes with id, name, target role, last update and saved ATS score.
MCP tool: list_resumes
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | Optional | Max resumes to return (default 50). |
Example
curl "https://miraresume.com/api/v1/resumes?limit=10" \
-H "Authorization: Bearer $MIRA_API_KEY"const res = await fetch("https://miraresume.com/api/v1/resumes?limit=10", {
headers: { Authorization: `Bearer ${process.env.MIRA_API_KEY}` },
});
const { data, error } = await res.json();
if (!res.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://miraresume.com/api/v1/resumes",
headers={"Authorization": f"Bearer {os.environ['MIRA_API_KEY']}"},
params={
"limit": 10,
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["message"])
print(payload["data"])POST/resumes
Create a resume. Creates a new resume, optionally with content. It appears in My Resumes and opens in the editor.
MCP tool: create_resume
JSON body
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Required | Name shown in My Resumes, e.g. "Data Analyst - Acme". |
target_role | string | Optional | The role this resume targets. |
resume | object | Optional | Initial content. Omit to start empty. |
Example
curl -X POST "https://miraresume.com/api/v1/resumes" \
-H "Authorization: Bearer $MIRA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Data Analyst - Acme"
}'const res = await fetch("https://miraresume.com/api/v1/resumes", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.MIRA_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Data Analyst - Acme"
}),
});
const { data, error } = await res.json();
if (!res.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);import os
import requests
res = requests.post(
"https://miraresume.com/api/v1/resumes",
headers={"Authorization": f"Bearer {os.environ['MIRA_API_KEY']}"},
json={
"name": "Data Analyst - Acme",
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["message"])
print(payload["data"])GET/resumes/{resume_id}
Read a resume (?format=markdown for text). Returns one resume in full, as structured JSON or as Markdown.
MCP tool: get_resume
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
resume_id | string (uuid) | Required | The resume id (a UUID). |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
format | "json" | "markdown" | Optional | "json" (default) returns structured sections; "markdown" returns readable text. |
Example
curl "https://miraresume.com/api/v1/resumes/3f6c2a9e-1b7d-4c55-9a0e-8d2f4b6a1c07?format=markdown" \
-H "Authorization: Bearer $MIRA_API_KEY"const res = await fetch("https://miraresume.com/api/v1/resumes/3f6c2a9e-1b7d-4c55-9a0e-8d2f4b6a1c07?format=markdown", {
headers: { Authorization: `Bearer ${process.env.MIRA_API_KEY}` },
});
const { data, error } = await res.json();
if (!res.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://miraresume.com/api/v1/resumes/3f6c2a9e-1b7d-4c55-9a0e-8d2f4b6a1c07",
headers={"Authorization": f"Bearer {os.environ['MIRA_API_KEY']}"},
params={
"format": "markdown",
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["message"])
print(payload["data"])PATCH/resumes/{resume_id}
Replace resume sections. Replaces the sections you send (for example summary, skills or experience). Sections you leave out stay as they are.
MCP tool: update_resume
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
resume_id | string (uuid) | Required | The resume id (a UUID). |
JSON body
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Optional | - |
target_role | string | Optional | - |
resume | object | Required | Sections to replace. Sections you leave out are not changed. |
Example
curl -X PATCH "https://miraresume.com/api/v1/resumes/3f6c2a9e-1b7d-4c55-9a0e-8d2f4b6a1c07" \
-H "Authorization: Bearer $MIRA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"resume": {
"summary": "Data analyst with 4 years of SQL and Python experience, building dashboards that product teams use every week.",
"skills": [
"SQL",
"Python",
"Tableau",
"A/B testing"
]
}
}'const res = await fetch("https://miraresume.com/api/v1/resumes/3f6c2a9e-1b7d-4c55-9a0e-8d2f4b6a1c07", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.MIRA_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"resume": {
"summary": "Data analyst with 4 years of SQL and Python experience, building dashboards that product teams use every week.",
"skills": [
"SQL",
"Python",
"Tableau",
"A/B testing"
]
}
}),
});
const { data, error } = await res.json();
if (!res.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);import os
import requests
res = requests.patch(
"https://miraresume.com/api/v1/resumes/3f6c2a9e-1b7d-4c55-9a0e-8d2f4b6a1c07",
headers={"Authorization": f"Bearer {os.environ['MIRA_API_KEY']}"},
json={
"resume": {
"summary": "Data analyst with 4 years of SQL and Python experience, building dashboards that product teams use every week.",
"skills": ["SQL", "Python", "Tableau", "A/B testing"],
},
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["message"])
print(payload["data"])POST/resumes/{resume_id}/match
Score a resume against a job posting. Scores a resume against a job posting (0-100) with matched and missing skills. The same deterministic scorer as Mira Scout; no AI, no credits.
MCP tool: check_resume_against_job
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
resume_id | string (uuid) | Required | The resume id (a UUID). |
JSON body
| Parameter | Type | Required | Description |
|---|---|---|---|
job_description | string | Required | The full job posting text. |
job_title | string | Optional | The job title, if it is not the first line of the posting. |
Example
curl -X POST "https://miraresume.com/api/v1/resumes/3f6c2a9e-1b7d-4c55-9a0e-8d2f4b6a1c07/match" \
-H "Authorization: Bearer $MIRA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"job_description": "Data Analyst, Acme Corp. We are hiring a data analyst to build dashboards and analyse product metrics. Requirements: 3+ years of experience, strong SQL and Python, Tableau or Power BI, A/B testing, clear written communication."
}'const res = await fetch("https://miraresume.com/api/v1/resumes/3f6c2a9e-1b7d-4c55-9a0e-8d2f4b6a1c07/match", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.MIRA_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"job_description": "Data Analyst, Acme Corp. We are hiring a data analyst to build dashboards and analyse product metrics. Requirements: 3+ years of experience, strong SQL and Python, Tableau or Power BI, A/B testing, clear written communication."
}),
});
const { data, error } = await res.json();
if (!res.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);import os
import requests
res = requests.post(
"https://miraresume.com/api/v1/resumes/3f6c2a9e-1b7d-4c55-9a0e-8d2f4b6a1c07/match",
headers={"Authorization": f"Bearer {os.environ['MIRA_API_KEY']}"},
json={
"job_description": "Data Analyst, Acme Corp. We are hiring a data analyst to build dashboards and analyse product metrics. Requirements: 3+ years of experience, strong SQL and Python, Tableau or Power BI, A/B testing, clear written communication.",
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["message"])
print(payload["data"])GET/applications
List Job Tracker applications. Lists the applications in your Job Tracker, optionally by status.
MCP tool: list_applications
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
status | "wishlist" | "applied" | "interviewing" | "offered" | "rejected" | Optional | - |
limit | integer | Optional | Max rows (default 50). |
Example
curl "https://miraresume.com/api/v1/applications?status=interviewing" \
-H "Authorization: Bearer $MIRA_API_KEY"const res = await fetch("https://miraresume.com/api/v1/applications?status=interviewing", {
headers: { Authorization: `Bearer ${process.env.MIRA_API_KEY}` },
});
const { data, error } = await res.json();
if (!res.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://miraresume.com/api/v1/applications",
headers={"Authorization": f"Bearer {os.environ['MIRA_API_KEY']}"},
params={
"status": "interviewing",
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["message"])
print(payload["data"])POST/applications
Add an application. Adds a job to your Job Tracker (default status: wishlist).
MCP tool: add_application
JSON body
| Parameter | Type | Required | Description |
|---|---|---|---|
company | string | Required | - |
role | string | Required | - |
job_url | string | Optional | - |
status | "wishlist" | "applied" | "interviewing" | "offered" | "rejected" | Optional | Default "wishlist". |
applied_date | string | Optional | YYYY-MM-DD. |
salary | string | Optional | - |
notes | string | Optional | - |
resume_id | string (uuid) | Optional | The resume version used for this application. |
Example
curl -X POST "https://miraresume.com/api/v1/applications" \
-H "Authorization: Bearer $MIRA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"company": "Acme Corp",
"role": "Data Analyst"
}'const res = await fetch("https://miraresume.com/api/v1/applications", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.MIRA_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"company": "Acme Corp",
"role": "Data Analyst"
}),
});
const { data, error } = await res.json();
if (!res.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);import os
import requests
res = requests.post(
"https://miraresume.com/api/v1/applications",
headers={"Authorization": f"Bearer {os.environ['MIRA_API_KEY']}"},
json={
"company": "Acme Corp",
"role": "Data Analyst",
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["message"])
print(payload["data"])PATCH/applications/{application_id}
Update an application. Changes an application's status, notes or next step.
MCP tool: update_application
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
application_id | string (uuid) | Required | The application id (a UUID). |
JSON body
| Parameter | Type | Required | Description |
|---|---|---|---|
status | "wishlist" | "applied" | "interviewing" | "offered" | "rejected" | Optional | - |
notes | string | Optional | - |
next_action | string | Optional | - |
next_action_date | string | Optional | YYYY-MM-DD. |
Example
curl -X PATCH "https://miraresume.com/api/v1/applications/7b1e9d24-5c3a-4f8e-b6d1-2a9c0e4f7b35" \
-H "Authorization: Bearer $MIRA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "interviewing"
}'const res = await fetch("https://miraresume.com/api/v1/applications/7b1e9d24-5c3a-4f8e-b6d1-2a9c0e4f7b35", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.MIRA_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"status": "interviewing"
}),
});
const { data, error } = await res.json();
if (!res.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);import os
import requests
res = requests.patch(
"https://miraresume.com/api/v1/applications/7b1e9d24-5c3a-4f8e-b6d1-2a9c0e4f7b35",
headers={"Authorization": f"Bearer {os.environ['MIRA_API_KEY']}"},
json={
"status": "interviewing",
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["message"])
print(payload["data"])GET/scout/matches
Mira Scout job matches. Jobs Mira Scout found for you, best first, with score, reasons and the link to apply.
MCP tool: list_job_matches
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
status | "new" | "saved" | "applied" | "dismissed" | Optional | Default "new". |
min_score | integer | Optional | - |
limit | integer | Optional | Max matches (default 25). |
Example
curl "https://miraresume.com/api/v1/scout/matches?status=new" \
-H "Authorization: Bearer $MIRA_API_KEY"const res = await fetch("https://miraresume.com/api/v1/scout/matches?status=new", {
headers: { Authorization: `Bearer ${process.env.MIRA_API_KEY}` },
});
const { data, error } = await res.json();
if (!res.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://miraresume.com/api/v1/scout/matches",
headers={"Authorization": f"Bearer {os.environ['MIRA_API_KEY']}"},
params={
"status": "new",
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["message"])
print(payload["data"])POST/ai/analyze-job
AI job description analysis (Elite, 30 credits). AI extraction of a posting's required and preferred skills, must-have keywords, seniority and responsibilities. Elite only; uses 30 credits, refunded if the AI fails.
MCP tool: analyze_job_description
JSON body
| Parameter | Type | Required | Description |
|---|---|---|---|
job_description | string | Required | The full job posting text. |
target_role | string | Optional | - |
Example
curl -X POST "https://miraresume.com/api/v1/ai/analyze-job" \
-H "Authorization: Bearer $MIRA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"job_description": "Data Analyst, Acme Corp. We are hiring a data analyst to build dashboards and analyse product metrics. Requirements: 3+ years of experience, strong SQL and Python, Tableau or Power BI, A/B testing, clear written communication."
}'const res = await fetch("https://miraresume.com/api/v1/ai/analyze-job", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.MIRA_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"job_description": "Data Analyst, Acme Corp. We are hiring a data analyst to build dashboards and analyse product metrics. Requirements: 3+ years of experience, strong SQL and Python, Tableau or Power BI, A/B testing, clear written communication."
}),
});
const { data, error } = await res.json();
if (!res.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);import os
import requests
res = requests.post(
"https://miraresume.com/api/v1/ai/analyze-job",
headers={"Authorization": f"Bearer {os.environ['MIRA_API_KEY']}"},
json={
"job_description": "Data Analyst, Acme Corp. We are hiring a data analyst to build dashboards and analyse product metrics. Requirements: 3+ years of experience, strong SQL and Python, Tableau or Power BI, A/B testing, clear written communication.",
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["message"])
print(payload["data"])Related
Using ChatGPT?
ChatGPT can call this API from a custom GPT: import the OpenAPI URL as an Action and add your key as a Bearer token. Step by step: Use Mira Resume in ChatGPT.- MCP server guide for Claude, Cursor, VS Code, Windsurf, Codex and Gemini CLI
- Resume MCP server overview
- Developer docs home
- Pricing