Documentation
Everything you need to use CVAgent — from uploading your first resume to calling the REST API from your own application.
Getting Started
Upload your first resume and get an ATS score in under 30 seconds.
Resume Analyzer
Full reference for the analysis output — scores, keywords, recruiter feedback.
Resume Builder
Build ATS-optimised resumes from templates with live preview.
Portfolio Website Builder
Turn your resume into a standalone portfolio website in one click.
Interview Prep
Generate personalised interview questions from your resume and target role.
REST API
Integrate CVAgent into your own product using our FastAPI-based REST API.
API Quick Reference
Base URL: /api
/resume/uploadUpload a PDF or DOCX resume. Returns resume_id.
/analysis/fullRun full ATS + JD + AI analysis on a resume.
/templates/List all available resume templates.
/templates/renderRender a template with user data. Returns download URL.
/career-tools/portfolioGenerate a portfolio HTML file from user profile.
/resume-editor/uploadUpload a resume for editing. Returns filename.
/resume-editor/exportApply edits and export the updated resume.
/interview/generateGenerate personalised interview questions.
/chat/textSend a chat message and receive an AI reply.
Example Request
curl -X POST /api/analysis/full \
-H "Content-Type: application/json" \
-d '{
"resume_id": "abc123",
"target_role": "Software Engineer",
"job_description": "..."
}'Intelligence Hub — 53 AI Tools
All tools accept plain text and return structured JSON. Full reference at /api-docs.
Salary Estimator
Get a market salary range for your role.
Career Trajectory
Map your next 5-year career path.
Recruiter Simulator
6-second scan and hire/no-hire verdict.
LinkedIn Optimiser
AI-optimised headline, about, and skills.
Market Benchmark
Compare against top-offer candidates.
Career Switcher
Pivot roadmap for any field change.
Rejection Analyser
Why you are not hearing back — with fixes.
Tone & Persona
Startup, corporate, creative, or academic rewrite.
Application Pack
Cover letter + interview answers in one click.
Project Quality Scorer
Grade, verdict, and improvement roadmap.
Company Mode Advisor
Tailor your resume for any company type.
Cover Letter Generator
Write a tailored cover letter with tone control.
GitHub Profile Optimizer
Score and rewrite your GitHub bio, repos, and topics.
JD Red Flags Detector
Surface toxic culture signals, hidden requirements, and red flags.
Offer Deadline Coach
Scripts for requesting a deadline extension + handling pressure tactics.
Counter-Offer Coach
Negotiating power score, recommended counter number, and email script.
AI Career Chat
Conversational AI that knows your resume. Ask anything about your job search.
ATS Graveyard Checker
Discover formatting and keyword issues killing your ATS score before a human sees it.
Resume Bullet Rewriter
XYZ/STAR/CAR/PAR formula rewrites — turn passive responsibilities into impact bullets.
JD Analyser
Extract must-have skills, ATS keywords, culture signals, and a fit score from any JD.
Cold Email Generator
2–3 A/B email variants plus Day 5 and Day 10 follow-up sequences for any outreach goal.
Tech Interview Prep
Personalised DSA + system design + behavioural study plan and daily schedule by role.
Mock Interview Scorer
Self-score your mock interview across 7 dimensions with AI coaching notes.
Personal Branding Kit
Tagline, 30/60s pitches, Twitter bio, 3 LinkedIn headline variants, and brand archetype.
Career Break Explainer
Resume one-liner, cover letter paragraph, interview answer, and LinkedIn snippet for any gap.
Resume Tailoring Tool
Tailored resume with keywords injected + a full before/after change log for any JD.
Resume Formatter
Clean, consistently formatted resume text with diff view of every fix.
Salary Negotiation Coach
Word-for-word negotiation scripts — opening, counter, objection handlers, and follow-up email.
Interview Question Predictor
15–20 predicted questions across 6 categories with prep tips and sample openers.
Keywords Optimizer
Keyword density vs. a JD — over/under-used terms, placement gaps, and injection plan.
Achievement Amplifier
Turn vague responsibilities into quantified achievements with power verbs and metric suggestions.
LinkedIn Post Generator
Scroll-stopping posts for job announcements, career wins, and thought leadership.
Job Search Strategist
Week-by-week job search roadmap — target companies, daily actions, and outreach strategy.
First 90 Days Planner
Week-by-week onboarding plan with quick wins, relationship targets, and success metrics.
Thank-You Email Generator
3 personalised post-interview thank-you variants — professional, warm, or concise.
Offer Letter Analyzer
Grade (A–F), key term extraction, red flag detection, and negotiation scripts for any offer.
Skills Matrix Builder
Readiness score, gap analysis with resources, and a personalised 90-day learning roadmap.
Can't find what you're looking for?
Our team is happy to help with integration questions, API usage, or enterprise setup.