API Documentation
Integrate Vaultd's resume optimization engine into your application, agent, or workflow. Parse resumes, check ATS scores, generate optimized content, and tailor to job descriptions — all via a simple REST API.
Quick Start
Sign up at vaultd.ai to get an API key. You get 3 free credits to test. Each API call costs 1 credit.
curl -X POST https://vaultd.ai/api/v1/ats-check \
-H "Authorization: Bearer vaultd_sk_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"resumeText": "John Doe, Software Engineer...",
"industry": "technology"
}'Authentication
All requests require a Bearer token in the Authorization header.
Authorization: Bearer vaultd_sk_...Rate Limit
60 requests/minute
Credits Per Call
1 credit
Endpoints
/api/v1/ats-checkAnalyze resume text for ATS compatibility
Input
{ resumeText, industry? }Output
Score (0-100), breakdown, issues, keywords/api/v1/generateGenerate an AI-optimized resume
Input
{ personalInfo, experience, education, skills, industry }Output
Optimized resume content/api/v1/tailorTailor resume to a job description
Input
{ resumeData, jobDescription }Output
Tailored changes, match score, keyword analysis/api/v1/parseParse a PDF or DOCX resume file
Input
multipart/form-data with "resume" fileOutput
Structured resume data with auto-detected industry/api/v1/optimizeOptimize a resume section
Input
{ content, industry, jobTitle?, section? }Output
ATS-optimized content/api/v1/usageCheck remaining credits and rate limit
Input
(none)Output
Credits remaining, rate limit, key metadataPricing
Free
3 credits on signup
$4.99
10 credits
$19.99
50 credits
OpenAPI Spec
Full machine-readable API specification for integration with tools, agents, and code generators.
GET /api/v1/openapi.jsonMCP Server (Claude Integration)
Vaultd exposes an MCP (Model Context Protocol) server for direct integration with Claude, Cursor, and other MCP-compatible clients. Tools available: vaultd_ats_check, vaultd_generate_resume, vaultd_tailor_resume, vaultd_optimize_section.
Connect via Streamable HTTP:
{
"mcpServers": {
"vaultd": {
"url": "https://vaultd.ai/api/mcp/mcp"
}
}
}Or for stdio-only clients (e.g. Claude Desktop):
{
"mcpServers": {
"vaultd": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://vaultd.ai/api/mcp/mcp"]
}
}
}OpenAI Actions / Custom GPT
Build a custom GPT that uses Vaultd as an action. Use the GPT-optimized spec (excludes file upload; use openapi.json for full API).
- Open the GPT editor at chat.openai.com/gpts/editor
- Under Actions, click "Import from URL"
- Enter:
https://vaultd.ai/api/v1/openapi-gpt.json - Set authentication to API Key (Bearer) with your Vaultd API key
Full setup guide: docs/openai-gpt-setup.md
For AI Agents
Vaultd is designed for agent-to-agent commerce. If you're building a career coaching agent, job search assistant, or HR automation tool, Vaultd provides resume optimization as a service.
- MCP server for Claude and MCP-compatible agents
- OpenAI Actions compatible via OpenAPI spec
- No browser or UI required — pure API
- Structured JSON responses for programmatic consumption
Questions? support@vaultd.ai