OpenAI-compatible REST API

Build anything with the GovAI engine.

Full RESTful API access to the same AI engine powering the London Borough of Newham. Integrate service navigation, eligibility checking, and multilingual support into any council system — your CRM, intranet, case management, or custom portal.

Request API Access View Endpoint Reference ↓

Navigate

Send a resident's query. Receive structured, cited service matches across all domains. The core intelligence endpoint.

Check Eligibility

Submit resident circumstances. Receive eligibility assessment for specific services with confidence scores.

Integrate

Push referrals to your CRM. Pull analytics. Subscribe to webhooks for real-time event streaming.

Endpoint Reference

All endpoints accept and return JSON. Authentication via API key in the Authorization header.

POST/v1/navigate

Send a resident query and receive matched services.

Request

{
  "query": "I've lost my job and I can't pay my rent",
  "language": "auto",
  "council_id": "newham",
  "include_eligibility": true,
  "max_results": 5
}

Response

{
  "matches": [
    {
      "service": "Financial Hardship Support",
      "domain": "money",
      "confidence": 0.94,
      "summary": "Emergency payments and council tax reduction for residents experiencing sudden income loss.",
      "eligibility": "likely_eligible",
      "source": "https://ournewham.org/money/financial-hardship",
      "next_steps": ["Apply online", "Call 020 XXXX XXXX"],
      "department": "Revenues & Benefits"
    }
  ],
  "safeguarding": {
    "flags": ["financial_distress", "housing_risk"],
    "escalation_required": false
  },
  "language_detected": "en",
  "session_id": "sess_abc123"
}

GET/v1/services

Search the council service catalogue. GET /v1/services?q=housing&domain=housing&council_id=newham

Response

Array of service objects with name, domain, description, eligibility_criteria, contact details.

POST/v1/check-eligibility

Check resident eligibility for a specific service.

Request

{
  "service_id": "svc_housing_options",
  "circumstances": {
    "employment_status": "unemployed",
    "dependents": 2,
    "housing_status": "at_risk"
  }
}

Response

{
  "eligible": true,
  "confidence": 0.87,
  "criteria_met": [...],
  "criteria_unmet": [...],
  "recommendation": "..."
}

POST/v1/referral

Submit a structured referral to the council's CRM.

Request

{
  "session_id": "sess_abc123",
  "service_id": "svc_housing_options",
  "resident_consent": true,
  "notes": "..."
}

Response

{
  "referral_id": "ref_xyz789",
  "status": "submitted",
  "department": "Housing Options",
  "estimated_response": "2 working days"
}

GET/v1/analytics

Retrieve usage and performance data. GET /v1/analytics?period=30d&council_id=newham

Response

{"total_queries": 12450, "unique_sessions": 8320, "deflection_rate": 0.34, "top_domains": [...], "languages": [...], "safeguarding_flags": 47}

Enterprise-grade security. Council-grade compliance.

API Key Authentication

Per-environment keys (dev/staging/prod). Rotate without downtime. Rate limiting configurable per key.

Data in Transit

TLS 1.3 encryption on all endpoints. Certificate pinning available.

Data at Rest

AES-256 encryption. All data stored on UK infrastructure. PII redacted in logs by default.

SDKs — Coming Q3 2026

Coming Soon

🐍

Python SDK

pip install govai

Coming Soon

📦

JavaScript/TypeScript SDK

npm install @govai/sdk

Coming Soon

🔷

.NET SDK

dotnet add package GovAI.Client

Rate Limits & Pricing

Tier	Requests/minute	Requests/month	Included in
Standard	60	100,000	District & Borough plan
Professional	120	500,000	London Borough plan
Enterprise	Custom	Unlimited	Custom agreement

Ready to integrate?

Request API Access View Pricing