Technical Reference
Last Updated: 2/1/2025
Comprehensive technical documentation for developers and technical integrators looking to understand the Resuming platform's API and technical capabilities.
API Overview
🌐
RESTful Architecture
Standardized, predictable API design for seamless integration.
📦
JSON Responses
Consistent, machine-readable JSON data formats.
🔢
Versioned API
Stable, backward-compatible API versions.
🔐
OAuth 2.0
Secure, token-based authentication mechanism.
Authentication Methods
Secure access to Resuming API endpoints:
- Bearer Token Authentication
- OAuth 2.0 Client Credentials
- API Key Support
- JWT Token Validation
- Refresh Token Mechanism
CV Analysis Endpoint
Endpoint
POST /api/v1/cv/analyze
Request Parameters
file
: CV document (PDF/DOCX)jobDescription
: Optional context for targeted analysislanguage
: Preferred analysis language
Response Structure
{
"atsScore": 75,
"strengths": [...],
"weaknesses": [...],
"recommendations": [...],
"metadata": {
"processingTime": 7.5,
"modelVersion": "2.1.0"
}
}
AI Processing Capabilities
Advanced AI-powered analysis features:
- GPT-4 Language Model
- Natural Language Processing
- Machine Learning Optimization
- Multi-language Support
- Contextual Understanding
Rate Limits & Quotas
Plan | Monthly Analyses | Requests/Minute | Processing Priority |
---|---|---|---|
Free | 1 | 2 | Low |
Pro | 10 | 5 | Medium |
Moonlighting | 20 | 10 | High |
CEO | Unlimited | 50 | Top |
Error Handling
Standardized error response format:
{
"error": {
"code": "INVALID_PARAMETER",
"message": "Invalid file format",
"details": "Supported formats: PDF, DOCX",
"timestamp": "2025-02-01T12:34:56Z"
}
}
Webhook Integration
Real-time event notifications:
- CV Analysis Completion
- Job Recommendation Updates
- Account Status Changes
- Customizable Endpoint Configuration
Contact & Support
For technical inquiries or API support, contact us at hi@resuming.ai.
We provide comprehensive documentation and support for seamless integration.