API Dokumentation

Aloqe Engine V3 (Rekommenderad) & V2 (Legacy)

Aloqe API erbjuder realtidsbaserad och intelligent CV-matchning. Genom att skicka in en kravprofil (PDF) samt en eller flera kandidatprofiler (PDF) utförs semantisk och strukturerad expertanalys med realtidssvar över NDJSON-ström.

Endpoints

Motorversion	Endpoint	Beskrivning
V3 (Rekommenderad)	`POST /upload_v3`	100% deterministisk ranking, diskreta Match Tiers (Strong Match, Potential Match, Low Relevance), Must-Have-indikatorer och defensiv PDF-validering.
V2 (Legacy)	`POST /upload`	Tidigare motor med kontinuerliga float-poäng (`judged_similarity_score` -1.0 till 1.0).

Förfrågningsformat (`multipart/form-data`)

Headers

X-API-Key: Din Aloqe API-nyckel (Standard: dev-secret-key)
Authorization: Bearer token för Hugging Face (obligatorisk)

Form Data parametrar

job_posting (File, obligatorisk): Kravprofil som PDF-fil
<kandidat_nyckel> (File, 1 eller flera): Kandidatens CV i PDF-format (t.ex. resume_1, Kandidat 1)
custom_prompt (string, valfri): Särskilda instruktioner eller prioriteringar för matchningsmotorn (t.ex. "Prioritera kandidater med Next.js och startup-erfarenhet")

Svarsformat (Streaming `application/x-ndjson`)

Svaret strömmas rad för rad i NDJSON-format. Kandidater anländer i försorterad rangordning (Rank 1 → Rank 2 → ...).

Kandidatresultat (V3):

{
  "resume_id": "resume_1_winner",
  "status": "success",
  "rank": 1,
  "semantic_scores": {
    "tech": 0.5953,
    "universal": 0.5877,
    "legacy": 0.8099
  },
  "data": {
    "match_tier": "Strong Match",
    "must_haves_satisfied": true,
    "matching_skills": ["React", "TypeScript", "Video Streaming"],
    "missing_requirements": ["GraphQL"],
    "scores_critique": "Scores align well with core domain qualifications.",
    "final_justification": "Candidate meets all non-negotiable criteria with 20+ years in broadcast media."
  }
}

Defensivt Felchunk (t.ex. skannat eller tomt CV):

{
  "resume_id": "corrupted_resume",
  "status": "error",
  "message": "Resume PDF is unreadable, empty, or image-based (fewer than 100 characters extracted)."
}