Public API v1
Public API v1

Get a still of the candidate's face

Returns a time-limited URL to one JPEG frame from a video interview in which the candidate's face is clearly visible: one face, large, sharp and well lit, picked from across the recording (the first 30 seconds only if nothing later qualifies). Always 1280x720. Picked on the first request (a few seconds) and cached; later requests are instant.

Call it only when the candidate has agreed to show their face; nothing is picked unless asked. Detection only: the person is never identified and no face data is kept besides the image.

404 NO_FACE_FRAME when the recording has no picture (an audio-only interview) or no frame qualifies. 404 NO_RECORDING before the recording is saved. 503 FRAME_UNAVAILABLE: retry.

get/api/public/v1/interviews/{interview_id}/frame

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/public/v1/interviews/{interview_id}/frame
  • Auth: HTTP bearer

Path parameters

interview_idstring required

Response

Successful Response

urlstring required

Time-limited URL to a JPEG. Fetch it once and keep your own copy if you show it beyond the hour (e.g. in a link preview).

expires_ininteger required

Seconds until the URL expires.

widthinteger required

Image width in pixels.

heightinteger required

Image height in pixels.

Example response

{
  "url": "https://audio.thebetterhire.ai/.../frames/face-v1.jpg?Signature=...",
  "expires_in": 3600,
  "width": 1280,
  "height": 720
}

Changes

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