Contents

Status

Health, readiness and version.

The Version object

Attributes

  • model required Type: string

    The current nib release (nib-2.6).

  • api_version required Type: string

    The latest API version.

  • region required Type: string

    The region this host serves (uk-london, …).

Version on its own page

The Version object
{
  "model": "nib-2.6",
  "api_version": "2026-09-27",
  "region": "uk-london"
}

Liveness

GET /health

No API key needed

Returns

  • 200
    The process is serving requests
GET /health · curl
curl "https://api.unforged.sh/health" \
  -H "Unforged-Version: 2026-10-14"
GET /health · Python
import requests

r = requests.get(
    "https://api.unforged.sh/health",
    headers={"Unforged-Version": "2026-10-14"},
)
print(r.json())
GET /health · Node.js
const res = await fetch('https://api.unforged.sh/health', {
  method: 'GET',
  headers: { 'Unforged-Version': '2026-10-14' },
});
console.log(await res.json());
Response 200
{
  "status": "ok"
}

Readiness

GET /ready

No API key needed

Returns

  • 200 Type: Ready
    Ready
  • 503 Type: Problem
    Not ready (not_ready)
GET /ready · curl
curl "https://api.unforged.sh/ready" \
  -H "Unforged-Version: 2026-10-14"
GET /ready · Python
import requests

r = requests.get(
    "https://api.unforged.sh/ready",
    headers={"Unforged-Version": "2026-10-14"},
)
print(r.json())
GET /ready · Node.js
const res = await fetch('https://api.unforged.sh/ready', {
  method: 'GET',
  headers: { 'Unforged-Version': '2026-10-14' },
});
console.log(await res.json());
Response 200
{
  "status": "ready"
}

Current versions

GET /version

No API key needed

Returns

GET /version · curl
curl "https://api.unforged.sh/version" \
  -H "Unforged-Version: 2026-10-14"
GET /version · Python
import requests

r = requests.get(
    "https://api.unforged.sh/version",
    headers={"Unforged-Version": "2026-10-14"},
)
print(r.json())
GET /version · Node.js
const res = await fetch('https://api.unforged.sh/version', {
  method: 'GET',
  headers: { 'Unforged-Version': '2026-10-14' },
});
console.log(await res.json());
Response 200
{
  "model": "nib-2.6",
  "api_version": "2026-09-27",
  "region": "uk-london"
}