1. Home
  2. /API Documentation

API Documentation

All endpoints are under /api/v1. Authenticated endpoints require a Bearer token in the Authorization header.

Download OpenAPI Spec (YAML)

Billing Tiers

TierPriceApplications
Free$0/monthUnlimited (extension, no AI tailoring)
Pro$5/monthUnlimited (with AI-tailored resumes and cover letters)

POST /billing/checkout requires a plan field (currently only pro).

API Endpoints

POST
/auth/register

Create a new account

POST
/auth/login

Login and receive JWT token

GET
/profile

Get user profile

AUTH
PUT
/profile

Update user profile

AUTH
GET
/resume

List all resumes

AUTH
POST
/resume

Upload a new resume

AUTH
DELETE
/resume/:id

Delete a resume

AUTH
PUT
/resume/:id/primary

Set resume as primary

AUTH
GET
/jobs/matches

Get matched job listings

AUTH
POST
/jobs/:id/approve

Approve a job for application

AUTH
POST
/jobs/:id/skip

Skip a job listing

AUTH
POST
/jobs/bulk-approve

Approve multiple jobs at once

AUTH
GET
/jobs/bookmarks

List bookmarked jobs

AUTH
POST
/jobs/:id/bookmark

Bookmark a job

AUTH
GET
/applications

List all applications

AUTH
GET
/applications/stats

Application statistics

AUTH
GET
/applications/:id

Get application details

AUTH
POST
/applications/:id/retry

Retry a failed application

AUTH
GET
/applications/:id/notes

List application notes

AUTH
POST
/applications/:id/notes

Add an application note

AUTH
GET
/applications/:id/interview-prep

Get AI interview prep

AUTH
GET
/agent/status

Get agent pool status

AUTH
POST
/agent/pause

Pause all agents

AUTH
POST
/agent/resume

Resume all agents

AUTH
POST
/billing/checkout

Create Stripe checkout session

AUTH
GET
/billing/subscription

Get subscription info

AUTH
POST
/billing/cancel

Cancel subscription

AUTH
GET
/analytics/applications-over-time

Applications chart data

AUTH
GET
/analytics/success-rate-trend

Success rate over time

AUTH
GET
/analytics/top-companies

Top companies applied to

AUTH
GET
/insights

Comprehensive application insights

AUTH
GET
/export/applications

Export applications (CSV/JSON)

AUTH
GET
/discovery/schedule

Get auto-discovery schedule

AUTH
PUT
/discovery/schedule

Update auto-discovery schedule

AUTH
POST
/discover

Trigger job discovery manually

AUTH
GET
/search-preferences

Get search preferences

AUTH
PUT
/search-preferences

Update search preferences

AUTH
GET
/notification-preferences

Get notification settings

AUTH
PUT
/notification-preferences

Update notification settings

AUTH
GET
/audit-log

View audit log entries

AUTH
DELETE
/account

Delete your account

AUTH
GET
/admin/stats

Platform statistics (admin only)

AUTH
GET
/admin/users

List all users (admin only)

AUTH
GET
/health

Health check

GET
/metrics

Prometheus metrics

GET
/ws

WebSocket for real-time updates

AUTH