Documentation

Getting Started

Get your first AI interview running in under 3 minutes.

1. Create an account — Sign up at /register. No credit card required.
2. Create a survey — From the dashboard, click "New Survey" and give it a name and description.
3. Add interview goals — Define what you want to learn. Each goal has a description and acceptance criteria.
4. Share the link — Copy the interview URL and send it to participants, or embed the widget on your site.
5. Review insights — As interviews complete, AI automatically analyzes responses and extracts themes.

Creating Surveys

Surveys are the containers for your interviews. Each survey has:

• Name — Visible to your team in the dashboard
• Description — Context for the AI about what this research is about
• Interview Goals — Ordered list of topics to cover (see next section)
• Personality settings — Customize the AI's tone and approach
• Budget controls — Set maximum interviews per month

On the Free plan, you can have 1 active survey. Pro and Enterprise plans support unlimited surveys.

Interview Goals

Goals are the heart of AI Interviewer. Instead of writing a script, you tell the AI what you want to learn, and it figures out the best way to ask.

Each goal has:

• Description — What you want to learn (e.g., "Understand the customer's primary pain points")
• Acceptance criteria — When has this goal been satisfied? (e.g., "Customer has described at least 2 specific pain points with examples")
• Order — Goals are covered sequentially. The AI moves to the next goal once the current one is satisfied.

The AI uses a tool-based architecture: it calls mark_goal_complete when a goal's acceptance criteria are met, then advances to the next goal. When all goals are done, it calls end_interview.

Widget Setup

Embed the AI interviewer directly on your website. Works with any site — Shopify, BigCommerce, WordPress, or custom HTML.

Embed code:

<script
  src="https://interviewer.abreu.live/static/js/widget.js"
  data-survey-id="YOUR_SURVEY_ID"
  async>
</script>

Find your Survey ID in the dashboard under Survey Settings. The widget renders as a chat bubble in the bottom-right corner of your page.

Customization options:

<script
  src="https://interviewer.abreu.live/static/js/widget.js"
  data-survey-id="YOUR_SURVEY_ID"
  data-position="bottom-right"
  data-primary-color="#4F46E5"
  data-greeting="Hi! Got a minute for a quick chat?"
  async>
</script>

API Reference

Available on Pro and Enterprise plans. Authenticate with an API key from your dashboard.

Authentication:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://interviewer.abreu.live/api/v1/surveys

Endpoints

Example: Create a Survey

curl -X POST https://interviewer.abreu.live/api/v1/surveys \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer Churn Research",
    "description": "Understand why customers cancel",
    "goals": [
      {
        "description": "Primary reason for cancellation",
        "acceptance_criteria": "Customer states specific reason"
      },
      {
        "description": "What would have changed their mind",
        "acceptance_criteria": "Customer describes at least one retention factor"
      }
    ]
  }'

Billing

Manage your subscription from the dashboard under Settings → Billing.

• Free plan — 50 interviews/month, 1 survey, 1 user. No credit card required.
• Pro plan ($49/mo) — 500 interviews/month, unlimited surveys, 5 users, API access.
• Enterprise ($199/mo) — Unlimited interviews, custom branding, webhooks, SSO, dedicated support.
• Upgrade or downgrade anytime. Changes apply on next billing cycle.
• Interview usage resets monthly on your billing date.
• When you hit your limit, new interviews are paused. Existing data stays accessible.