JobIntel.ai API

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

v1.0.0Baixar especificação OpenAPI
Categorias da API
POST/api/auth/login
User login

Authenticate a user and receive session tokens

Authentication

Corpo da Requisição

User credentials for authentication

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

Respostas

200Login successful
401Invalid credentials
429Too many login attempts

ID da Operação: loginUser

POST/api/auth/logout
User logout

End the current user session

Authentication

Respostas

200Logout successful
401Not authenticated

ID da Operação: logoutUser

GET/api/cover-letters
List cover letters

Get all cover letters for the authenticated user

Cover Letters

Parâmetros

limitqueryinteger

Maximum number of cover letters to return

Default: 10

offsetqueryinteger

Number of cover letters to skip

Default: 0

Respostas

200List of cover letters
401Not authenticated

ID da Operação: listCoverLetters

POST/api/cover-letters
Create cover letter

Generate a new AI-powered cover letter

Cover Letters

Corpo da Requisição

Cover letter creation parameters

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

Respostas

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

ID da Operação: createCoverLetter

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

Retrieve a specific cover letter by ID

Cover Letters

Parâmetros

idpathstringrequired

Unique identifier of the cover letter

Respostas

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

ID da Operação: getCoverLetter

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

Update an existing cover letter

Cover Letters

Parâmetros

idpathstringrequired

Unique identifier of the cover letter to update

Respostas

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

ID da Operação: updateCoverLetter

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

Remove a cover letter

Cover Letters

Parâmetros

idpathstringrequired

Unique identifier of the cover letter to delete

Respostas

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

ID da Operação: deleteCoverLetter

POST/api/cv-analysis
Analyze CV

Upload and analyze a CV using AI

CV Analysis

Respostas

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

ID da Operação: analyzeCV

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

Retrieve CV analysis results

CV Analysis

Respostas

200Analysis results
401Not authenticated
404Analysis not found

ID da Operação: getCVAnalysis

GET/api/applications
List job applications

Get all job applications for the user

Applications

Respostas

200List of applications
401Not authenticated

ID da Operação: listApplications

POST/api/applications
Track application

Add a new job application to track

Applications

Respostas

201Application created
400Invalid input
401Not authenticated

ID da Operação: createApplication

POST/api/interview-prep
Generate interview questions

Generate AI-powered interview questions based on job role

Interview Prep

Respostas

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

ID da Operação: generateQuestions

GET/api/user/profile
Get user profile

Retrieve the current user profile

User

Respostas

200User profile
401Not authenticated

ID da Operação: getUserProfile

PUT/api/user/profile
Update user profile

Update user profile information

User

Respostas

200Profile updated
400Invalid input
401Not authenticated

ID da Operação: updateUserProfile

GET/api/subscription
Get subscription status

Check current subscription plan and usage

Billing

Respostas

200Subscription details
401Not authenticated

ID da Operação: getSubscription

POST/api/subscription
Subscribe to plan

Subscribe to a premium plan

Billing

Respostas

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

ID da Operação: createSubscription

Esta documentação é gerada automaticamente

Para mais informações, consulte a especificação OpenAPI