JobIntel.ai API

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

v1.0.0OpenAPI-Spezifikation herunterladen

API-Kategorien

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)

Antworten

200Login successful

401Invalid credentials

429Too many login attempts

Operationsnummer: loginUser

POST/api/auth/logout

User logout

End the current user session

Authentication

Antworten

200Logout successful

401Not authenticated

Operationsnummer: logoutUser

GET/api/cover-letters

List cover letters

Get all cover letters for the authenticated user

Cover Letters

Parameter

limitqueryinteger

Maximum number of cover letters to return

Default: 10

offsetqueryinteger

Number of cover letters to skip

Default: 0

Antworten

200List of cover letters

401Not authenticated

Operationsnummer: 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)

Antworten

201Cover letter created

400Invalid input

401Not authenticated

429Rate limit exceeded

Operationsnummer: createCoverLetter

GET/api/cover-letters/{id}

Get cover letter

Retrieve a specific cover letter by ID

Cover Letters

Parameter

idpathstringrequired

Unique identifier of the cover letter

Antworten

200Cover letter details

401Not authenticated

404Cover letter not found

Operationsnummer: getCoverLetter

PUT/api/cover-letters/{id}

Update cover letter

Update an existing cover letter

Cover Letters

Parameter

idpathstringrequired

Unique identifier of the cover letter to update

Antworten

200Cover letter updated

400Invalid input

401Not authenticated

404Cover letter not found

Operationsnummer: updateCoverLetter

DELETE/api/cover-letters/{id}

Delete cover letter

Remove a cover letter

Cover Letters

Parameter

idpathstringrequired

Unique identifier of the cover letter to delete

Antworten

204Cover letter deleted

401Not authenticated

404Cover letter not found

Operationsnummer: deleteCoverLetter

POST/api/cv-analysis

Analyze CV

Upload and analyze a CV using AI

CV Analysis

Antworten

200Analysis complete

400Invalid file format

401Not authenticated

413File too large

429Rate limit exceeded

Operationsnummer: analyzeCV

GET/api/cv-analysis/{id}

Get CV analysis

Retrieve CV analysis results

CV Analysis

Antworten

200Analysis results

401Not authenticated

404Analysis not found

Operationsnummer: getCVAnalysis

GET/api/applications

List job applications

Get all job applications for the user

Applications

Antworten

200List of applications

401Not authenticated

Operationsnummer: listApplications

POST/api/applications

Track application

Add a new job application to track

Applications

Antworten

201Application created

400Invalid input

401Not authenticated

Operationsnummer: createApplication

POST/api/interview-prep

Generate interview questions

Generate AI-powered interview questions based on job role

Interview Prep

Antworten

200Questions generated

400Invalid input

401Not authenticated

429Rate limit exceeded

Operationsnummer: generateQuestions

GET/api/user/profile

Get user profile

Retrieve the current user profile

User

Antworten

200User profile

401Not authenticated

Operationsnummer: getUserProfile

PUT/api/user/profile

Update user profile

Update user profile information

User

Antworten

200Profile updated

400Invalid input

401Not authenticated

Operationsnummer: updateUserProfile

GET/api/subscription

Get subscription status

Check current subscription plan and usage

Billing

Antworten

200Subscription details

401Not authenticated

Operationsnummer: getSubscription

POST/api/subscription

Subscribe to plan

Subscribe to a premium plan

Billing

Antworten

201Subscription created

400Invalid plan

401Not authenticated

402Payment required

Operationsnummer: createSubscription

Diese Dokumentation ist automatisch generiert

Weitere Informationen finden Sie in der OpenAPI-Spezifikation