Skip to main content

​
Overview

Agents (also called Interview Templates) are AI-powered interviewers that conduct conversations with candidates. Each agent can be customized with specific questions, voice characteristics, instructions and focus.

​
Resource Structure

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Technical Screening Agent",
  "instructions": "Evaluates technical skills for software engineering roles",
  "voiceId": "ALEX",
  "type": "ONLINE",
  "focus": "SCREENING",
  "companyPhoneNumberId": "123e4567-e89b-12d3-a456-426614174000", // Required if type is PHONE
  "questions": [
    "Tell me about your experience with React and modern frontend development",
    "Explain how you would design a scalable microservices architecture",
    "Describe a challenging technical problem you solved recently",
  ],
  "duration": 30, // in minutes (max 180)
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
}

​
Creating Agents

const agent = await fetch("https://api.instaview.sk/agents", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.INSTAVIEW_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Senior Frontend Developer",
    voiceId: "ALEX",
    type: "ONLINE",
    focus: "SCREENING",
    questions: [
      "Can you describe your experience with React?",
      "How do you optimize for performance?",
    ],
    duration: 30,
  }),
});
Best Practice: For production integrations, always implement request timeouts.
const controller = new AbortController();
const timeoutId = setTimeout(() => controller.abort(), 10000); // 10s timeout

try {
  const response = await fetch(url, {
    headers: { Authorization: `Bearer ${apiKey}` },
    signal: controller.signal,
  });
} finally {
  clearTimeout(timeoutId);
}

​
Voice Options

VoiceGenderDescription
ALEXMaleClear, neutral, business-appropriate (English)
PETERMaleProfessional, executive tone (English)
MIRIAMFemaleProfessional, clear (English)
SUEFemaleWarm, approachable tone (localized as Zuzka)
VIERAFemaleClear, articulate (Slovak/Czech optimized)
CASANDRAFemaleProfessional, clear
SILVIAFemaleClear, neutral
MICHAELMaleProfessional (localized as Michal)
LUKEMaleYoung, energetic (localized as Lukáš)
EMMAFemaleWarm, friendly (localized as Ema)
SARAHFemaleProfessional, clear (localized as Sára)
EVAFemaleClear, articulate
Duration: The duration field is specified in minutes. The maximum allowed duration is 180 minutes (3 hours).

​
Agent Focus Options

The focus field determines the agent’s specialization and interview style:
Initial candidate screening - Basic qualifications - Availability - Salary expectations

​
Best Practices

Clear Questions

Write specific, open-ended questions

Appropriate Duration

15-30 minutes for most interviews

Test First

Test agents before using in production

Iterate

Refine based on interview quality

​
Next Steps

Interviews

Use agents to conduct interviews

API Reference

View complete Agents API reference