candidates

Generate Candidate Profile Summary

Returns a 2-3 sentence AI-generated brief derived from the candidate's resume. Cached on the candidates row; regenerate by passing ?force=true (e.g., from a "Regenerate" button after the resume changes).

The brief is a triage tool — a recruiter glancing at the candidate page should know in 2 seconds whether this person is worth the next click. Keep the prompt strict on length and style.

post/api/candidates/{candidate_id}/generate-profile-summary

Request

  • Base URL: https://api.thebetterhire.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.thebetterhire.ai/api/candidates/{candidate_id}/generate-profile-summary
  • Auth: HTTP bearer

Path parameters

candidate_idstring required

Query parameters

forceboolean

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.