Overview

Integrate InsightAgent into your applications with our REST API.

Base URL

https://api.insightagent.io

Authentication

All API requests require authentication. See Authentication for details.

Quick Start

# List your interviews
curl -X GET "https://api.insightagent.io/api/interviews" \
  -H "Authorization: Bearer <your-token>"

# Create an interview
curl -X POST "https://api.insightagent.io/api/interviews" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "FULL_INTERVIEW",
    "platform": "WEB",
    "expert": {"name": "John Doe", "title": "VP Engineering"},
    "questions": ["What are the key challenges in your role?"]
  }'

Available Endpoints

Resource	Description
/api/interviews	Create and manage interviews
/api/agents	Configure AI agents
/api/auth	Authentication and profiles
/api/billing	Usage and subscription
/api/ungated	Public endpoints (no auth)

See Endpoints for complete documentation.

Response Format

All responses are JSON:

{
  "data": { ... },
  "meta": {
    "timestamp": "2024-12-01T00:00:00Z"
  }
}

Error Handling

Errors return appropriate HTTP status codes:

Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing auth
403	Forbidden - Insufficient permissions
404	Not Found - Resource doesn't exist
429	Too Many Requests - Rate limited
500	Server Error - Something went wrong

Error response format:

{
  "error": {
    "code": "INVALID_PARAMETER",
    "message": "The 'expert.name' field is required"
  }
}

Rate Limits

Plan	Requests/minute
Trial	60
Paid	300
Enterprise	Custom

OpenAPI Specification

Access our OpenAPI spec for code generation:

https://api.insightagent.io/api-docs-json