{"openapi":"3.1.0","info":{"title":"Mira Resume API","version":"1.0.0","description":"Read and update your Mira Resume resumes, Job Tracker and Mira Scout matches. Pro and Elite plans. Authenticate with an API key from Dashboard > API & MCP (Authorization: Bearer mira_sk_...). Docs: https://miraresume.com/docs/api"},"servers":[{"url":"https://miraresume.com/api/v1"}],"security":[{"bearerAuth":[]}],"paths":{"/me":{"get":{"operationId":"get_account","summary":"Your plan, credits and API usage.","description":"Your plan, AI credits left this month, and today's API usage and limits.","tags":["Account"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/resumes":{"get":{"operationId":"list_resumes","summary":"List resumes.","description":"Lists your resumes with id, name, target role, last update and saved ATS score.","tags":["Resumes"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Max resumes to return (default 50)."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"create_resume","summary":"Create a resume.","description":"Creates a new resume, optionally with content. It appears in My Resumes and opens in the editor.","tags":["Resumes"],"parameters":[],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"Name shown in My Resumes, e.g. \"Data Analyst - Acme\"."},"target_role":{"description":"The role this resume targets.","type":"string","maxLength":200},"resume":{"description":"Initial content. Omit to start empty.","type":"object","properties":{"contact":{"type":"object","properties":{"name":{"type":"string","maxLength":200},"email":{"type":"string","maxLength":200},"phone":{"type":"string","maxLength":60},"linkedin":{"type":"string","maxLength":300},"location":{"type":"string","maxLength":200},"headline":{"type":"string","maxLength":200}},"additionalProperties":false,"description":"Contact details. Only the fields you send change."},"summary":{"type":"string","maxLength":3000,"description":"Professional summary."},"experience":{"maxItems":30,"type":"array","items":{"type":"object","properties":{"title":{"type":"string","maxLength":200,"description":"Job title."},"company":{"type":"string","maxLength":200,"description":"Employer."},"duration":{"type":"string","maxLength":100,"description":"Dates as shown on the resume, e.g. \"Jan 2022 - Present\"."},"bullets":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":600},"description":"Achievement bullets, one sentence each."}},"required":["title","company","duration","bullets"],"additionalProperties":false},"description":"Work experience, newest first. Replaces the whole section."},"education":{"maxItems":15,"type":"array","items":{"type":"object","properties":{"school":{"type":"string","maxLength":200},"degree":{"type":"string","maxLength":200},"year":{"type":"string","maxLength":60}},"required":["school","degree","year"],"additionalProperties":false},"description":"Education. Replaces the whole section."},"skills":{"maxItems":100,"type":"array","items":{"type":"string","maxLength":100},"description":"Skills. Replaces the whole list."},"achievements":{"maxItems":30,"type":"array","items":{"type":"string","maxLength":600},"description":"Key achievements. Replaces the whole list."},"projects":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":200},"description":{"type":"string","maxLength":1500},"technologies":{"maxItems":30,"type":"array","items":{"type":"string","maxLength":80}}},"required":["name","description","technologies"],"additionalProperties":false},"description":"Projects. Replaces the whole section."},"certifications":{"maxItems":40,"type":"array","items":{"type":"string","maxLength":300},"description":"Certifications. Replaces the whole list."},"languages":{"maxItems":30,"type":"array","items":{"type":"string","maxLength":100},"description":"Languages. Replaces the whole list."},"volunteering":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"type":"string","maxLength":200,"description":"Job title."},"company":{"type":"string","maxLength":200,"description":"Employer."},"duration":{"type":"string","maxLength":100,"description":"Dates as shown on the resume, e.g. \"Jan 2022 - Present\"."},"bullets":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":600},"description":"Achievement bullets, one sentence each."}},"required":["title","company","duration","bullets"],"additionalProperties":false},"description":"Internships and volunteering. Replaces the whole section."}},"additionalProperties":false}},"required":["name"],"additionalProperties":false}}}}}},"/resumes/{resume_id}":{"get":{"operationId":"get_resume","summary":"Read a resume (?format=markdown for text).","description":"Returns one resume in full, as structured JSON or as Markdown.","tags":["Resumes"],"parameters":[{"name":"resume_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The resume id (a UUID)."},{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["json","markdown"]},"description":"\"json\" (default) returns structured sections; \"markdown\" returns readable text."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"operationId":"update_resume","summary":"Replace resume sections.","description":"Replaces the sections you send (for example summary, skills or experience). Sections you leave out stay as they are.","tags":["Resumes"],"parameters":[{"name":"resume_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The resume id (a UUID)."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"target_role":{"type":"string","maxLength":200},"resume":{"type":"object","properties":{"contact":{"type":"object","properties":{"name":{"type":"string","maxLength":200},"email":{"type":"string","maxLength":200},"phone":{"type":"string","maxLength":60},"linkedin":{"type":"string","maxLength":300},"location":{"type":"string","maxLength":200},"headline":{"type":"string","maxLength":200}},"additionalProperties":false,"description":"Contact details. Only the fields you send change."},"summary":{"type":"string","maxLength":3000,"description":"Professional summary."},"experience":{"maxItems":30,"type":"array","items":{"type":"object","properties":{"title":{"type":"string","maxLength":200,"description":"Job title."},"company":{"type":"string","maxLength":200,"description":"Employer."},"duration":{"type":"string","maxLength":100,"description":"Dates as shown on the resume, e.g. \"Jan 2022 - Present\"."},"bullets":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":600},"description":"Achievement bullets, one sentence each."}},"required":["title","company","duration","bullets"],"additionalProperties":false},"description":"Work experience, newest first. Replaces the whole section."},"education":{"maxItems":15,"type":"array","items":{"type":"object","properties":{"school":{"type":"string","maxLength":200},"degree":{"type":"string","maxLength":200},"year":{"type":"string","maxLength":60}},"required":["school","degree","year"],"additionalProperties":false},"description":"Education. Replaces the whole section."},"skills":{"maxItems":100,"type":"array","items":{"type":"string","maxLength":100},"description":"Skills. Replaces the whole list."},"achievements":{"maxItems":30,"type":"array","items":{"type":"string","maxLength":600},"description":"Key achievements. Replaces the whole list."},"projects":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":200},"description":{"type":"string","maxLength":1500},"technologies":{"maxItems":30,"type":"array","items":{"type":"string","maxLength":80}}},"required":["name","description","technologies"],"additionalProperties":false},"description":"Projects. Replaces the whole section."},"certifications":{"maxItems":40,"type":"array","items":{"type":"string","maxLength":300},"description":"Certifications. Replaces the whole list."},"languages":{"maxItems":30,"type":"array","items":{"type":"string","maxLength":100},"description":"Languages. Replaces the whole list."},"volunteering":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"type":"string","maxLength":200,"description":"Job title."},"company":{"type":"string","maxLength":200,"description":"Employer."},"duration":{"type":"string","maxLength":100,"description":"Dates as shown on the resume, e.g. \"Jan 2022 - Present\"."},"bullets":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":600},"description":"Achievement bullets, one sentence each."}},"required":["title","company","duration","bullets"],"additionalProperties":false},"description":"Internships and volunteering. Replaces the whole section."}},"additionalProperties":false,"description":"Sections to replace. Sections you leave out are not changed."}},"required":["resume"],"additionalProperties":false}}}}}},"/resumes/{resume_id}/match":{"post":{"operationId":"check_resume_against_job","summary":"Score a resume against a job posting.","description":"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.","tags":["Resumes"],"parameters":[{"name":"resume_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The resume id (a UUID)."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"job_description":{"type":"string","minLength":80,"maxLength":20000,"description":"The full job posting text."},"job_title":{"description":"The job title, if it is not the first line of the posting.","type":"string","maxLength":200}},"required":["job_description"],"additionalProperties":false}}}}}},"/applications":{"get":{"operationId":"list_applications","summary":"List Job Tracker applications.","description":"Lists the applications in your Job Tracker, optionally by status.","tags":["Job tracker"],"parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["wishlist","applied","interviewing","offered","rejected"]},"description":""},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200},"description":"Max rows (default 50)."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"add_application","summary":"Add an application.","description":"Adds a job to your Job Tracker (default status: wishlist).","tags":["Job tracker"],"parameters":[],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"string","minLength":1,"maxLength":200},"role":{"type":"string","minLength":1,"maxLength":200},"job_url":{"type":"string","maxLength":2000,"format":"uri"},"status":{"description":"Default \"wishlist\".","type":"string","enum":["wishlist","applied","interviewing","offered","rejected"]},"applied_date":{"description":"YYYY-MM-DD.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"salary":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":5000},"resume_id":{"description":"The resume version used for this application.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["company","role"],"additionalProperties":false}}}}}},"/applications/{application_id}":{"patch":{"operationId":"update_application","summary":"Update an application.","description":"Changes an application's status, notes or next step.","tags":["Job tracker"],"parameters":[{"name":"application_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The application id (a UUID)."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["wishlist","applied","interviewing","offered","rejected"]},"notes":{"type":"string","maxLength":5000},"next_action":{"type":"string","maxLength":300},"next_action_date":{"description":"YYYY-MM-DD.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"additionalProperties":false}}}}}},"/scout/matches":{"get":{"operationId":"list_job_matches","summary":"Mira Scout job matches.","description":"Jobs Mira Scout found for you, best first, with score, reasons and the link to apply.","tags":["Mira Scout"],"parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["new","saved","applied","dismissed"]},"description":"Default \"new\"."},{"name":"min_score","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":100},"description":""},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Max matches (default 25)."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/ai/analyze-job":{"post":{"operationId":"analyze_job_description","summary":"AI job description analysis (Elite, 30 credits).","description":"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. Elite plan only. Uses 30 AI credits.","tags":["AI"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"job_description":{"type":"string","minLength":100,"maxLength":15000,"description":"The full job posting text."},"target_role":{"type":"string","maxLength":200}},"required":["job_description"],"additionalProperties":false}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Mira Resume API key (mira_sk_...)"}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["unauthorized","plan_required","scout_unavailable","not_found","invalid_input","rate_limited","daily_limit","insufficient_credits","ai_failed","internal"]},"message":{"type":"string"}},"required":["code","message"]}}}}}}