JobIntel.ai API

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

v1.0.0Télécharger la spécification OpenAPI

Catégories API

POST/api/auth/login

User login

Authenticate a user and receive session tokens

Authentication

Corps de la requête

User credentials for authentication

application/jsonrequired

emailstringemailrequiredUser email address

passwordstringrequiredUser password (minimum 8 characters)

Réponses

200Login successful

401Invalid credentials

429Too many login attempts

ID d'opération: loginUser

POST/api/auth/logout

User logout

End the current user session

Authentication

Réponses

200Logout successful

401Not authenticated

ID d'opération: logoutUser

GET/api/cover-letters

List cover letters

Get all cover letters for the authenticated user

Cover Letters

Paramètres

limitqueryinteger

Maximum number of cover letters to return

Default: 10

offsetqueryinteger

Number of cover letters to skip

Default: 0

Réponses

200List of cover letters

401Not authenticated

ID d'opération: listCoverLetters

POST/api/cover-letters

Create cover letter

Generate a new AI-powered cover letter

Cover Letters

Corps de la requête

Cover letter creation parameters

application/jsonrequired

jobTitlestringrequiredThe job title to apply for

companystringrequiredCompany name

jobDescriptionstringrequiredFull job posting description

cvIdstringuuidReference to uploaded CV (optional)

Réponses

201Cover letter created

400Invalid input

401Not authenticated

429Rate limit exceeded

ID d'opération: createCoverLetter

GET/api/cover-letters/{id}

Get cover letter

Retrieve a specific cover letter by ID

Cover Letters

Paramètres

idpathstringrequired

Unique identifier of the cover letter

Réponses

200Cover letter details

401Not authenticated

404Cover letter not found

ID d'opération: getCoverLetter

PUT/api/cover-letters/{id}

Update cover letter

Update an existing cover letter

Cover Letters

Paramètres

idpathstringrequired

Unique identifier of the cover letter to update

Réponses

200Cover letter updated

400Invalid input

401Not authenticated

404Cover letter not found

ID d'opération: updateCoverLetter

DELETE/api/cover-letters/{id}

Delete cover letter

Remove a cover letter

Cover Letters

Paramètres

idpathstringrequired

Unique identifier of the cover letter to delete

Réponses

204Cover letter deleted

401Not authenticated

404Cover letter not found

ID d'opération: deleteCoverLetter

POST/api/cv-analysis

Analyze CV

Upload and analyze a CV using AI

CV Analysis

Réponses

200Analysis complete

400Invalid file format

401Not authenticated

413File too large

429Rate limit exceeded

ID d'opération: analyzeCV

GET/api/cv-analysis/{id}

Get CV analysis

Retrieve CV analysis results

CV Analysis

Réponses

200Analysis results

401Not authenticated

404Analysis not found

ID d'opération: getCVAnalysis

GET/api/applications

List job applications

Get all job applications for the user

Applications

Réponses

200List of applications

401Not authenticated

ID d'opération: listApplications

POST/api/applications

Track application

Add a new job application to track

Applications

Réponses

201Application created

400Invalid input

401Not authenticated

ID d'opération: createApplication

POST/api/interview-prep

Generate interview questions

Generate AI-powered interview questions based on job role

Interview Prep

Réponses

200Questions generated

400Invalid input

401Not authenticated

429Rate limit exceeded

ID d'opération: generateQuestions

GET/api/user/profile

Get user profile

Retrieve the current user profile

User

Réponses

200User profile

401Not authenticated

ID d'opération: getUserProfile

PUT/api/user/profile

Update user profile

Update user profile information

User

Réponses

200Profile updated

400Invalid input

401Not authenticated

ID d'opération: updateUserProfile

GET/api/subscription

Get subscription status

Check current subscription plan and usage

Billing

Réponses

200Subscription details

401Not authenticated

ID d'opération: getSubscription

POST/api/subscription

Subscribe to plan

Subscribe to a premium plan

Billing

Réponses

201Subscription created

400Invalid plan

401Not authenticated

402Payment required

ID d'opération: createSubscription

Cette documentation est générée automatiquement

Pour plus d'informations, consultez la spécification OpenAPI