For the complete documentation index, see llms.txt. This page is also available as Markdown.

Meta

System metadata and information

get

Returns the backend's meta information.

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Responses
200

Happy response.

application/json

Contains backend run-time info: statistics along with build information.

versionstringRequired

Is set to the HQ build version.

build_idstringRequired

Is set to the HQ build id.

backend_build_idstringRequired

Is set to the HQ backend build id.

ui_build_idstringRequired

Is set to the HQ UI build id.

goosstringRequired

Equals runtime.GOOS.

goarchstringRequired

Equals runtime.GOARCH.

started_atstring · date-timeRequired

Is set to the instant the backend started.

memstats_allocinteger · int64Required

Equals runtime.Memstats.Alloc.

memstats_sysinteger · int64Required

Equals runtime.Memstats.Sys.

gc_cpu_fractionnumberRequired

Equals runtime.Memstats.GCCPUFraction.

num_goroutineinteger · int32Required

Equals runtime.NumGoroutine().

get/api/v1/meta-info
GET /api/v1/meta-info HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "version": "text",
  "build_id": "text",
  "backend_build_id": "text",
  "ui_build_id": "text",
  "goos": "text",
  "goarch": "text",
  "started_at": "2026-01-01T00:00:00.000Z",
  "memstats_alloc": 1,
  "memstats_sys": 1,
  "gc_cpu_fraction": 1,
  "num_goroutine": 1
}

Last updated

Was this helpful?