Fetching data...
Developer API Reference
Build powerful integrations with our platform APIs.
Fetching data...
Build powerful integrations with our platform APIs.
Build powerful integrations with our platform APIs.
Dynamic API reference synchronized with our latest backend endpoints.
/api/v1/interviews/{id}/steps/{stepId}/summaryReturns the AI-generated scorecard and assessment for a specific interview step.
idRequiredstringThe interview plan ID
stepIdRequiredstringThe interview step ID
Example Request
bashcurl -X GET "https://your-tenant.peoplelensai.com/api/v1/interviews/{id}/steps/{stepId}/summary" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" Example Response
json{
"step_id": "step-123e4567-e89b-12d3-a456-426614174000",
"title": "Technical Assessment",
"order": 1,
"status": "completed",
"scorecard": {
"overall_score": 85,
"recommendation": "Strong Hire",
"executive_summary": "Candidate demonstrated excellent problem-solving skills.",
"strengths": [
"React expertise",
"Clear communication"
],
"weaknesses": [
"Limited backend experience"
],
"criteria": [
{
"name": "Technical Skills",
"score": 90,
"notes": "Great React knowledge"
}
],
"detailed_analysis": {
"question_1": "Good answer"
},
"assessed_at": "2026-02-25T10:00:00Z"
}
}/api/v1/interviews/{id}/summaryReturns the final AI-generated summary of the entire interview process for a candidate.
idRequiredstringThe interview plan ID
Example Request
bashcurl -X GET "https://your-tenant.peoplelensai.com/api/v1/interviews/{id}/summary" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" Example Response
json{
"id": "plan-123e4567-e89b-12d3-a456-426614174000",
"status": "completed",
"candidate": {
"id": "can-123",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com"
},
"job": {
"id": "job-123",
"title": "Frontend Developer"
},
"summary": "The candidate performed very well across all technical and behavioral stages...",
"updated_at": "2026-02-25T09:00:00Z"
}/api/v1/interviews/{id}/transcriptReturns the raw transcript text for a specific interview step or plan.
idRequiredstringThe interview step ID
Example Request
bashcurl -X GET "https://your-tenant.peoplelensai.com/api/v1/interviews/{id}/transcript" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" Example Response
json{
"id": "step-123e4567-e89b-12d3-a456-426614174000",
"transcript": "Interviewer: Hello!\nCandidate: Hi, great to meet you."
}