{% extends "base.html" %} {% block title %}API Documentation – Resume Ranker API{% endblock %} {% block extra_head %} {# No extra head elements are needed here. Your base.html or dashboard.css should handle the main CSS. #} {% endblock %} {% block content %}

API Documentation

{# Changed from welcome-title to just a title for the page #}

Detailed guide on how to integrate and use the Resume Ranker API.

{% if error %}
{{ error }}
{% endif %} {% if success %}
{{ success }}
{% endif %}
{# Wrap documentation in a card for consistent look #}

📘 Resume Ranker API Details

🔗 Endpoint

POST https://rankapply-api.hf.space/rank-resumes

🔐 Authentication

Include your API key in the Authorization header:

Authorization: Bearer your_api_key_here

Never share your API key publicly. Treat it like a password.

Request Parameters

  • resumes (file[], required): One or more PDF or DOCX resumes.
  • job_description (text, required): The job description to match against.

📥 Example Request (cURL)

curl -X POST https://rankapply-api.hf.space/rank-resumes \
  -H "Authorization: Bearer your_api_key_here" \
  -F "resumes=@cv1.pdf" \
  -F "resumes=@cv2.pdf" \
  -F "job_description=We are hiring a backend engineer..."

📥 Example Request (Python)

import requests

headers = {
    "Authorization": "Bearer your_api_key_here"
}
files = [
    ('resumes', ('cv1.pdf', open('cv1.pdf', 'rb'), 'application/pdf')),
    ('resumes', ('cv2.pdf', open('cv2.pdf', 'rb'), 'application/pdf')),
]
data = {
    "job_description": "We are hiring a backend engineer..."
}

response = requests.post("https://rankapply-api.hf.space/rank-resumes", headers=headers, files=files, data=data)
print(response.json())

Sample Response

{
  "job_description": "We are hiring a backend engineer...",
  "ranked_resumes": [
    {
      "filename": "cv2.pdf",
      "score": 0.8745
    },
    {
      "filename": "cv1.pdf",
      "score": 0.6721
    }
  ]
}
{# Reusing the card for the "Try It Now" section #}

Try It Now

Use the form below to quickly test the API directly from your browser.

{% if response %}

🔍 Resume Ranking Results

Job Description: {{ response.job_description }}

{% for r in response.ranked_resumes %} {% endfor %}
Filename Score
{{ r.filename }} {{ r.score }}
{% endif %}

← Back to Dashboard

{% endblock %} {% block extra_scripts %} {% endblock %}