Skip to main content

Resume Score Request Parameters

Endpoint​

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

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

ParameterTypeRequiredDescriptionExample
urlstringYesURL to the resume document to be scored"https://example.com/upload/resume.docx"
job_descriptionstringYesJob 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."
webhook_urlstringNoYour webhook endpoint URL to receive results automatically. Must be from a whitelisted domain. See Webhook Guide"https://yourdomain.com/webhook"

Sample Request Body​

Using Request ID (Polling)​

{
    "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."
}

Using Webhook​

{
    "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.",
    "webhook_url": "https://yourdomain.com/api/webhook"
}
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
  • For webhooks, ensure your domain is whitelisted in the MagicalAPI Dashboard

Example Workflows​

Using Request ID (Polling)​

  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."
  }'
  1. 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"}'

Using Webhook​

Send a single request and receive results automatically:

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.",
    "webhook_url": "https://yourdomain.com/api/webhook"
  }'

Results will be automatically delivered to your webhook endpoint when processing is complete. Learn more about setting up webhooks.