NylorunDocsBeta
Runtime APIService

Check the Runtime

GET
/health

The protocol range and features a client checks first. Refuses an Origin.

Response Body

The Runtime is up

application/json
  1. response
status*"ok"
Value in"ok"
service*string
version*string
protocol*
coreVersion*string
hostId*string
pid*integer
import { createClient } from "@nylorun/agents";const client = await createClient();const features = await client.hostFeatures();
{  "status": "ok",  "service": "string",  "version": "string",  "protocol": {    "min": 0,    "max": 0,    "features": [      "string"    ]  },  "coreVersion": "string",  "hostId": "string",  "pid": 0}

Errors

The errors the Agents SDK throws and when.

Check the Runtime is ready GET

The listener, the Tenant (open), Postgres, Restate and S2, and the open Tenant's harnesses.