Summaries

A summary is a shortened processed description of a candidate nomination and a corresponding attachment specifically generated in relation to a job's description.

🛠️ This specific API is still under development and is not quite ready yet. Please reach out to us directly at [e-mail] on when this will be available.

Relationships:

• Candidate Nomination to Summary is 1-1

• Attachment to Summary is 1-1

Get an existing summary

GET https://endorsed.ai/api/v1/summaries/{id}

Get an existing summary by it's UUID id.

Path Parameters

Name	Type	Description
id*	string	UUID id of the summary

Headers

Name	Type	Description
Authorization*	string	Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>

200 Successfully fetched

{
  "is_error": false,
  "result": {
    "id": "a6bfdb42-ca9e-4a91-aa40-8119a6e19099",
    "location": "San Francisco, CA",
    "education": "Stanford University, B.S. in Computer Science, 2012",
    "employment": "Google, Staff Software Engineer, Aug 2012 - Present (11 years)",
    "matching_skills": [
      {
        "s": "Experience with Docker, AWS Lambda, or Terraform",
        "e": "The applicant lists Docker and AWS among their skills, indicating experience with these technologies"
      }
    ],
    "missing_skills": [
      {
        "s": "Experience with designing, building, or maintaining high-availability systems",
        "e": "The resume does not mention any experience with high-availability systems."
      }
    ],
    "created_at": "2023-09-25T22:06:01.000Z"
  }
}

401 Unauthorized

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

403: Forbidden Permission denied

{
  "is_error": true,
  "error": {
    "code": "FORBIDDEN",
    "issues": [
      {
        "message": "Access to this resource is not authorized."
      }
    ]
  }
}

404: Not Found

{
  "is_error": true,
  "error": {
    "code": "NOT_FOUND",
    "issues": [
      {
        "message": "This resource entity does not exist."
      }
    ]
  }
}

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 "${BASE_URL}/api/v1/summaries/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"