Quick Start

Get your first Home Insight AI analysis running in 5 minutes. This guide will walk you through creating an account, getting your API key, and making your first request.

1. Create an Account

Visit https://homeinsightai.com/auth/signup
Enter your email and create a password
Verify your email address
Log in to your dashboard

2. Get Your API Key

Once logged in, navigate to your dashboard to create an API key:

Go to API Keys
Click "Create New Key"
Give your key a descriptive name (e.g., "Development")
Select Test environment for development or Live for production
Copy your API key immediately - it won't be shown again!

Key Environments

Environment	Key Prefix	Use For
Test	`hi_test_...`	Development, testing, CI/CD
Live	`hi_live_...`	Production apps

Important: Use test keys during development. Test keys don't incur charges and use Stripe test mode for billing flows.

3. Make Your First Request

Use your API key to upload and analyze a document:

Shell

# Using a test key for development
curl -X POST https://api.homeinsightai.com/v1/analyses \
  -H "Authorization: Bearer hi_test_YOUR_API_KEY" \
  -F "file=@inspection_report.pdf" \
  -F "property_address=123 Main St, Anytown, USA"

You'll receive a response with an analysis_id:

JSON

{
  "analysis_id": "ana_abc123xyz",
  "status": "processing",
  "created_at": "2025-11-27T12:00:00Z"
}

4. Wait for Processing

The analysis typically takes 30-60 seconds. Check the status:

Shell

curl https://api.homeinsightai.com/v1/analyses/ana_abc123xyz \
  -H "Authorization: Bearer hi_test_YOUR_API_KEY"

Response when ready:

JSON

{
  "analysis_id": "ana_abc123xyz",
  "status": "completed",
  "summary": {
    "total_issues": 12,
    "critical_issues": 2,
    "estimated_repair_cost": {
      "low": 8500,
      "high": 12000
    }
  }
}

5. Ask Questions via Chat

Once processing is complete, you can ask questions about the document:

Shell

curl -X POST https://api.homeinsightai.com/v1/chat \
  -H "Authorization: Bearer hi_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "analysis_id": "ana_abc123xyz",
    "query": "What are the issues with the roof?"
  }'

Response with cited answers:

JSON

{
  "answer": "The inspection report identified several roof issues: 1) Missing shingles on the north slope (estimated 15-20 shingles), 2) Damaged flashing around the chimney, and 3) Granule loss on asphalt shingles indicating aging.",
  "citations": [
    { "file": "inspection_report.pdf", "page": 9 },
    { "file": "inspection_report.pdf", "page": 10 }
  ],
  "estimated_cost": {
    "low": 2500,
    "high": 4500
  }
}

6. Embed the Chat Widget (Optional)

For a better user experience, embed our React widget:

Shell

npm install home-insight-ai-sdk

React

import { HomeInsightChat } from 'home-insight-ai-sdk'

function App() {
  return (
    <HomeInsightChat
      apiKey={process.env.NEXT_PUBLIC_HOMEINSIGHT_API_KEY} // hi_test_... for dev, hi_live_... for prod
      analysisId="ana_abc123xyz"
      position="bottom-right"
      theme="light"
    />
  )
}

What's Next?

Now that you have the basics working, explore more features:

Authentication - Learn about API key management and security
API Reference - Explore all available endpoints
React SDK - Full widget customization options
Error Handling - Handle errors gracefully

Need Help?

Check our Support Resources
Email us at support@homeinsightai.com
Join our developer community on Discord