REST · JSON · WebRTC

API Reference

Everything you need to create interviews, retrieve results, and manage your tenant programmatically. All endpoints return JSON. All errors follow a consistent { error: string } shape.

3Endpoints

1Resource groups

2Auth methods

Quick start

Create interview

bash

curl -X POST /api/v1/interviews \
  -H "x-api-key: psk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"candidate":{"name":"Haider Ali"},"company":{"name":"Peersol","jobTitle":"Senior Engineer"}}'

Share the link & poll for results

bash

curl /api/v1/interviews/iv_TOKEN \
  -H "x-api-key: psk_live_YOUR_KEY"

Evaluation types

The evaluation object on a completed interview conforms to FinalEvaluationResult:

typescript

interface FinalEvaluationResult {
  overallScore: number;          // 0–100
  reasoning: string;             // Evaluator narrative
  strengths: string[];           // Bullet-point strengths
  concerns: string[];            // Bullet-point concerns
  suggestedLevel: string;        // "Intern" | "Junior" | "Mid" | "Senior" | "Lead"
  perQuestionEvaluation: {
    question: string;            // Original required question
    candidateAnswer: string;     // Consolidated candidate answer
    score: number;               // 0–100
    notes: string;               // Evaluator notes
  }[];
  verdict: "Shortlisted" | "Rejected";
  threshold: number;             // Score threshold used (default: 80)
  evaluatedAt: string;           // ISO 8601 timestamp
  isFixedQuestionMode: boolean;  // true if company supplied questions
}

Interviews

Built by Captar · Questions? hello@captar.com