Step 1. Submit the AI Job request
Endpoint: POST - /v1/hr/related_skills
Attribute |
Type |
Mandatory |
Description |
content |
String |
Yes |
Skill to generate related skills. |
language |
String |
No |
Specify the language of the output, defaults to English . |
max_quantity |
Number |
No |
Maximum number of related skills to generate. |
REQUEST EXAMPLE:
{
"content": "Quicken",
"language": "English",
"max_quantity":5
}
RESPONSE EXAMPLE:
{
"status_url": "https://sharpapi.com/api/v1/content/translate/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
"job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
}
Step 2. Monitor & Fetch AI Job Results
Endpoint: GET - /v1/hr/parse_resume/job/status/:uuid
An endpoint is used to check on the progress of the requested API job.
RESULT EXAMPLE:
{
"data": {
"type": "api_job_result",
"id": "bac70cd7-5347-4443-9632-c82019f73e9a",
"attributes": {
"status": "success",
"type": "hr_related_skills",
"result": {
"skill": "Quicken",
"related_skills": [
{
"name": "Accounting",
"weight": 8.7
},
{
"name": "Bookkeeping",
"weight": 7
},
{
"name": "Financial Management",
"weight": 6.8
},
{
"name": "Financial Reporting",
"weight": 7.5
},
{
"name": "Microsoft Excel",
"weight": 6.5
},
{
"name": "QuickBooks",
"weight": 9.2
}
]
}
}
}
}