Skip to content

README.md

Latest commit

 

History

History
160 lines (120 loc) · 5.33 KB

README.md

File metadata and controls

160 lines (120 loc) · 5.33 KB

DraftApply Proxy Engine (Open Source)

This service keeps your Groq API key server-side and exposes a small HTTPS API that the DraftApply Chrome extension calls to generate answers.

The proxy uses a pluggable recipe interface: the default recipe (recipe/index.js) is fully open source and includes prompt logic for data extraction, cover letters, "why company" questions, and anti-recency-bias answers. You can override it with RECIPE_PATH to use a custom module.

Architecture

Extension  ──(structured JSON)──▶  Proxy Engine  ──▶  Recipe Module  ──▶  LLM (Groq)
                                     (open source)      (default: recipe/index.js)
Component Description
Proxy engine (server.js) Auth, rate limits, CV upload, LLM call, request validation
Recipe (recipe/index.js) Default prompt builder: data extraction, cover letters, why-company, full-CV context
Extension UI, page extraction, sends structured data to proxy

Endpoints

Method Path Auth Description
GET /api/health None Health check
POST /api/register None (rate-limited) Issue install token → { token, expiresAt }
POST /api/generate Bearer <token> Generate an answer (structured or legacy payload)
POST /api/cv/upload Bearer <token> Upload CV file (PDF/DOCX/TXT) → extracted text

POST /api/generate – Structured Payload (preferred)

{
  "question":       "Why do you want to join our team?",
  "length":         "medium",
  "cvText":         "Full CV text...",
  "jobTitle":       "Senior Engineer",
  "company":        "Acme Corp",
  "jobDescription": "We are looking for...",
  "requirements":   ["3+ years experience", "React", "Node.js"],
  "pageUrl":        "https://jobs.example.com/apply/123",
  "platform":       "greenhouse"
}
Field Type Required Description
question string Yes The application question or field label
cvText string Yes Full CV text (min 5 chars)
length string No "short", "medium" (default), or "long"
jobTitle string No Extracted job title
company string No Extracted company name
jobDescription string No Extracted job description text
requirements string[] No Extracted key requirements
pageUrl string No URL of the application page
platform string No Detected ATS platform

Response:

{
  "answer": "Generated answer text...",
  "provider": "groq",
  "model": "llama-3.3-70b-versatile"
}

Legacy Payload (backward-compatible)

{
  "systemPrompt": "You are...",
  "userPrompt": "CV: ...\nQuestion: ...",
  "temperature": 0.7
}

The proxy accepts either format. Structured payloads are routed through the recipe module; legacy payloads are passed directly to the LLM.

Recipe Plug-in Interface

The recipe module must export a single function:

export function buildPrompts(input) {
  // input: { question, length, cvText, jobTitle, company, jobDescription, requirements, pageUrl, platform }
  return {
    systemPrompt: '...',
    userPrompt: '...',
    temperature: 0.7  // optional
  };
}

The default recipe at recipe/index.js handles:

  • Data extraction (name, email, phone, LinkedIn, etc.) – returns only the value
  • Cover letter – full letter with greeting, paragraphs, closing
  • "Why company" – tailored to job context and CV
  • General questions – uses full CV (head + tail to avoid recency bias) and job description

Using a custom recipe

Set the RECIPE_PATH environment variable to the path of your recipe module:

RECIPE_PATH=./my-recipe/index.js npm start

If RECIPE_PATH is not set (or fails to load), the proxy uses the bundled recipe at recipe/index.js.

Environment Variables

Variable Required Default Description
GROQ_API_KEY Yes — Groq API key
TOKEN_SECRET Yes — Random long string for signing install tokens
GROQ_MODEL No llama-3.3-70b-versatile Groq model identifier
RECIPE_PATH No ./recipe/index.js Path to recipe module (optional override)
PORT No 10000 Server listen port

Deploy on Render

  1. Push this repo to GitHub.
  2. Render → New → Web Service → connect repo.
  3. Root directory: render-proxy
  4. Build command: npm install
  5. Start command: npm start
  6. Add env vars: GROQ_API_KEY, TOKEN_SECRET. No need to set RECIPE_PATH unless you use a custom recipe.

Privacy Guarantees

  • No logging of CV text, job descriptions, or generated answers in the proxy engine.
  • GROQ_API_KEY and TOKEN_SECRET are read from env vars only — never committed.
  • Rate limiting and token auth are built into the engine.
  • The extension stores the CV locally in chrome.storage.local — it is never persisted server-side.
  • Groq is configured with Zero Data Retention (ZDR) — prompts and completions are not stored by the LLM provider.

Development

cd render-proxy
npm install
GROQ_API_KEY=your-key TOKEN_SECRET=your-secret npm start

The server starts on http://localhost:10000.