API Reference

Build with the PrepTalk API

Integrate AI-powered interviews into your existing workflows with our REST and Socket.IO APIs.

Quick Start

📦

JavaScript/TypeScript

npm install @preptalk/sdk

🐍

Python

pip install preptalk

🌐

REST API

curl -X GET https://api.avainterview.com/v1/

All API requests require a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Generate API keys from your dashboard under Settings → API Keys.

POST/api/v1/auth/loginAuthenticate user and get JWT token

GET/api/v1/templatesList all interview templates

POST/api/v1/sessionsCreate a new interview session

GET/api/v1/sessions/:id/reportGet interview report and scores

POST/api/v1/webhooksConfigure webhook endpoints

DELETE/api/v1/candidates/:idDelete candidate data (DPDP compliance)

Use Socket.IO for real-time interview events: join_interview, audio streaming, transcription updates, and avatar state changes.