About this endpoint
What it does
Estimates a market salary range for a candidate from the provided job title, location, and resume content. The response returns a market context string and an estimated salary range object.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| jobTitle | String | Yes | The candidate’s job title. |
| location | String | Yes | The candidate’s location. |
| resumeContent | String | Yes | The candidate’s resume or experience summary text. |
Response
Returns a JSON object with a marketContext string field and an estimatedRange object field. estimatedRange contains min and max integer fields plus a currency string field.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| marketContext | String | No | A textual summary of the market factors used to estimate the range. |
| estimatedRange | Object | No | The estimated salary range object containing min, max, and currency. |
| estimatedRange.min | Integer | No | The lower bound of the estimated salary range. |
| estimatedRange.max | Integer | No | The upper bound of the estimated salary range. |
| estimatedRange.currency | String | No | The currency code for the estimated range. |