Sign in

v50

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-07-112650216.3 KB
Health

Read structured API status

Returns structured dependency status and an agent instruction.

get/v1/status

Response

Structured API status.

okboolean required
servicestring required
namestring required
api_versionstring required
agent_instructionstring required
docs_urlstring uri required

Example response

{
  "ok": true,
  "service": "tovuk-api",
  "name": "example",
  "api_version": "example",
  "checks": [],
  "agent_instruction": "example",
  "docs_url": "https://example.com"
}