Scout AI REST API

/api/scout-ai

Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Allow-Headers: Content-Type

GET /api/scout-ai/health

{
  "status": "ok",
  "service": "Scout AI",
  "anthropicConfigured": true
}

POST /api/scout-ai

{
  "systemPrompt": "You are a UX research assistant. Be concise.",
  "userPrompt": "What are the most common methods for unmoderated usability testing?",
  "maxTokens": 1024,
  "temperature": 0.5
}

{
  "success": true,
  "response": "The most common methods include..."
}

POST /api/scout-ai/stream

{
  "role": "user",
  "content": "What themes emerged from our pilot sessions?"
}

{
  "systemPrompt": "You are Scout AI, a UX research assistant.",
  "userPrompt": "Summarize the key pain points from these notes.",
  "messages": [
    { "role": "user", "content": "I have 3 session notes to analyze." },
    { "role": "assistant", "content": "Go ahead and share them." }
  ],
  "includeCitations": true
}

Based on the session notes, the key pain points are...

POST /api/scout-ai/rewrite

{
  "text": "Users was confused by the navigation and couldn't find things easily.",
  "focus": "Rewrite as a formal research finding suitable for a stakeholder report."
}

{
  "success": true,
  "result": "Participants experienced difficulty navigating the interface and struggled to locate key features."
}

POST /api/scout-ai/report

{
  "projectName": "Mobile Checkout Study",
  "reportType": "executive",
  "synthesisNotes": [
    { "content": "P1 struggled to locate the promo code field..." },
    { "content": "P2 abandoned cart at payment step due to unclear error message..." }
  ],
  "hypotheses": [
    { "statement": "Users expect a guest checkout option", "status": "untested" }
  ]
}

{
  "success": true,
  "response": "# Executive Summary\n\n..."
}

POST /api/scout-ai/session-summary

{
  "title": "Session P1 – Sarah",
  "content": "Participant had difficulty locating the filter controls..."
}

{
  "projectName": "Onboarding Flow Study",
  "summaryType": "findings-report",
  "sessionNotes": [
    {
      "title": "Session P1 – Sarah",
      "content": "Sarah completed task 1 successfully but struggled with task 2..."
    },
    {
      "title": "Session P2 – Marcus",
      "content": "Marcus skipped the tutorial entirely and went directly to settings..."
    }
  ]
}

{
  "success": true,
  "response": "# Findings Report: Onboarding Flow Study\n\n**Date:** ..."
}

POST /api/scout-ai/personas

{
  "projectName": "B2B Dashboard Study",
  "count": 2,
  "researchData": [
    {
      "title": "Session P1",
      "content": "Participant is a data analyst who exports reports daily..."
    }
  ]
}

{
  "success": true,
  "response": "## Persona 1: The Analyst\n\n**Name:** Jordan Lee..."
}

POST /api/scout-ai/journey-map

{
  "projectName": "Insurance Claims Portal",
  "researchData": [
    {
      "title": "Session P3",
      "content": "User first heard about the portal from an email notification..."
    }
  ]
}

{
  "success": true,
  "response": "## Customer Journey Map: Insurance Claims Portal\n\n### Phase 1: Awareness..."
}

POST /api/scout-ai/themes

{
  "projectName": "Remote Work Tools Study",
  "researchData": [
    { "title": "Session P1", "content": "Participant mentioned feeling overwhelmed by notifications..." },
    { "title": "Session P2", "content": "Found async communication essential but hard to track..." }
  ]
}

{
  "success": true,
  "response": "## Themes: Remote Work Tools Study\n\n### Theme 1: Notification Fatigue..."
}

POST /api/scout-ai/interview-guide

{
  "projectName": "Expense Reporting Tool",
  "duration": 45,
  "objectives": [
    "Understand how users currently submit expense reports",
    "Identify pain points in the approval workflow"
  ]
}

{
  "success": true,
  "response": "# Interview Guide: Expense Reporting Tool (45 min)\n\n## Introduction (5 min)..."
}

POST /api/scout-ai/hypotheses

{
  "statement": "Users prefer to complete checkout as a guest rather than creating an account.",
  "status": "untested"
}

{
  "projectName": "E-commerce Checkout Study",
  "hypotheses": [
    {
      "statement": "Users prefer guest checkout over account creation.",
      "status": "untested"
    }
  ],
  "researchData": [
    {
      "title": "Session P1",
      "content": "Participant immediately looked for a 'Continue as Guest' option..."
    }
  ]
}

{
  "success": true,
  "response": "### Hypothesis 1: \"Users prefer guest checkout over account creation.\"\n\n**Recommended Status:** validated..."
}

[Session P1]
[P2]
[Session Notes - P3]
[Participant 4]

{
  "success": false,
  "error": "Description of the error"
}

{
  "success": false,
  "error": "Anthropic API key is not configured or invalid"
}

{
  "success": false,
  "error": "Request too large (120k chars). Try with fewer or shorter session notes. Maximum is ~100k chars."
}

{
  "success": false,
  "error": "Rate limit exceeded. Please try again in a moment."
}