Spotlights

A short explanation of how good a match a given candidate is for a given job.

The Spotlight entity:

{
  "state": "EVALUATED" | "IN_PROGRESS" | "FAILED",
  "explanation": string,  // Short highlight string explaining the Candidate's fitness relative to the Job],
  "confidence": number (0..1),  // AI's confidence in its own output, given the inputs
  "strength": number (0..1),  // How well the Candidate matches the given Job
}

Get Spotlight

GET https://endorsed.ai/api/v1/spotlight

Generates a new Spotlight and returns the evaluation data. This will be generated and cached. The first time a Spotlight is requested and successfully generated for a Candidate + Job pair, the server will return 200. Subsequent calls for the same entity pair will return a 201. We encourage you to do your own caching as well.

Headers

Name	Type	Description
Authorization*	string	Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>
Content-Type	string	Must be application/json. If not set, defaults to application/json

Query Parameters

Name	Type	Description
job_id*	string	The ID of the Job against which to evaluate the Candidate
candidate_id*	string	The ID of the Candidate to evaluate against the Job

201 Successfully Created

{
  "is_error": false,
  "result": {
    "state": "EVALUATED",
    "explanation": "Outstanding match with over five years of photography experience and specialized training; produces vibrant, sharp images.",
    "confidence": 1,
    "strength": 1
  }
}

200 Successfully Fetched

{
  "is_error": false,
  "result": {
    "state": "EVALUATED",
    "explanation": "Outstanding match with over five years of photography experience and specialized training; produces vibrant, sharp images.",
    "confidence": 1,
    "strength": 1
  }
}

401 Unauthorized

{
  "is_error": true,
  "error": {
    "code": "UNAUTHENTICATED",
    "issues": [
      {
        "message": "Resource requires authentication. Please provide a valid access token."
      }
    ]
  }
}

500: Internal Server Error

{
  "is_error": true,
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "issues": [
      {
        "message": "An unexpected error occurred on our end. Please try again later, and if the problem persists, contact our support team"
      }
    ]
  }
}

Examples:

cURL

curl -X GET "localhost:3000/api/v1/spotlight?job_id=aaaaa1a5-1664-44d6-aba3-ffbaba3ef764&candidate_id=bbbbbba9-5e1a-40c9-9fe0-983a12629999" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"