VH3 AI Intelligence API

The VH3 AI Intelligence API provides enriched operational data, semantic search, proactive sentinels, reports, Connie, email triage, Cases, and Teams. Tenant-scoped server-to-server endpoints require company_id and api_key. For direct BigChange read/write (jobs, contacts, invoices, stock), use the separate BigChange API, same API key, X-API-Key header only.

Base URL

https://api.vh3connect.io/api:kP8T1CK7

Authentication

Pass company_id and api_key on every request. POST: JSON body. GET: query parameters.

Do not send only an X-API-Key header to the VH3 AI Intelligence API. Keep the tenant api_key in server-side code.Server-side customer integrations must use the base URL above. Browser and mobile applications must use JWT-authenticated VH3 Connect surfaces.

See Authentication for the full two-API comparison and User Auth (JWT).

Endpoint groups

Group	Description
Search	Semantic search, autocomplete, enriched outcomes, customer summary sections
Jobs	Job feed, job details, and aggregation
Contacts	Contact feed and contact detail lookup
Dashboard	Cached tenant KPI snapshot (pipeline, performance, workforce, assets, knowledge)
Sentinels	Run and query proactive sentinel monitors
Reports	Generate daily, weekly, and account-level reports
Briefings	Pre-visit engineer briefings and call scripts
Weather	Forecast, historical, and graph-resolved weather
Email Triage	Classify inbound emails
Email Ingest	Extract structured data from FM portal emails
Connie	Conversational AI with cited answers
Cases	Case management
Teams	Team management and access scoping
Quotient	List and fetch Quotient quotations (requires Quotient native integration)

Request format

POST endpoints

{
  "company_id": "your-company-id",
  "api_key": "your-api-key",
  "query_text": "boiler fault",
  "limit": 10
}

GET endpoints

curl -G "https://api.vh3connect.io/api:kP8T1CK7/jobs/feed" \
  --data-urlencode "company_id=your-company-id" \
  --data-urlencode "api_key=your-api-key"

Error format

{
  "code": "ERROR_CODE_INPUT_ERROR",
  "message": "Missing param: company_id",
  "payload": {
    "param": "company_id"
  }
}

Status code	Meaning
`400`	Bad request, missing or invalid parameters
`401`	Unauthorised, invalid API key
`404`	Not found, resource does not exist for your tenant
`409`	Conflict, a task is already running for this resource
`422`	Validation error
`429`	Rate limited
`500`	Server error

Task-based endpoints

Long-running operations return a task_id immediately. Poll the status endpoint until complete. Possible statuses: pending, running, completed, failed, cancelled.

​VH3 AI Intelligence API

​Base URL

​Authentication

​Endpoint groups

​Request format

​POST endpoints

​GET endpoints

​Error format

​Task-based endpoints

VH3 AI Intelligence API

Base URL

Authentication

Endpoint groups

Request format

POST endpoints

GET endpoints

Error format

Task-based endpoints