Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vh3.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Quickstart

This guide walks you through making your first API call to the VH3 AI intelligence layer.

​
Prerequisites

You need:
  • Your company ID (provided during onboarding)
  • Your API key (provided during onboarding)

​
1. Search your job history

The semantic search endpoint lets you find relevant past jobs by describing what you’re looking for in natural language. The platform uses hybrid search — combining semantic (meaning-based) and BM25 (keyword) retrieval. 
curl -X POST "https://api.vh3connect.io/api:kP8T1CK7/search/outcomes" \
  -H "Content-Type: application/json" \
  -d '{
    "company_id": "your-company-id",
    "api_key": "your-api-key",
    "query_text": "boiler intermittent fault",
    "limit": 5
  }'
This finds relevant past jobs even if they were recorded as “heating system cutting out” or “CH unit tripping intermittently.”

​
2. Get sentinel alerts

Check what operational risks or growth opportunities the platform has detected: 
curl -X POST "https://api.vh3connect.io/api:kP8T1CK7/sentinels/run" \
  -H "Content-Type: application/json" \
  -d '{
    "company_id": "your-company-id",
    "api_key": "your-api-key",
    "sentinel": "engineer_performance_slip"
  }'

​
3. Ask Connie a question

Use the conversational AI endpoint to ask operational questions in natural language: 
curl -X POST "https://api.vh3connect.io/api:kP8T1CK7/connie/chat" \
  -H "Content-Type: application/json" \
  -d '{
    "company_id": "your-company-id",
    "api_key": "your-api-key",
    "message": "Which engineers had the most repeat visits last month?",
    "session_id": "quickstart-session-1"
  }'
Connie responds with a data-backed answer, citing the underlying records.

​
4. List your jobs from the FMS

The VH3 API gives you direct access to your FMS data (BigChange, Joblogic, etc.): 
curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/list" \
  -H "X-Api-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "pageNumber": 1,
    "pageSize": 20,
    "sortBy": "createdAt",
    "direction": "descending"
  }'
The FSI intelligence endpoints use company_id + api_key in the request body. The VH3 FMS endpoints use X-Api-Key in the header. See Authentication for full details.

​
What’s next?

Search API

Full reference for semantic and keyword search endpoints.

Sentinels

Configure and query all 19 sentinel monitors.

Connie

Conversational AI with full operational context.

Reports

Generate and retrieve automated operational reports.