JobIntel.ai API

RESTful API for JobIntel.ai - AI-powered career assistance platform

v1.0.0Download OpenAPI specification
API Categories
POST/api/auth/login
User login

Authenticate a user and receive session tokens

Authentication

Request Body

User credentials for authentication

application/jsonrequired
emailstringemailrequiredUser email address
passwordstringrequiredUser password (minimum 8 characters)

Responses

200Login successful
401Invalid credentials
429Too many login attempts

Operation ID: loginUser

POST/api/auth/logout
User logout

End the current user session

Authentication

Responses

200Logout successful
401Not authenticated

Operation ID: logoutUser

GET/api/cover-letters
List cover letters

Get all cover letters for the authenticated user

Cover Letters

Parameters

limitqueryinteger

Maximum number of cover letters to return

Default: 10

offsetqueryinteger

Number of cover letters to skip

Default: 0

Responses

200List of cover letters
401Not authenticated

Operation ID: listCoverLetters

POST/api/cover-letters
Create cover letter

Generate a new AI-powered cover letter

Cover Letters

Request Body

Cover letter creation parameters

application/jsonrequired
jobTitlestringrequiredThe job title to apply for
companystringrequiredCompany name
jobDescriptionstringrequiredFull job posting description
cvIdstringuuidReference to uploaded CV (optional)

Responses

201Cover letter created
400Invalid input
401Not authenticated
429Rate limit exceeded

Operation ID: createCoverLetter

GET/api/cover-letters/{id}
Get cover letter

Retrieve a specific cover letter by ID

Cover Letters

Parameters

idpathstringrequired

Unique identifier of the cover letter

Responses

200Cover letter details
401Not authenticated
404Cover letter not found

Operation ID: getCoverLetter

PUT/api/cover-letters/{id}
Update cover letter

Update an existing cover letter

Cover Letters

Parameters

idpathstringrequired

Unique identifier of the cover letter to update

Responses

200Cover letter updated
400Invalid input
401Not authenticated
404Cover letter not found

Operation ID: updateCoverLetter

DELETE/api/cover-letters/{id}
Delete cover letter

Remove a cover letter

Cover Letters

Parameters

idpathstringrequired

Unique identifier of the cover letter to delete

Responses

204Cover letter deleted
401Not authenticated
404Cover letter not found

Operation ID: deleteCoverLetter

POST/api/cv-analysis
Analyze CV

Upload and analyze a CV using AI

CV Analysis

Responses

200Analysis complete
400Invalid file format
401Not authenticated
413File too large
429Rate limit exceeded

Operation ID: analyzeCV

GET/api/cv-analysis/{id}
Get CV analysis

Retrieve CV analysis results

CV Analysis

Responses

200Analysis results
401Not authenticated
404Analysis not found

Operation ID: getCVAnalysis

GET/api/applications
List job applications

Get all job applications for the user

Applications

Responses

200List of applications
401Not authenticated

Operation ID: listApplications

POST/api/applications
Track application

Add a new job application to track

Applications

Responses

201Application created
400Invalid input
401Not authenticated

Operation ID: createApplication

POST/api/interview-prep
Generate interview questions

Generate AI-powered interview questions based on job role

Interview Prep

Responses

200Questions generated
400Invalid input
401Not authenticated
429Rate limit exceeded

Operation ID: generateQuestions

GET/api/user/profile
Get user profile

Retrieve the current user profile

User

Responses

200User profile
401Not authenticated

Operation ID: getUserProfile

PUT/api/user/profile
Update user profile

Update user profile information

User

Responses

200Profile updated
400Invalid input
401Not authenticated

Operation ID: updateUserProfile

GET/api/subscription
Get subscription status

Check current subscription plan and usage

Billing

Responses

200Subscription details
401Not authenticated

Operation ID: getSubscription

POST/api/subscription
Subscribe to plan

Subscribe to a premium plan

Billing

Responses

201Subscription created
400Invalid plan
401Not authenticated
402Payment required

Operation ID: createSubscription

This documentation is automatically generated

For more information, see the OpenAPI specification