JobIntel.ai API

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

v1.0.0Download OpenAPI-specificatie
API-categorieën
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)

Antwoorden

200Login successful
401Invalid credentials
429Too many login attempts

Operatie-ID: loginUser

POST/api/auth/logout
User logout

End the current user session

Authentication

Antwoorden

200Logout successful
401Not authenticated

Operatie-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

Antwoorden

200List of cover letters
401Not authenticated

Operatie-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)

Antwoorden

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

Operatie-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

Antwoorden

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

Operatie-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

Antwoorden

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

Operatie-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

Antwoorden

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

Operatie-ID: deleteCoverLetter

POST/api/cv-analysis
Analyze CV

Upload and analyze a CV using AI

CV Analysis

Antwoorden

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

Operatie-ID: analyzeCV

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

Retrieve CV analysis results

CV Analysis

Antwoorden

200Analysis results
401Not authenticated
404Analysis not found

Operatie-ID: getCVAnalysis

GET/api/applications
List job applications

Get all job applications for the user

Applications

Antwoorden

200List of applications
401Not authenticated

Operatie-ID: listApplications

POST/api/applications
Track application

Add a new job application to track

Applications

Antwoorden

201Application created
400Invalid input
401Not authenticated

Operatie-ID: createApplication

POST/api/interview-prep
Generate interview questions

Generate AI-powered interview questions based on job role

Interview Prep

Antwoorden

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

Operatie-ID: generateQuestions

GET/api/user/profile
Get user profile

Retrieve the current user profile

User

Antwoorden

200User profile
401Not authenticated

Operatie-ID: getUserProfile

PUT/api/user/profile
Update user profile

Update user profile information

User

Antwoorden

200Profile updated
400Invalid input
401Not authenticated

Operatie-ID: updateUserProfile

GET/api/subscription
Get subscription status

Check current subscription plan and usage

Billing

Antwoorden

200Subscription details
401Not authenticated

Operatie-ID: getSubscription

POST/api/subscription
Subscribe to plan

Subscribe to a premium plan

Billing

Antwoorden

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

Operatie-ID: createSubscription

Deze documentatie is automatisch gegenereerd

Voor meer informatie, zie de OpenAPI-specificatie