API Reference

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 '{
    "interviewType": "FULL_INTERVIEW",
    "title": "Market Research Interview",
    "callSubject": "Enterprise software market trends",
    "expertData": {
      "name": "John Doe",
      "title": "VP Engineering",
      "employmentHistory": [
        {"title": "VP Engineering", "company": "Acme Corp", "period": "2020-Present"}
      ]
    },
    "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

See Endpoints for complete documentation.

Response Format

Successful responses return JSON data directly:

{
  "id": "...",
  "title": "...",
  ...
}

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
500	Server Error - Something went wrong

Error response format:

{
  "error": "The 'expertData.name' field is required"
}

Interactive Documentation

Interactive API documentation (Swagger UI) is available at:

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