Coming soon

Mira Resume REST API reference

The REST API exposes the same tools as the MCP server, for scripts, automations and a ChatGPT custom GPT. It needs a Pro, Elite or Lifetime plan and an API key.

API v1, November 2026
On this page

Base URL

Base URL
https://miraresume.com/api/v1

The 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
curl "https://miraresume.com/api/v1/me" \
  -H "Authorization: Bearer $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.

200 OK
{
  "data": {
    "...": "the result"
  }
}
404 Not Found
{
  "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.

HeaderMeaning
X-RateLimit-LimitYour daily request allowance.
X-RateLimit-RemainingRequests left today.
Retry-AfterSent with 429 responses: seconds to wait before trying again.
FeatureFreeProElite
API and MCP accessNoYesYes
Active API keys-210
Requests per day-3003,000
Requests per minute-3090
Resume, tracker and Mira Scout tools-YesYes
Resume vs job match check-Free, unlimited within limitsFree, unlimited within limits
AI tools that use credits-NoYes

Errors

CodeStatusMeaning
unauthorized401Missing, malformed, unknown or revoked API key.
plan_required403Your plan does not include the API, or this tool needs Elite.
scout_unavailable403Mira Scout is not available on your account yet.
not_found404No resume or application with that id on your account.
invalid_input400The body or a parameter failed validation; the message says which.
rate_limited429Too many requests this minute. Retry after the Retry-After header.
daily_limit429Today's request allowance is used up. Resets at 00:00 UTC.
insufficient_credits402Not enough AI credits for this tool.
ai_failed502The AI model did not return a usable answer. You were not charged.
internal500Something 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

Pro and EliteNo creditsRead-only

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
curl "https://miraresume.com/api/v1/me" \
  -H "Authorization: Bearer $MIRA_API_KEY"

GET/resumes

Pro and EliteNo creditsRead-only

List resumes. Lists your resumes with id, name, target role, last update and saved ATS score.

MCP tool: list_resumes

Query parameters

ParameterTypeRequiredDescription
limitintegerOptionalMax resumes to return (default 50).

Example

curl
curl "https://miraresume.com/api/v1/resumes?limit=10" \
  -H "Authorization: Bearer $MIRA_API_KEY"

POST/resumes

Pro and EliteNo creditsWrite

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

ParameterTypeRequiredDescription
namestringRequiredName shown in My Resumes, e.g. "Data Analyst - Acme".
target_rolestringOptionalThe role this resume targets.
resumeobjectOptionalInitial content. Omit to start empty.

Example

curl
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"
  }'

GET/resumes/{resume_id}

Pro and EliteNo creditsRead-only

Read a resume (?format=markdown for text). Returns one resume in full, as structured JSON or as Markdown.

MCP tool: get_resume

Path parameters

ParameterTypeRequiredDescription
resume_idstring (uuid)RequiredThe resume id (a UUID).

Query parameters

ParameterTypeRequiredDescription
format"json" | "markdown"Optional"json" (default) returns structured sections; "markdown" returns readable text.

Example

curl
curl "https://miraresume.com/api/v1/resumes/3f6c2a9e-1b7d-4c55-9a0e-8d2f4b6a1c07?format=markdown" \
  -H "Authorization: Bearer $MIRA_API_KEY"

PATCH/resumes/{resume_id}

Pro and EliteNo creditsWrite (replaces data)

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

ParameterTypeRequiredDescription
resume_idstring (uuid)RequiredThe resume id (a UUID).

JSON body

ParameterTypeRequiredDescription
namestringOptional-
target_rolestringOptional-
resumeobjectRequiredSections to replace. Sections you leave out are not changed.

Example

curl
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"
      ]
    }
  }'

POST/resumes/{resume_id}/match

Pro and EliteNo creditsRead-only

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

ParameterTypeRequiredDescription
resume_idstring (uuid)RequiredThe resume id (a UUID).

JSON body

ParameterTypeRequiredDescription
job_descriptionstringRequiredThe full job posting text.
job_titlestringOptionalThe job title, if it is not the first line of the posting.

Example

curl
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."
  }'

GET/applications

Pro and EliteNo creditsRead-only

List Job Tracker applications. Lists the applications in your Job Tracker, optionally by status.

MCP tool: list_applications

Query parameters

ParameterTypeRequiredDescription
status"wishlist" | "applied" | "interviewing" | "offered" | "rejected"Optional-
limitintegerOptionalMax rows (default 50).

Example

curl
curl "https://miraresume.com/api/v1/applications?status=interviewing" \
  -H "Authorization: Bearer $MIRA_API_KEY"

POST/applications

Pro and EliteNo creditsWrite

Add an application. Adds a job to your Job Tracker (default status: wishlist).

MCP tool: add_application

JSON body

ParameterTypeRequiredDescription
companystringRequired-
rolestringRequired-
job_urlstringOptional-
status"wishlist" | "applied" | "interviewing" | "offered" | "rejected"OptionalDefault "wishlist".
applied_datestringOptionalYYYY-MM-DD.
salarystringOptional-
notesstringOptional-
resume_idstring (uuid)OptionalThe resume version used for this application.

Example

curl
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"
  }'

PATCH/applications/{application_id}

Pro and EliteNo creditsWrite

Update an application. Changes an application's status, notes or next step.

MCP tool: update_application

Path parameters

ParameterTypeRequiredDescription
application_idstring (uuid)RequiredThe application id (a UUID).

JSON body

ParameterTypeRequiredDescription
status"wishlist" | "applied" | "interviewing" | "offered" | "rejected"Optional-
notesstringOptional-
next_actionstringOptional-
next_action_datestringOptionalYYYY-MM-DD.

Example

curl
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"
  }'

GET/scout/matches

Pro and EliteNo creditsRead-only

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

ParameterTypeRequiredDescription
status"new" | "saved" | "applied" | "dismissed"OptionalDefault "new".
min_scoreintegerOptional-
limitintegerOptionalMax matches (default 25).

Example

curl
curl "https://miraresume.com/api/v1/scout/matches?status=new" \
  -H "Authorization: Bearer $MIRA_API_KEY"

POST/ai/analyze-job

Elite30 creditsRead-only

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

ParameterTypeRequiredDescription
job_descriptionstringRequiredThe full job posting text.
target_rolestringOptional-

Example

curl
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."
  }'

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.

Read this page with AI

Open this page in your assistant with a ready prompt: it explains the setup in plain language and walks you through it.