Vitae Documentation
Build reliable integrations with Vitae. Start with authentication, then implement candidate matching and agent workflows.
Getting Started
Candidate Matching API
Candidate Matching Overview
Understand how Vitae candidate matching works, when to use it, and the core endpoint used by agent workflows.
Matching Request & Response
Detailed request and response reference for POST /api/v1/candidates/match with practical curl and TypeScript examples.
Candidate Matching Filters
Reference and best practices for MatchFilters: skills, languages, country, and city constraints in matching requests.
Matching Errors & Limits
Troubleshoot matching API failures and understand quotas, 429 behavior, and plan limits for Professional and Enterprise.
Agent Integrations
AI Agent Skill Integration
Give AI agents access to Vitae candidate matching. Configure API keys, add agent instructions, and automate talent shortlisting.
Inbox Automation Pattern
Build inbox-driven automation to detect job descriptions in email, call matching, and return candidate shortlists automatically.
Templates
Template Permissions Matrix
Understand template editing capabilities by tier, including structure, branding, and full LaTeX/sty controls.
Fork, Version, and Restore
Safe template evolution workflow with forking, immutable version snapshots, and restore practices.
Template Preview & Rendering
Deep dive into template content resolution, style fallback behavior, and rendering pipeline troubleshooting.
Template Errors & Sanitization
Diagnose LaTeX and sty validation failures, sanitization errors, and safe correction workflows.
Regular Template Guide (Docs)
Developer-facing guide to regular template workflows: structure mode, branding controls, and operational rollout patterns.
LaTeX Template Guide (Docs)
Technical documentation for Vitae LaTeX templates: fork workflow, .tex and .sty roles, placeholders, and safe iteration.