Documentation

Everything you need to get started

Install the agent, configure your profile, and let AI apply to the right jobs automatically.

Quick Start

Get up and running in under 5 minutes.

1 Install the agent

pip install jobapplier-agent

2 Initialize your profile

Creates a configuration file at ~/.jobapplier/config.yaml with your profile template.

jobapplier init

3 Add your API key

Grab your key from Dashboard → API Keys, then start the background agent.

jobapplier login --api-key ja_live_xxxxxxxxxxxxx --start

4 Start applying

The agent discovers matching jobs, tailors your resume per JD, generates cover letters, and submits applications automatically.

jobapplier status

# ✓ Loaded profile: Jane Smith
# ✓ Agent online
# ✓ Polling cloud queue every 60 seconds
# ✓ Autopilot enabled
# ✓ Server quota: 1/day, 3/month

Tip: Run jobapplier preflight before your first run to verify your environment, API keys, and configuration are set up correctly.

Configuration

Your profile lives in a single YAML file. Edit it to match your experience and job preferences.

~/.jobapplier/config.yamlyaml

personal_information:
  name: "Jane Smith"
  email: "jane@example.com"
  phone: "+1-555-0123"
  location: "San Francisco, CA (Remote)"
  linkedin: "linkedin.com/in/janesmith"
  github: "github.com/janesmith"

job_preferences:
  target_roles:
    - "Software Engineer"
    - "Full Stack Developer"
    - "Backend Engineer"
  min_salary: 80000          # USD annual
  remote_only: true
  experience_level: "mid-senior"

search_terms:
  - "Software Engineer Remote"
  - "Python Developer Remote"
  - "Full Stack Developer"

safety:
  daily_application_cap: 50
  min_delay_seconds: 30
  max_delay_seconds: 120
  warmup_days: 14            # Gradual ramp-up period

personal_information

Your identity fields — used for form filling and resume header.

job_preferences

Targeting filters. Jobs outside these criteria are skipped automatically.

search_terms

Keywords used when discovering jobs across all platforms.

safety

Rate limiting and anti-detection. The warmup period increases daily volume gradually.

CLI Reference

All commands available in the JobApplier CLI.

jobapplier preflightValidate environment, API keys, and configuration

jobapplier runExecute full daily application cycle

jobapplier initCreate config file via interactive wizard

jobapplier generate-resumesGenerate PDF resume variants from YAML master

jobapplier tailor-resumeAI-tailor a resume to a specific job description

jobapplier generate-cover-letterGenerate AI cover letter for a specific role

jobapplier check-atsRun ATS keyword score for resume vs job description

jobapplier score-jobsScore and rank discovered jobs by fit

jobapplier interview-prepGenerate interview prep for a tracked application

jobapplier exportExport application history to Excel or CSV

Examples

# Tailor resume for a specific job posting
jobapplier tailor-resume \
  --jd "https://boards.greenhouse.io/stripe/jobs/12345" \
  --output ./tailored_stripe_resume.pdf

# Check ATS compatibility score
jobapplier check-ats \
  --resume ./my_resume.yaml \
  --jd ./job_description.txt
# → ATS Score: 87% (32/37 keywords matched)

# Generate interview prep from a tracked application
jobapplier interview-prep --app-id 42

API Reference

The REST API powers cloud sync, remote configuration, and intelligence features. Interactive docs are available at /docs (Swagger UI) and /redoc on your API instance.

Base URL

https://api.jobapplier.ai/api/v1

Auth

Bearer JWT or X-API-Key header

Format

JSON (application/json)

OpenAPI

/openapi.json

Rate Limits

Tier	Requests / hr	AI Calls / day
Free	100	10
Starter	500	100
Pro	2,000	500
Ultra	10,000	Unlimited

Authentication

Include your token or API key in every request:

# JWT Bearer token
curl https://api.jobapplier.ai/api/v1/users/me \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

# API Key
curl https://api.jobapplier.ai/api/v1/users/me \
  -H "X-API-Key: ja_live_xxxxxxxxxxxxx"

Auth

POST/auth/registerCreate a new account

POST/auth/loginLog in with email + password

POST/auth/refreshRefresh an access token

POST/auth/logoutRevoke the refresh token

Applications

Track, search, and manage job applications with full Q&A history.

POST/applicationsLog a new application

GET/applicationsList (paginated, filterable)

GET/applications/{id}Get single application

DELETE/applications/{id}Delete an application

GET/applications/{id}/qaGet form Q&A pairs

POST/applications/{id}/prepGenerate interview prep

GET/applications/{id}/prepGet cached prep

Resumes

Upload, retrieve, and AI-tailor resumes to specific job descriptions.

POST/resumesUpload a new resume (YAML)

GET/resumesList all resumes

GET/resumes/{id}Get resume with full YAML

DELETE/resumes/{id}Delete a resume

POST/resumes/tailorAI-tailor resume to a JD

Intelligence

AI-powered scoring, cover letter generation, and smart form answers.

POST/intelligence/scoreATS keyword fit score

POST/intelligence/cover-letterGenerate AI cover letter

POST/intelligence/form-answerSmart form-field answer

Agent Sync

Cloud sync and remote control for the desktop agent.

POST/agent/syncSync local data to cloud

GET/agent/configPull remote configuration

POST/agent/heartbeatStatus ping + receive commands

Statistics

Dashboard metrics, daily trends, and per-platform performance.

GET/stats/dashboardAggregate dashboard stats

GET/stats/dailyDaily application trends

GET/stats/platformPer-platform breakdown

Billing

Subscription management and usage metering via Stripe.

POST/billing/checkoutCreate Stripe Checkout session

GET/billing/usageCurrent-period usage summary

Preferences

Job-targeting preferences synced to your cloud account.

GET/preferencesGet current preferences

PUT/preferencesReplace targeting preferences

API Keys

Create and manage API keys for programmatic access. Maximum 5 keys per account.

POST/keysCreate a new API key

GET/keysList all keys (metadata only)

DELETE/keys/{id}Revoke an API key

Explore the full interactive API at api.jobapplier.ai/docs · Questions? support@jobapplier.ai