Endpoints

Complete reference for all InsightAgent API endpoints.

Interviews

List Interviews

GET /api/interviews

Query parameters:

Parameter
Type
Description

status

string

Filter by status

limit

number

Results per page (default: 20)

offset

number

Pagination offset

Get Interview

GET /api/interviews/{id}

Create Interview

POST /api/interviews

Body:

{
  "type": "FULL_INTERVIEW | VETTING_INTERVIEW",
  "platform": "PHONE | WEB",
  "expert": {
    "name": "string",
    "title": "string",
    "company": "string"
  },
  "questions": ["string"],
  "scheduledAt": "ISO8601 datetime (optional)"
}

Update Interview

PUT /api/interviews/{id}

Delete Interview

DELETE /api/interviews/{id}

Get Transcription

GET /api/interviews/{id}/transcription

Get Audio

GET /api/interviews/{id}/audio

Get Session Stats

GET /api/interviews/{id}/session-stats

AI Agents

List Agent Groups

GET /api/agents/groups

Get Agent Versions

GET /api/agents/group/{groupId}/versions

List Agents

GET /api/agents

Create Agent

POST /api/agents

Get Default Prompt

GET /api/agents/{type}/default-prompt

Upsert Agent (Both Platforms)

PUT /api/agents/{type}

Get Agent by Type/Platform

GET /api/agents/{type}/{platform}

Upsert Agent

PUT /api/agents/{type}/{platform}

Delete Agent

DELETE /api/agents/{type}/{platform}

Activate Agent

POST /api/agents/{id}/activate

Auth

Get Current User

GET /api/auth/me

Get Profile

GET /api/auth/profile

Billing

Get Subscription

GET /api/billing/subscription

Get Usage

GET /api/billing/usage

Get Usage History

GET /api/billing/usage/history

Returns last 12 months of usage data.

Get Demo Status

GET /api/billing/demo-status

Get Account Info

GET /api/billing/account

Public Endpoints (No Auth Required)

These endpoints are used by experts joining interviews:

Get Interview (Public)

GET /api/ungated/interviews/{id}

Update Interview Status (Public)

PUT /api/ungated/interviews/{id}

Voice & Conversation

Dial (Initiate Phone Call)

POST /api/dial

Dial-In (WebSocket)

WS /api/dialin

Conversation (ElevenLabs)

POST /api/conversation/signed-url

Webhooks

Configure webhooks to receive real-time notifications:

Interview Events

  • interview.started - Interview began

  • interview.completed - Interview finished

  • interview.failed - Interview failed

Webhook Payload

{
  "event": "interview.completed",
  "timestamp": "2024-12-01T00:00:00Z",
  "data": {
    "interviewId": "...",
    "status": "COMPLETED"
  }
}

Last updated