Resume Review Request Parameters

Endpoint

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

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

Parameter	Type	Required	Description	Example
url	string	Yes	URL to the resume document to be reviewed	"https://example.com/upload/resume.docx"
webhook_url	string	No	Your 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"
}

Using Webhook

{
    "url": "https://example.com/upload/f755e241-277d-x2s2-asd2-ef2d6cf15617.docx",
    "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
• 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-review" \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR-API-KEY" \
  -d '{"url": "https://example.com/upload/resume.docx"}'

2. Check Status (using the same endpoint)

curl -X POST "https://gw.magicalapi.com/resume-review" \
  -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-review" \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR-API-KEY" \
  -d '{
    "url": "https://example.com/upload/resume.docx",
    "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.