Resume Score Request Parameters

Endpoint

https://gw.magicalapi.com/resume-score

The Resume Score service requires the following parameters in the request body:

Parameter	Type	Required	Description	Example
url	string	Yes	URL to the resume document to be scored	"https://example.com/upload/resume.docx"
job_description	string	Yes	Job description to score the resume against	"We are seeking a Full Stack Developer with 3+ years of experience in JavaScript/TypeScript, React, and Node.js. The ideal candidate should have experience with RESTful APIs, database design, and cloud services (AWS/Azure). Knowledge of CI/CD pipelines and agile methodologies is required."

Sample Request Body

{
    "url": "https://example.com/upload/f755e241-277d-x2s2-asd2-ef2d6cf15617.docx",
    "job_description": "We are seeking a Full Stack Developer with 3+ years of experience in JavaScript/TypeScript, React, and Node.js. The ideal candidate should have experience with RESTful APIs, database design, and cloud services (AWS/Azure). Knowledge of CI/CD pipelines and agile methodologies is required."
}

tip

Make sure to:

• Use a publicly accessible URL
• Supported file formats: PDF, DOC, and DOCX
• Maximum file size: 10MB
• Provide a clear and detailed job description for better scoring accuracy

Example Workflow

1. Send Initial Request

curl -X POST "https://gw.magicalapi.com/resume-score" \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR-API-KEY" \
  -d '{
    "url": "https://example.com/upload/resume.docx",
    "job_description": "We are seeking a Full Stack Developer with 3+ years of experience in JavaScript/TypeScript, React, and Node.js. The ideal candidate should have experience with RESTful APIs, database design, and cloud services (AWS/Azure). Knowledge of CI/CD pipelines and agile methodologies is required."
  }'

2. Check Status (using the same endpoint)

curl -X POST "https://gw.magicalapi.com/resume-score" \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR-API-KEY" \
  -d '{"request_id": "abc123xyz"}'