Documentation

API Documentation Overview

SmartCV API documentation provides complete REST API interface descriptions and usage guides for developers

Updated: 12/30/2024

SmartCV provides a complete REST API that allows developers to integrate our resume creation and management features into third-party applications.

🚀 API Overview

SmartCV API is based on REST architecture, uses JSON format for data exchange, and supports standard HTTP methods and status codes.

Core Features

🔐 User Authentication

Secure authentication system based on NextAuth.js

OAuth social login
Email password authentication
JWT Token management
Session state maintenance

📄 Resume Management

Complete resume CRUD operations and advanced features

Create, edit, delete resumes
Resume content management
Export multiple formats
Share and collaboration

🎨 Template System

Rich resume templates and customization features

Template lists and categories
Custom style configuration
Preview and apply
Dynamic rendering

🤖 AI Services

Powerful AI analysis and optimization features

ATS compatibility analysis
Keyword matching
Intelligent suggestion generation
Theme recommendations

🔧 Quick Start

Basic Information

Base URL: https://smartcv.cc/api
API Version: v1
Data Format: JSON
Authentication: Session Cookie / JWT Token

Basic Request Format

GET /api/resumes
Content-Type: application/json
Cookie: next-auth.session-token=<token>

Response Format

All API responses follow a unified format:

{
  "success": true,
  "data": {
    // Response data
  },
  "meta": {
    // Metadata (optional)
  }
}

Error response format:

{
  "error": "Error description",
  "code": "ERROR_CODE"
}

📋 API Endpoint Categories

Authentication System - User login, registration, session management

Resume Management

Resume API - Resume creation, editing, deletion, and querying

Template System

Template API - Template management and customization

User Management

User API - User information and account management

AI Features

AI Analysis API - ATS analysis, intelligent suggestions and other AI services

Webhooks

Webhooks - Event notifications and callbacks

🔍 Status Code Description

Status Code	Description
200	Success
201	Created Successfully
400	Request Parameter Error
401	Unauthorized
403	Forbidden
404	Resource Not Found
422	Data Validation Failed
500	Internal Server Error

🚦 Limit Description

Request Rate Limits

Free Users: 100 requests/hour
Paid Users: 1000 requests/hour
Enterprise Users: Unlimited

Data Limits

Resume Count:
- Free users: 5 resumes
- Paid users: Unlimited
File Upload: Maximum 10MB
API Response: Maximum 1MB

🛠 Development Tools

SDK and Examples

We provide the following development resources:

Testing Environment

Development Environment: https://dev-api.smartcv.cc
Testing Environment: https://test-api.smartcv.cc
Production Environment: https://smartcv.cc/api

📞 Support and Feedback

If you encounter any issues while using the API, please contact us:

Technical Support: support@smartcv.cc

Next Steps

🔐 Authentication System

Learn how to perform user authentication and authorization

View Authentication Documentation →